| Method | HTTP request | Description |
|---|---|---|
| get_balance | GET /portfolio/balance | Get Balance |
| get_fills | GET /portfolio/fills | Get Fills |
| get_portfolio_resting_order_total_value | GET /portfolio/summary/total_resting_order_value | Get Total Resting Order Value |
| get_positions | GET /portfolio/positions | Get Positions |
| get_settlements | GET /portfolio/settlements | Get Settlements |
get_balance
GetBalanceResponse get_balance()Get Balance Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
Parameters
This endpoint does not need any parameter.Return type
GetBalanceResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Balance retrieved successfully |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |
get_fills
GetFillsResponse get_fills(ticker=ticker, order_id=order_id, min_ts=min_ts, max_ts=max_ts, limit=limit, cursor=cursor)Get Fills Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ticker | str | Filter by market ticker | [optional] |
| order_id | str | Filter by order ID | [optional] |
| min_ts | int | Filter items after this Unix timestamp | [optional] |
| max_ts | int | Filter items before this Unix timestamp | [optional] |
| limit | int | Number of results per page. Defaults to 100. Maximum value is 200. | [optional] [default to 100] |
| cursor | str | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | [optional] |
Return type
GetFillsResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Fills retrieved successfully |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Internal server error |
get_portfolio_resting_order_total_value
GetPortfolioRestingOrderTotalValueResponse get_portfolio_resting_order_total_value()Get Total Resting Order Value Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you’re uncertain about this endpoint, it likely does not apply to you.
Parameters
This endpoint does not need any parameter.Return type
GetPortfolioRestingOrderTotalValueResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Total resting order value retrieved successfully |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |
get_positions
GetPositionsResponse get_positions(cursor=cursor, limit=limit, count_filter=count_filter, settlement_status=settlement_status, ticker=ticker, event_ticker=event_ticker)Get Positions Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cursor | str | The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page. | [optional] |
| limit | int | Parameter to specify the number of results per page. Defaults to 100. | [optional] [default to 100] |
| count_filter | str | Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded | [optional] |
| settlement_status | str | Settlement status of the markets to return. Defaults to unsettled. | [optional] [default to unsettled] |
| ticker | str | Filter by market ticker | [optional] |
| event_ticker | str | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | [optional] |
Return type
GetPositionsResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Positions retrieved successfully |
| 400 | Bad request - invalid input |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |
get_settlements
GetSettlementsResponse get_settlements(limit=limit, cursor=cursor, ticker=ticker, event_ticker=event_ticker, min_ts=min_ts, max_ts=max_ts)Get Settlements Endpoint for getting the member’s settlements historical track.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int | Number of results per page. Defaults to 100. Maximum value is 200. | [optional] [default to 100] |
| cursor | str | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | [optional] |
| ticker | str | Filter by market ticker | [optional] |
| event_ticker | str | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | [optional] |
| min_ts | int | Filter items after this Unix timestamp | [optional] |
| max_ts | int | Filter items before this Unix timestamp | [optional] |
Return type
GetSettlementsResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Settlements retrieved successfully |
| 400 | Bad request - invalid input |
| 401 | Unauthorized - authentication required |
| 500 | Internal server error |