Skip to main content
GET
/
v1
/
admin
/
client
/
holding
Get current holding
curl --request GET \
  --url https://api.orderly.org/v1/admin/client/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,
  "data": {
    "holding": [
      {
        "updated_time": 1580794149000,
        "token": "USDT",
        "holding": 282485.071904,
        "frozen": 0,
        "pending_short": -2000,
        "isolated_margin": 0,
        "isolated_order_frozen": 0
      }
    ]
  },
  "timestamp": 1702989203989
}

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.

Query Parameters

​
all
boolean

true/false. If true then will return all token even if balance is empty.

​
user_account
string

Target user account to query for admin usage, required for either user_account or user_address

​
user_address
string

Target user address to query for admin usage, required for either user_account or user_address

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
data
object
required
​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989