Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orderly.network/docs/llms.txt

Use this file to discover all available pages before exploring further.

Account discovery — given an address, list every (broker_id, account_id) pair the address controls (both REGULAR and SUB). Useful as the first call before drilling into per-account state. Weight: 5

​
Request

{
  "type": "accounts",
  "address": "0x1234567890abcdef1234567890abcdef12345678"
}
FieldTypeRequiredDefaultNotes
addressstringYes—Wallet address; must resolve to at least one account
broker_idstringNo—Optional broker scope

​
Response

FieldTypeNotes
addressstringEcho of input
accounts[]arrayOne entry per account
.broker_idstringBroker identifier
.account_idstringAccount identifier within broker
.account_typestring"main" (main account), "sub" (sub-account), or "sp" (vault strategy provider)
.account_valuestring | nullMark-to-market account value: (holding + iso_margin_total + frozen) + Σ unrealized_pnl across positions. null if position-calc is unavailable for that row

​
Notes

  • No pagination
  • Throws ADDRESS_NOT_FOUND (404) when zero accounts resolve
  • Per-row position-calc failures degrade account_value to null rather than failing the whole listing
{
  "success": true,
  "data": {
    "address": "0x1234...",
    "accounts": [
      {
        "broker_id": "orderly",
        "account_id": "0xabc...",
        "account_type": "main",
        "account_value": "5000.25"
      }
    ]
  },
  "ts": 1779269143700
}