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.

Platform-wide snapshot of every open position across every account. Each row includes the address, account, notional, leverage, margin mode, and estimated liquidation price — enough to construct liquidation heatmaps and cross-account risk views. Weight: 20 — this is the heaviest endpoint (scans every open position across the platform). Use sparingly.

​
Request

{
  "type": "platformPositions",
  "symbol": "PERP_BTC_USDC",
  "min_notional": "10000",
  "limit": 500
}
FieldTypeRequiredDefaultNotes
symbolstringNo—Symbol filter
broker_idstringNo—Broker filter
min_notionaldecimalNo0Minimum position notional to include
limitintNo5001..5000
cursorstringNo—Opaque cursor

​
Response

FieldTypeNotes
total_long_notional, total_short_notional, total_positionstop-levelAggregates over the filtered snapshot (not just the current page)
est_liq_price, unrealized_pnl, unsettled_pnl, leverage, margin_modemixed | nullPer-row position-calc; null on position-calc failure
opened_atint64 | nullms epoch when the position was first opened
margin_modestring | null"CROSS" or "ISOLATED" — clients can filter as needed

​
Notes

  • 5s cache
  • Sort: position ID DESC
  • For building a liquidation heatmap, aggregate est_liq_price into price buckets client-side
{
  "success": true,
  "data": {
    "total_long_notional": "50000",
    "total_short_notional": "45000",
    "total_positions": 1234,
    "rows": [
      {
        "address": "0x1234...",
        "account_id": "0xabc...",
        "broker_id": "orderly",
        "symbol": "PERP_BTC_USDC",
        "side": "LONG",
        "position_qty": "10.5",
        "notional": "420000",
        "average_open_price": "40000",
        "mark_price": "42000",
        "est_liq_price": "38000",
        "unrealized_pnl": "210",
        "unsettled_pnl": "210",
        "leverage": 5,
        "margin_mode": "CROSS",
        "opened_at": 1716000000000
      }
    ],
    "next_cursor": null
  },
  "ts": 1779269143700
}