Method | HTTP request | Description |
---|---|---|
amendOrder | POST /portfolio/orders//amend | Amend Order |
batchCancelOrders | DELETE /portfolio/orders/batched | Batch Cancel Orders |
batchCreateOrders | POST /portfolio/orders/batched | Batch Create Orders |
cancelOrder | DELETE /portfolio/orders/ | Cancel Order |
createOrder | POST /portfolio/orders | Create Order |
createOrderGroup | POST /portfolio/order_groups/create | Create Order Group |
decreaseOrder | POST /portfolio/orders//decrease | Decrease Order |
deleteOrderGroup | DELETE /portfolio/order_groups/ | Delete Order Group |
getBalance | GET /portfolio/balance | Get Balance |
getFills | GET /portfolio/fills | Get Fills |
getOrder | GET /portfolio/orders/ | Get Order |
getOrderGroups | GET /portfolio/order_groups | Get Order Groups |
getOrderQueuePosition | GET /portfolio/orders//queue_position | Get Order Queue Position |
getOrders | GET /portfolio/orders | Get Orders |
getPositions | GET /portfolio/positions | Get Positions |
getQueuePositions | POST /portfolio/orders/queue_positions | Get Queue Positions |
getSettlements | GET /portfolio/settlements | Get Settlements |
getTotalRestingOrderValue | GET /portfolio/summary/total_resting_order_value | Get Total Resting Order Value |
resetOrderGroup | POST /portfolio/order_groups//reset | Reset Order Group |
amendOrder
AmendOrderResponse amendOrder(amendOrderRequest)Amend an existing order
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
amendOrderRequest | AmendOrderRequest | ||
orderId | [string] | Order ID | defaults to undefined |
Return type
AmendOrderResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Order amended successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
batchCancelOrders
BatchCancelOrdersResponse batchCancelOrders(batchCancelOrdersRequest)Cancel multiple orders in a single request
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
batchCancelOrdersRequest | BatchCancelOrdersRequest |
Return type
BatchCancelOrdersResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Batch order cancellation completed | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
batchCreateOrders
BatchCreateOrdersResponse batchCreateOrders(batchCreateOrdersRequest)Create multiple orders in a single request
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
batchCreateOrdersRequest | BatchCreateOrdersRequest |
Return type
BatchCreateOrdersResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Batch order creation completed | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
cancelOrder
CancelOrderResponse cancelOrder()Cancel an order
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
orderId | [string] | Order ID | defaults to undefined |
Return type
CancelOrderResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Order cancelled successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
createOrder
CreateOrderResponse createOrder(createOrderRequest)Create a new order
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
createOrderRequest | CreateOrderRequest |
Return type
CreateOrderResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Order created successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
429 | Too Many Requests - rate limit exceeded | - |
500 | Internal server error | - |
createOrderGroup
CreateOrderGroupResponse createOrderGroup(createOrderGroupRequest)Create a new order group
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
createOrderGroupRequest | CreateOrderGroupRequest |
Return type
CreateOrderGroupResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Order group created successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
decreaseOrder
DecreaseOrderResponse decreaseOrder(decreaseOrderRequest)Decrease the size of an existing order
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
decreaseOrderRequest | DecreaseOrderRequest | ||
orderId | [string] | Order ID | defaults to undefined |
Return type
DecreaseOrderResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Order decreased successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
deleteOrderGroup
deleteOrderGroup()Delete an order group
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
orderGroupId | [string] | Order group ID | defaults to undefined |
Return type
void (empty response body)Authorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | Order group deleted successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getBalance
GetBalanceResponse getBalance()Get the user’s current balance
Example
Parameters
This endpoint does not have any parameters.Return type
GetBalanceResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Balance retrieved successfully | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getFills
GetFillsResponse getFills()Get fills for the logged-in user. A fill represents a partial or complete execution of an order. When an order matches with another order in the orderbook, a fill is created for each side of the trade.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ticker | [string] | Filter by market ticker | (optional) defaults to undefined |
orderId | [string] | Filter by order ID | (optional) defaults to undefined |
minTs | [number] | Filter items after this Unix timestamp | (optional) defaults to undefined |
maxTs | [number] | Filter items before this Unix timestamp | (optional) defaults to undefined |
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100 |
cursor | [string] | 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) defaults to undefined |
Return type
GetFillsResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Fills retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getOrder
GetOrderResponse getOrder()Get a single order by ID
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
orderId | [string] | Order ID | defaults to undefined |
Return type
GetOrderResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Order retrieved successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getOrderGroups
GetOrderGroupsResponse getOrderGroups()Get order groups for the logged-in user
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
status | [string] | Filter by status. Possible values depend on the endpoint. | (optional) defaults to undefined |
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100 |
cursor | [string] | 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) defaults to undefined |
Return type
GetOrderGroupsResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Order groups retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getOrderQueuePosition
GetOrderQueuePositionResponse getOrderQueuePosition()Get the queue position for an order
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
orderId | [string] | Order ID | defaults to undefined |
Return type
GetOrderQueuePositionResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Queue position retrieved successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getOrders
GetOrdersResponse getOrders()Get orders for the logged-in user
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ticker | [string] | Filter by market ticker | (optional) defaults to undefined |
eventTicker | [string] | Filter by event ticker | (optional) defaults to undefined |
minTs | [number] | Filter items after this Unix timestamp | (optional) defaults to undefined |
maxTs | [number] | Filter items before this Unix timestamp | (optional) defaults to undefined |
status | [string] | Filter by status. Possible values depend on the endpoint. | (optional) defaults to undefined |
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100 |
cursor | [string] | 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) defaults to undefined |
Return type
GetOrdersResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Orders retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getPositions
GetPositionsResponse getPositions()Get positions for the logged-in user
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ticker | [string] | Filter by market ticker | (optional) defaults to undefined |
eventTicker | [string] | Filter by event ticker | (optional) defaults to undefined |
countDown | [number] | Filter positions by minimum count down value | (optional) defaults to undefined |
countUp | [number] | Filter positions by minimum count up value | (optional) defaults to undefined |
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100 |
cursor | [string] | 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) defaults to undefined |
Return type
GetPositionsResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Positions retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getQueuePositions
GetQueuePositionsResponse getQueuePositions(getQueuePositionsRequest)Get queue positions for multiple orders
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
getQueuePositionsRequest | GetQueuePositionsRequest |
Return type
GetQueuePositionsResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Queue positions retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getSettlements
GetSettlementsResponse getSettlements()Get settlements for the logged-in user
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100 |
cursor | [string] | 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) defaults to undefined |
Return type
GetSettlementsResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Settlements retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getTotalRestingOrderValue
GetTotalRestingOrderValueResponse getTotalRestingOrderValue()Get the total value of all resting orders
Example
Parameters
This endpoint does not have any parameters.Return type
GetTotalRestingOrderValueResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Total resting order value retrieved successfully | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
resetOrderGroup
resetOrderGroup()Reset an order group
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
orderGroupId | [string] | Order group ID | defaults to undefined |
Return type
void (empty response body)Authorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | Order group reset successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |