Skip to main content
GET
/
v1
/
account_info
Get account overview info
curl --request GET \
  --url https://api.orderly.org/v1/account_info \
  --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": {
    "current_margin_ratio_with_orders": 1.2385,
    "free_collateral": 450315.09115,
    "initial_margin_ratio": 0.1,
    "initial_margin_ratio_with_orders": 0.1,
    "maintenance_margin_ratio": 0.05,
    "maintenance_margin_ratio_with_orders": 0.05,
    "margin_ratio": 1.2385,
    "open_margin_ratio": 1.2102,
    "total_collateral_value": 489865.71329,
    "account_value": 500000,
    "total_pnl_24h": 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.

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