Positions

GET /v1/api/positions

This endpoint returns an array of option, future, and perpetual positions.

Headers

Header Field	Type	Comments
credentials_secret	JWT	Created by user for validation

Positions Response Message

Name	Type	Comments
server_utc_timestamp	integer	Time at which the message was generated by the API
positions	Position[]	cf below

Position Object

Name	Type	Comments
symbol	string	Instrument name e.g BTC-USD
deliverable_id	integer
product_type	string	option / perpetual_future / future
timestamp	integer	μs utc timestamp when the position was last updated
side	string	long / short
size	float	Position Size
average_entry_price	float	Average fill price
mark_price	float	Current Mark Price
upnl	float	Unrealised PNL

Example

{
  "positions_response": {
    "server_utc_timestamp": "1670249080918323",
    "positions": [
      {
        "symbol": "BTC-20230630-22000C",
        "deliverable_id": "1825",
        "product_type": "option",
        "timestamp": "1670249079043755000",
        "side": "long",
        "size": "0.1",
        "mark_price": "1694.0116749011",
        "average_entry_price": "7975",
        "upnl": "-628.09883250989"
      },
      {
        "symbol": "BTC-20230630-28000C",
        "deliverable_id": "2270",
        "product_type": "option",
        "timestamp": "1670249079043755000",
        "side": "short",
        "size": "-0.001",
        "mark_price": "814.408368993",
        "average_entry_price": "5275",
        "upnl": "4.460591631007"
      }
    ]
  }
}