Skip to main content
GET
/
v1
/
client
/
aggregate
/
holding
Get aggregate holding
curl --request GET \
  --url https://api.orderly.org/v1/client/aggregate/holding \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "timestamp": 1702989203989,
  "data": [
    {
      "account_id": "0x1111",
      "updated_time": 1580794149000,
      "token": "BTC",
      "holding": -28.000752,
      "frozen": 0,
      "pending_short": -2000,
      "isolated_margin": 0,
      "isolated_order_frozen": 0
    },
    {
      "account_id": "0x2222",
      "updated_time": 1580794149000,
      "token": "ETH",
      "holding": -10.123456,
      "frozen": 0,
      "pending_short": -500,
      "isolated_margin": 0,
      "isolated_order_frozen": 0
    }
  ]
}

Headers

​
orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

​
orderly-account-id
string
required

Account ID of the authenticated account.

​
orderly-key
string
required

Public orderly key used to sign the request.

​
orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989

​
data
object
Example:
[
  {
    "account_id": "0x1111",
    "updated_time": 1580794149000,
    "token": "BTC",
    "holding": -28.000752,
    "frozen": 0,
    "pending_short": -2000,
    "isolated_margin": 0,
    "isolated_order_frozen": 0
  },
  {
    "account_id": "0x2222",
    "updated_time": 1580794149000,
    "token": "ETH",
    "holding": -10.123456,
    "frozen": 0,
    "pending_short": -500,
    "isolated_margin": 0,
    "isolated_order_frozen": 0
  }
]