Get Positions

Retrieve current position information for all trading instruments or a specific symbol.

GET /v1/positions

Get Positions

cURL

curl --request GET \
  --url https://api.roxom.com/v1/positions \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Signature: <api-key>'

200

{
  "data": {
    "positions": [
      {
        "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "adlRank": 1,
        "avgEntry": "<string>",
        "createdAt": 123,
        "entryAmount": "<string>",
        "entryFees": "<string>",
        "exitAmount": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "initialMargin": "<string>",
        "instrumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "leverage": "<string>",
        "liquidationPrice": "<string>",
        "maintenanceMarginRatio": "<string>",
        "margin": "<string>",
        "openDate": 123,
        "size": "<string>",
        "updatedAt": 123,
        "avgExit": "<string>",
        "closeDate": 123,
        "exitFees": "<string>",
        "stopLossOrderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "takeProfitOrderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  },
  "error": true
}

Authorizations

X-API-Key · string · header · required

Your API key

X-API-Signature · string · header · required

The signature of the request

Query Parameters

instType · enum<string> · required

Available options: perpetual, spot, btc, digital, stock, index

symbol · string · required

unit · enum<string>

Available options: sats, btc

Response

200 - application/json

Represents a successful API response wrapper

data · object · required

Show child attributes

error · boolean · required