v1

latestOpenAPI 3.0.32026-07-267278168.1 KB
Margin Account

Get Orders Summaries

Returns a summary of resting orders, position, and market order margin requirements for each market.

get/v1/perps/orders_summaries

Response

Array of per-market order summaries

successboolean required

Whether the request was successful

errorstring

Error message, present only on failure

error_codestring

Semantic error code. See each endpoint's error responses for the specific codes it can return.

deprecatedstring

Deprecation notice, if applicable

Example response

{
  "success": true,
  "result": [
    {
      "market": "AAPL-USD.P",
      "restingOrdersSummary": {
        "bidsInitialMargin": "100.00",
        "asksInitialMargin": "80.00",
        "bidsOpenLoss": "5.00",
        "asksOpenLoss": "3.00",
        "bidsBaseSize": "10.00",
        "asksBaseSize": "8.00",
        "bidsMaintenanceMargin": "50.00",
        "asksMaintenanceMargin": "40.00"
      },
      "positionSummary": {
        "bidsInitialMargin": "100.00",
        "asksInitialMargin": "80.00",
        "bidsOpenLoss": "5.00",
        "asksOpenLoss": "3.00",
        "bidsBaseSize": "10.00",
        "asksBaseSize": "8.00",
        "bidsMaintenanceMargin": "50.00",
        "asksMaintenanceMargin": "40.00"
      },
      "marketOrderSummary": {
        "maxBidQuoteSize": "10000.00",
        "maxBidBaseSize": "5.00",
        "maxBidPositionLeverage": "10.0",
        "maxAskQuoteSize": "10000.00",
        "maxAskBaseSize": "5.00",
        "maxAskPositionLeverage": "10.0"
      }
    }
  ]
}