Skip to main content

Documentation Index

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

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

Composite single-symbol view. Combines the matching position (if any), open orders for that symbol, a market snapshot, and an account-risk summary. All sub-handlers run in parallel. Equivalent to accountState + openOrders (symbol-filtered) + marketSummary, but cheaper. Weight: 2

​
Request

{
  "type": "positionContext",
  "address": "0x1234567890abcdef1234567890abcdef12345678",
  "symbol": "PERP_BTC_USDC",
  "broker_id": "orderly"
}
FieldTypeRequiredDefaultNotes
addressstringYes—Wallet address
symbolstringYes—Trading pair
broker_idstringNo—Optional
account_idstringNo—Optional — see “Primary account” below

​
Response

FieldTypeNotes
positionobject | nullnull if the account does not hold this symbol
open_orders[]arrayAlready filtered to symbol — no client-side filtering needed
marketobject | nullnull if the symbol is absent from the latest summary
account_summaryobject | nullnull on ADDRESS_NOT_FOUND

​
Notes

  • Primary account selection (when account_id is omitted): the largest account_value, with account_type == "main" as the tiebreaker
  • Sub-handlers run in parallel
{
  "success": true,
  "data": {
    "position": { /* same shape as accountState.positions[] item */ },
    "open_orders": [ /* openOrders rows, already filtered by symbol */ ],
    "market": {
      "mark_price": "70305.1",
      "index_price": "70298.5",
      "bid_price": "70304.8",
      "ask_price": "70305.5",
      "last_funding_rate": "-0.00005082",
      "est_funding_rate": "-0.00009308",
      "next_funding_time": 1779278400000,
      "24h_volume": "523456789.50",
      "open_interest": "156789012.30"
    },
    "account_summary": {
      "free_collateral": "85000.00",
      "margin_ratio": "0.15"
    }
  },
  "ts": 1779269143700
}