{ "opencollection": "1.0.0", "info": { "name": "EVM admin private API", "version": "1.0.0" }, "items": [ { "info": { "name": "private", "type": "folder" }, "items": [ { "info": { "name": "Add sub account", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/add_sub_account", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per second**\n\n`POST /v1/client/add_sub_account`\n\nOnly the main account is allowed to call this API.\n\nMain account’s Orderly key can control sub accounts.\n" }, { "info": { "name": "Get sub account list", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/sub_account", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/client/sub_account`\n\nOnly the main account is allowed to call this API.\n" }, { "info": { "name": "Update sub account", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/update_sub_account", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per second**\n\n`POST /v1/client/update_sub_account`\n\nOnly the main account is allowed to call this API.\n" }, { "info": { "name": "Get aggregate positions", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/aggregate/positions", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "\n**Limit: 1 request per 60 seconds**\n\n`GET /v1/client/aggregate/positions`\n\nOnly the main account is allowed to call this API.\n" }, { "info": { "name": "Get aggregate holding", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/aggregate/holding", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "\n**Limit: 1 request per 60 seconds**\n\n`GET /v1/client/aggregate/holding`\n\nOnly the main account is allowed to call this API.\n" }, { "info": { "name": "Settle sub account PnL", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/sub_account_settle_pnl", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly_account_id", "value": "" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per second**\n\n`POST /v1/sub_account_settle_pnl`\n\nMain account’s Orderly key can control sub accounts.\n" }, { "info": { "name": "Get all positions info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/positions", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 30 requests per 10 second per user**\n\n`GET /v1/positions`\n" }, { "info": { "name": "Get lite positions info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/positions_lite", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/positions_lite`\n\nGet lightweight positions information.\n" }, { "info": { "name": "Get one position info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/position/:symbol", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "path" }, { "name": "margin_mode", "value": "", "type": "query", "description": "Default: `CROSS`. Supported values: `CROSS`/`ISOLATED`" } ] }, "docs": "**Limit: 30 requests per 10 second per user**\n\n`GET /v1/position/{symbol}`\n" }, { "info": { "name": "Get position history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/position_history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second per user**\n\n`GET /v1/position_history`\n" }, { "info": { "name": "Get funding fee history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/funding_fee/history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "PERP_ETH_USDC", "type": "query", "description": "omit to get funding fee history for all symbols" }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that you wish to query, noted that the time stamp is a 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that you wish to query, noted that the time stamp is a 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "Default: 60" } ] }, "docs": "**Limit: 20 requests per 60 second per user**\n\n`GET /v1/funding_fee/history`\n\nGet funding fee history.\n" }, { "info": { "name": "Get leverage setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/leverage", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "PERP_BTC_USDC", "type": "query" }, { "name": "margin_mode", "value": "", "type": "query", "description": "Default: `CROSS`. Supported values: `CROSS`/`ISOLATED`" } ] }, "docs": "**Limit: 1 requests per 1 second per IP address**\n\n`GET /v1/client/leverage`\n\nGet account's leverage setting for a specific symbol.\n" }, { "info": { "name": "Get all leverage settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/leverages", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "`GET /v1/client/leverages`\n\nGet leverage settings for all symbols.\n" }, { "info": { "name": "Update leverage setting", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/leverages", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 5 requests per 60 second per user**\n\n`POST /v1/client/leverages`\n\nUpdate leverage settings. This endpoint supports two modes:\n\n**Single symbol mode:** When `symbol` is provided, update leverage for that specific symbol.\n\n**Batch mode:** When `symbol` is omitted, set leverage for all symbols in a single atomic operation. Each symbol's new leverage will be adjusted to `min(requested_leverage, symbol_max_leverage)`.\n\nFor example, if BTC max leverage is 100, ETH max leverage is 100, and NEA" }, { "info": { "name": "Get liquidated positions of account", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/liquidations", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query", "description": "`liquidation_id`/`time`" }, { "name": "liquidation_id", "value": "", "type": "query", "description": "return the designed liquidation_id only" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n`GET /v1/liquidations`\n" }, { "info": { "name": "Claim liquidated positions", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/liquidation", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 5 requests per 1 second**\n\n`POST /v1/liquidation`\n" }, { "info": { "name": "Get liquidated positions by liquidator", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/liquidator_liquidations", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n`GET /v1/client/liquidator_liquidations`\n" }, { "info": { "name": "Create order", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" }, { "name": "x-recv-window", "value": "20" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second**\n\n`POST /v1/order`\n\nPlace order maker/taker, the order executed information will be update from websocket stream.\nwill response immediately with an order created message.\n\n`MARKET` type order behavior: it matches until the full size is executed. If the size is too large (larger than whole book) or the matching price exceeds the price limit (refer to `price_range`), then the remaining quantity will be cancelled.\n\n`IOC` type order behavior: it matches as much as " }, { "info": { "name": "Edit order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.orderly.org/v1/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 request per 1 second**\n\n`PUT /v1/order`\n\nEdit a pending order by `order_id`. Only the `order_price` or `order_quantity` can be amended.\n\nNote: This endpoint requires `trading` scope in orderly key." }, { "info": { "name": "Cancel order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "order_id", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`DELETE /v1/order?order_id={order_id}&symbol={symbol}`\n\nCancels a single order by `order_id`.\n\nNote: This endpoint requires `trading` scope in orderly key.\n" }, { "info": { "name": "Get order by order_id", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/order/:order_id", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "order_id", "value": "", "type": "path", "description": "id of the order" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/order/{order_id}`\n\nGet details of a single order by `order_id`.\n" }, { "info": { "name": "Get trades", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/trades", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query. (max: 500)" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/trades`\n\nReturn client's trades history within a time range.\n\nOnly return the latest 500 entries.\n" }, { "info": { "name": "Get current holding", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/holding", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "all", "value": "", "type": "query", "description": "true/false. If true then will return all token even if balance is empty." } ] }, "docs": "**Limit: 10 requests per 1 seconds**\n\n`GET /v1/client/holding`\n\nGet the current summary of user token holdings.\n" }, { "info": { "name": "Get account overview info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/account_info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 1 second per user**\n\n`GET /v1/account_info`\n\nReturns account-level collateral, margin, and PnL overview metrics for the authenticated account.\n" }, { "info": { "name": "Update margin mode", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/margin_mode", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second per user**\n\n`POST /v1/client/margin_mode`\n\nUpdate the default margin mode for a specific symbol. Switching a symbol's margin mode is only possible when you have no open positions or pending orders on that symbol in the current mode.\n" }, { "info": { "name": "Add or reduce position margin", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/position_margin", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second per user**\n\n`POST /v1/position_margin`\n\nAdd or reduce margin for an existing isolated margin position. This allows you to adjust the margin allocated to a specific isolated position after it has been opened.\n\n- `ADD`: Transfer margin from your available balance to the isolated position, lowering the liquidation price.\n- `REDUCE`: Transfer margin from the isolated position back to your available balance, raising the liquidation price.\n\n**Prerequisites:** You must" }, { "info": { "name": "Get margin modes", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/margin_modes", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 1 second per user**\n\n`GET /v1/client/margin_modes`\n\nGet default margin mode for all symbols.\n" }, { "info": { "name": "Get account information", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`GET /v1/client/info`\n\nReturns account configuration details for the authenticated account, including fee rates and leverage settings.\n" }, { "info": { "name": "Get orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/orders", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "side", "value": "", "type": "query", "description": "`BUY`/`SELL`" }, { "name": "order_type", "value": "", "type": "query", "description": "`LIMIT`/`MARKET`" }, { "name": "status", "value": "", "type": "query", "description": "`NEW`/`CANCELLED`/`PARTIAL_FILLED`/`FILLED`/`REJECTED`/`INCOMPLETE`/`COMPLETED`" }, { "name": "order_tag", "value": "", "type": "query" }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query (max: 500)" }, { "name": "sort_by", "value": "", "type": "query", "description": "If empty:\n\nDescending order by updated_time if user passed update_start_t or update_end_t; descending order by order_id if updated_time are the same;\n\nOtherwise descending order by created_time; descending order by order_id if created_time are the same;\n\n\nIf not empty:\n\nIf sort_by == `CREATED_TIME_DESC`, descending order by created_time. Descending order by order_id if created_time are same;\n\nIf sort_by == `CREATED_TIME_ASC`, ascending order by created_time. Ascending order by order_id if created_time are same;\n\nIf sort_by == `UPDATED_TIME_DESC`, descending order by updated_time. Descending order by order_id if updated_time are same;\n\nIf sort_by == `UPDATED_TIME_ASC`, ascending order by updated_time. Ascending order by order_id if updated_time are same;\n" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/orders`\n\nGet orders by customized filters.\n\nFor filter by status, one can reference special bundled statuses below for ease of access of Open (ie `INCOMPLETE`) orders or `COMPLETED` orders.\n\n- `INCOMPLETE` = `NEW` + `PARTIAL_FILLED`\n- `COMPLETED` = `CANCELLED` + `FILLED`\n" }, { "info": { "name": "Cancel all pending orders", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/orders", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`DELETE /v1/orders?symbol={symbol}`\n\nCancel a list of orders, filtered by `symbol` optionally. This request will cancel all open orders within the filter criteria, and will cancel all open orders if no filter is provided.\n\nNote: This endpoint requires `trading` scope in orderly key.\n" }, { "info": { "name": "Get user statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/statistics", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`GET /v1/client/statistics`\n\nReturns trading activity and fee statistics for the authenticated account.\n" }, { "info": { "name": "Get asset history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/asset/history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "token", "value": "", "type": "query", "description": "Filter results to a specific token symbol." }, { "name": "side", "value": "", "type": "query", "description": "Filter by transfer direction: `DEPOSIT` or `WITHDRAW`." }, { "name": "status", "value": "", "type": "query", "description": "Filter by transfer status. Supported values: `NEW`, `CONFIRM`, `PROCESSING`, `COMPLETED`, `FAILED`, `PENDING_REBALANCE`." }, { "name": "start_t", "value": "", "type": "query", "description": "Filter results created at or after this timestamp in milliseconds." }, { "name": "end_t", "value": "", "type": "query", "description": "Filter results created at or before this timestamp in milliseconds." }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. Starts from 1." }, { "name": "size", "value": "", "type": "query", "description": "Number of records to return per page." } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/asset/history`\n\nReturns asset transfer history for the authenticated account, including deposits and withdrawals.\n" }, { "info": { "name": "Get receiver address", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/asset/receiver_address", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "chain_id", "value": "42161", "type": "query", "description": "Chain ID to get the receiver address for. Supported chains: Arbitrum (`42161`), BNB Chain (`56`)." }, { "name": "token", "value": "USDC", "type": "query", "description": "Token symbol. Supported tokens: `USDC`, `USDT`. Defaults to `USDC` if omitted." } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/client/asset/receiver_address`\n\nReturns the exclusive receiver address for the authenticated account. Users can deposit supported tokens by transferring directly to this address without wallet connection or gas.\n" }, { "info": { "name": "Get receiver events", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/asset/receiver_events", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/client/asset/receiver_events`\n\nReturns transfer events detected at the user's exclusive receiver address. Use this endpoint to poll for deposit status after a user transfers tokens to their receiver address.\n" }, { "info": { "name": "Claim insurance fund", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/claim_insurance_fund", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 5 requests per 1 second**\n\n`POST /v1/claim_insurance_fund`\n" }, { "info": { "name": "Remove Orderly key", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/remove_orderly_key", "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n`POST /v1/client/remove_orderly_key`\n\nRemoves an orderly key from an account and deactivates it for future use.\n" }, { "info": { "name": "Cancel all after", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/order/cancel_all_after", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per 1 second**\n\n`POST /v1/order/cancel_all_after`\n\nCancels all of the user's ordinary and algo orders after being called (dead man switch).\n\nNote: Users must apply for access before using this endpoint." }, { "info": { "name": "Batch create order", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/batch-order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" }, { "name": "x-recv-window", "value": "20" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per 1 second**\n\n`POST /v1/batch-order`\n\nCreates a batch of orders as a list according to the same rules as a single Create Order.\n\nParameters for each order within the batch will be the same as the create single order. The batch of orders should be sent as a JSON array containing all the orders. The maximum number of orders that can be sent in 1 batch order request is 10. Each order within the batch order request is counted as 1 order towards the overall create order rate limi" }, { "info": { "name": "Batch cancel orders", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/batch-order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "order_ids", "value": "", "type": "query", "description": "List of order_ids, comma-separated, with a maximum of 10 order ids per request." } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`DELETE /v1/batch-order?order_ids={order_id1},{order_id2}`\n\nCancel a list of orders by `order_ids`. The maximum orders that can be cancelled within 1 batch cancel request is 10. \n\nThis endpoint will return invalid order_id error if 0 order_ids are given or all of the given order_ids are invalid. \n\nNote: This endpoint requires `trading` scope in orderly key.\n" }, { "info": { "name": "Cancel order by client_order_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/client/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "client_order_id", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`DELETE /v1/client/order?client_order_id={client_order_id}&symbol={symbol}`\n\nCancel an order by `client_order_id`.\n\nNote: This endpoint requires `trading` scope in orderly key.\n" }, { "info": { "name": "Batch cancel orders by client_order_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/client/batch-order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "client_order_ids", "value": "", "type": "query", "description": "List of client_order_ids, comma-separated, with a maximum of 10 order ids per request." } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`DELETE /v1/client/batch-order?client_order_ids={client_order_id1},{client_order_id2}`\n\nCancel a list of orders by `client_order_ids`. The maximum orders that can be cancelled within 1 batch cancel request is 10.\n\nThis endpoint will return invalid client_order_id error if 0 client_order_ids are given or all of the given client_order_ids are invalid. \n\nNote: This endpoint requires `trading` scope in orderly key.\n" }, { "info": { "name": "Get order by client_order_id", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/order/:client_order_id", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "client_order_id", "value": "", "type": "path", "description": "client_order_id of the order" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/client/order/{client_order_id}`\n\nGet details of a single order by `client_order_id`.\n" }, { "info": { "name": "Orderbook snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/orderbook/:symbol", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "PERP_BTC_USDC", "type": "path" }, { "name": "max_level", "value": "", "type": "query", "description": "the levels wish to show on both side." } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/orderbook/{symbol}`\n\nSnapshot of the current orderbook. Price of asks/bids are in descending order.\n" }, { "info": { "name": "Get all trades of specific order", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/order/:order_id/trades", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "order_id", "value": "", "type": "path" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/order/{order_id}/trades`\n\nGet specific trades of an order by `order_id`.\n" }, { "info": { "name": "Get trade", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/trade/:trade_id", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "trade_id", "value": "", "type": "path", "description": "id of the trade" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/trade/{trade_id}`\n\nGet specific transaction details by `trade_id`.\n" }, { "info": { "name": "Configure auto-cancel during maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/maintenance_config", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`POST /v1/client/maintenance_config`\n\nSet the user config for whether the system should automatically cancel the user's pending orders during maintenance.\n" }, { "info": { "name": "Get user volume statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/volume/user/stats", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/volume/user/stats`\n\nReturns cumulative trading volume statistics for the authenticated account." }, { "info": { "name": "Get user daily volume", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/volume/user/daily", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date in `YYYY-MM-DD` format." }, { "name": "end_date", "value": "", "type": "query", "description": "End date in `YYYY-MM-DD` format." } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/volume/user/daily`\n\nReturns the authenticated account's daily perpetual trading volume for the requested date range.\n" }, { "info": { "name": "Get withdrawal nonce", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/withdraw_nonce", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit 10 requests per 1 seconds**\n\n`GET /v1/withdraw_nonce`\n\nRetrieves a nonce required to sign a withdrawal request. Each nonce can only be used once.\n" }, { "info": { "name": "Get settle PnL nonce", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/settle_nonce", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/settle_nonce`\n\nRetrieves a nonce required to sign a PnL settlement request. Each nonce can only be used once.\n" }, { "info": { "name": "Create withdraw request", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/withdraw_request", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n`POST /v1/withdraw_request`\n\n`verifyingContract` should use: `0x6F7a338F2aA472838dEFD3283eB360d4Dff5D203`.\n\nIf `allowCrossChainWithdraw` is `false` for a cross-chain withdrawal request, the request is rejected." }, { "info": { "name": "Request PnL settlement", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/settle_pnl", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per 1 second**\n\n`POST /v1/settle_pnl`\n\n`verifyingContract` should use: `0x6F7a338F2aA472838dEFD3283eB360d4Dff5D203`.\n" }, { "info": { "name": "Get PnL settlement history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/pnl_settlement/history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "**Limit: 20 requests per 1 second**\n\n`GET /v1/pnl_settlement/history`\n\nRetrieve the historical PnL settlement history of the account.\n" }, { "info": { "name": "Create internal transfer", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/internal_transfer", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second**\n\n`POST /v1/internal_transfer`\n\nThis endpoint will return internal transfer is not available for Delegate Signer account if the `from` is a Delegate Signer account.\n\nScenarios where internal transfers are allowed:\n\na. Main and sub accounts\n\nb. Accounts within the same wallet group\n\nc. Same address across all brokers.\n\nd. A whitelisted `account_id` can be used as `from address`\n\ne. If 2 `account_id` are under the same broker_id and the broker_id is whitelisted.\n" }, { "info": { "name": "Create internal transfer with wallet signature", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v2/internal_transfer", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second**\n\n`POST /v2/internal_transfer`\n" }, { "info": { "name": "Get transfer nonce", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/transfer_nonce", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/transfer_nonce`\n" }, { "info": { "name": "Get internal transfer history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/internal_transfer_history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "status", "value": "", "type": "query", "description": "`CREATED`/`PENDING`/`COMPLETED`/`FAILED`" }, { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "side", "value": "", "type": "query", "description": "`IN`/`OUT`" }, { "name": "from_account_id", "value": "", "type": "query" }, { "name": "to_account_id", "value": "", "type": "query" }, { "name": "main_sub_only", "value": "", "type": "query", "description": "If True, return only internal transfers between main account and sub accounts. \nIf False, return only internal transfers between main account and other main accounts. \nIf empty, return all transfer history.\n" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/internal_transfer_history`\n\nOrderly key must has `asset` scope to access this endpoint.\n" }, { "info": { "name": "Get current Orderly key info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/key_info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "key_status", "value": "", "type": "query", "description": "Filter by orderly key status. Supported values: `ACTIVE`, `REMOVING`, or `REMOVED`." } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/client/key_info`\n\nRetrieves all registered orderly keys under the account.\n" }, { "info": { "name": "Get Orderly key IP restriction", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/orderly_key_ip_restriction", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "orderly_key", "value": "", "type": "query", "description": "The orderly key to query the IP restriction list" } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/client/orderly_key_ip_restriction`\n\nRetrieves the current IP restriction of a particular Orderly key.\n" }, { "info": { "name": "Set Orderly key IP restriction", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/set_orderly_key_ip_restriction", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "orderly_key", "value": "", "type": "query", "description": "The orderly key to set the IP restriction list." }, { "name": "ip_restriction_list", "value": "", "type": "query", "description": "List of IP addresses or IP ranges, comma separated, that are allowed to use the `orderly_key`." } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`POST /v1/client/set_orderly_key_ip_restriction`\n\nSet the IP restrictions of a particular Orderly key under the account.\n" }, { "info": { "name": "Reset Orderly key IP restriction", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/reset_orderly_key_ip_restriction", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "orderly_key", "value": "", "type": "query", "description": "The orderly key whose IP restriction will be reset." }, { "name": "reset_mode", "value": "", "type": "query", "description": "Reset mode to apply. Use `ALLOW_ALL_IPS` to remove all IP restrictions, or `DISALLOW_ALL_IPS` to block all IPs for this key." } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`POST /v1/client/reset_orderly_key_ip_restriction`\n\nReset the IP restriction of a particular Orderly key under the account.\n" }, { "info": { "name": "Get all notifications", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/notification/inbox/notifications", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "type", "value": "", "type": "query", "description": "Filter notifications by type: `TRADE` or `SYSTEM`." }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query", "description": "Number of notifications to return per page." } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`GET /v1/notification/inbox/notifications`\n\nReturns notification records for the user.\n\nUse `type` to filter the categories returned.\n" }, { "info": { "name": "Get unread notifications", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/notification/inbox/unread", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`GET /v1/notification/inbox/unread`\n\nGet the information on unread messages for the user.\n" }, { "info": { "name": "Set read status of notifications", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/notification/inbox/mark_read", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "flag", "value": "", "type": "query", "description": "The value of the read flag, where 1 = READ and 0 = UNREAD" }, { "name": "ids", "value": "", "type": "query", "description": "The list of notification ids to flag as read/unread." } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`POST /v1/notification/inbox/mark_read`\n\nSet the read status on a list of notifications for a user.\n" }, { "info": { "name": "Set read status of all notifications", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/notification/inbox/mark_read_all", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "flag", "value": "", "type": "query", "description": "The value of the read flag, where 1 = READ and 0 = UNREAD" } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`POST /v1/notification/inbox/mark_read_all`\n\nSet the read status on all notifications for a user.\n" }, { "info": { "name": "Create algo order", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/algo/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" }, { "name": "x-recv-window", "value": "20" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per 1 second**\n\n`POST /v1/algo/order`\n\nPlace maker/taker order that requires an additional trigger for order execution such as stop orders.\n\n`STOP` type order bahavior: an order to buy or sell at the market/limit price once the asset has traded at or through a specified price (the \"stop price\"). If the asset reaches the stop price, the order becomes a market order and is filled at the next available market price.\n\nTo place `Positional TP/SL` order, the input fields is 2 layer " }, { "info": { "name": "Edit algo order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.orderly.org/v1/algo/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 5 requests per 1 second**\n\n`PUT /v1/algo/order`\n\nEdit a pending algo order by `order_id`. Only the price or quantity can be amended.\n\nNote: This endpoint requires trading scope in orderly key." }, { "info": { "name": "Cancel algo order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/algo/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query", "description": "Symbol of the algo order to cancel." }, { "name": "order_id", "value": "", "type": "query" } ] }, "docs": "**Limit: 5 requests per 1 second**\n\n`DELETE /v1/algo/order?order_id={order_id}&symbol={symbol}`\n\nCancels a single algo order by `order_id`.\n" }, { "info": { "name": "Cancel algo order by client_order_id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/algo/client/order", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "client_order_id", "value": "", "type": "query" } ] }, "docs": "**Limit: 5 requests per 1 second**\n\n`DELETE /v1/algo/client/order?client_order_id={client_order_id}&symbol={symbol}`\n\nCancel an algo order by `client_order_id`." }, { "info": { "name": "Get algo orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/algo/orders", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "order_type", "value": "", "type": "query", "description": "`LIMIT`/`MARKET`" }, { "name": "status", "value": "", "type": "query", "description": "`NEW`/`CANCELLED`/`PARTIAL_FILLED`/`FILLED`/`REJECTED`/`INCOMPLETE`/`COMPLETED`" }, { "name": "order_tag", "value": "", "type": "query", "description": "Filter by a custom tag assigned to the order." }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query (max: 500)" }, { "name": "side", "value": "", "type": "query", "description": "`BUY`/`SELL`" }, { "name": "algo_type", "value": "", "type": "query", "description": "Supported types are `STOP`, `TPSL`, `positional_TPSL`" }, { "name": "is_triggered", "value": "", "type": "query" } ] }, "docs": "**Limit: 5 requests per 1 second**\n\n`GET /v1/algo/orders`\n\nGet algo order details by customized filters.\n\nFor filter by status, one can reference special bundled statuses below for ease of access of Open (i.e `INCOMPLETE`) orders or `COMPLETED` orders.\n\n`INCOMPLETE` = `NEW` + `PARTIAL_FILLED`\n\n\n`COMPLETED` = `CANCELLED` + `FILLED`" }, { "info": { "name": "Cancel all pending algo orders", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.orderly.org/v1/algo/orders", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "algo_type", "value": "", "type": "query", "description": "Note: `STOP` will cancel both `TAKE_PROFIT` and `STOP_LOSS`" } ] }, "docs": "**Limit: 5 requests per 1 second**\n\n`DELETE /v1/algo/orders?symbol={symbol}`\n\nCancel all pending algo orders." }, { "info": { "name": "Get algo order by order_id", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/algo/order/:order_id", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "order_id", "value": "", "type": "path", "description": "id of the order" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/algo/order/{order_id}`\n\nGet details of a single algo order by order_id." }, { "info": { "name": "Get algo order by client_order_id", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/algo/client/order/:client_order_id", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "client_order_id", "value": "", "type": "path", "description": "client_order_id of the order" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/algo/client/order/{client_order_id}`\n\nGet details of a single algo order by `client_order_id`.\n" }, { "info": { "name": "Get all trades of specific algo order", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/algo/order/:order_id/trades", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "order_id", "value": "", "type": "path" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/algo/order/{order_id}/trades`\n\nGet specific trades of an algo order by `order_id`.\n" }, { "info": { "name": "Get builder's users' volumes", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/volume/broker/daily", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "0x0f29bfb4c1bc9fea3f3be46bab6d795e22a6272354b136fde05f6b80cfcad546" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Format YYYY-MM-DD" }, { "name": "end_date", "value": "", "type": "query", "description": "Format YYYY-MM-DD" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "address", "value": "", "type": "query" }, { "name": "order_tag", "value": "", "type": "query", "description": "Filter by a custom tag assigned to the order." }, { "name": "aggregateBy", "value": "", "type": "query", "description": "Either by `DATE` or by `ACCOUNT`" }, { "name": "sort", "value": "", "type": "query", "description": "Allow sort by\n\n`ascending_broker_fee`\n`descending_broker_fee`\n`ascending_perp_maker_volume`\n`descending_perp_maker_volume`\n`ascending_perp_taker_volume`\n`descending_perp_taker_volume`\n`ascending_perp_volume`\n`descending_perp_volume`\n`ascending_total_fee`\n`descending_total_fee`\n" } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/volume/broker/daily`\n\nGet the daily historical breakdown of the user trading volume on specified builder.\n\nThe provided `start_date`/`end_date` has to be within a 90-day range.\nUpdated hourly\n" }, { "info": { "name": "Get builder's leaderboard", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/broker/leaderboard/daily", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Format YYYY-MM-DD" }, { "name": "end_date", "value": "", "type": "query", "description": "Format YYYY-MM-DD" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "order_tag", "value": "", "type": "query", "description": "Filter by a custom tag assigned to the order." }, { "name": "broker_id", "value": "", "type": "query", "description": "if the broker_id is empty, return all users" }, { "name": "sort", "value": "", "type": "query", "description": "Allow sort by\n\n`ascending_realized_pnl`\n`descending_realized_pnl`\n`ascending_perp_volume`\n`descending_perp_volume`\n" }, { "name": "address", "value": "", "type": "query" }, { "name": "aggregateBy", "value": "", "type": "query", "description": "`address`: Sum the value across all builders.\n`address_per_builder`: Sum the value separately for each builder.\n" } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/broker/leaderboard/daily`\n\nThe provided `start_date`/`end_date` has to be within a 90-day range.\n\nUpdated hourly\n" }, { "info": { "name": "Get builder fee tier information", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/broker/broker_info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "0x0f29bfb4c1bc9fea3f3be46bab6d795e22a6272354b136fde05f6b80cfcad546" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/broker/broker_info`\n\nGet builder's fee tier information including staking balance, trading volume, and fee rates. Fee rate fields returned by this endpoint are in bps.\n" }, { "info": { "name": "Get builder's daily revenue settlement history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/broker/daily_fee_revenue", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "2026-04-01", "type": "query", "description": "Start date in `YYYY-MM-DD` format. Must be less than or equal to `end_date`." }, { "name": "end_date", "value": "2026-04-30", "type": "query", "description": "End date in `YYYY-MM-DD` format. The interval from `start_date` to `end_date` must not exceed 180 days." } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/broker/daily_fee_revenue`\n\nRetrieve daily revenue settlement records for the broker ID linked to the authenticated builder admin. Use this endpoint to reconcile settled builder revenue by UTC accounting date.\n\nEach row represents a non-zero settlement day and breaks revenue into permissionless listing fee share, distributor fee share, and net fee revenue from the builder's trading platform. `builder_fee_revenue` is the net fee revenue earned from the b" }, { "info": { "name": "Get user daily statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/statistics/daily", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "0x0f29bfb4c1bc9fea3f3be46bab6d795e22a6272354b136fde05f6b80cfcad546" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date in `YYYY-MM-DD` format." }, { "name": "end_date", "value": "", "type": "query", "description": "End date in `YYYY-MM-DD` format." }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. Starts from 1." }, { "name": "size", "value": "", "type": "query", "description": "Number of records to return per page." }, { "name": "include_historical_data", "value": "False", "type": "query", "description": "When set to `true`, the response also includes archived data and the rate limit becomes 1 request per 60 seconds." } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/client/statistics/daily`\n\nReturns daily account snapshots for account value, PnL, and trading volume over the requested date range.\n" }, { "info": { "name": "Get user fee rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/broker/user_info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "account_id", "value": "", "type": "query" }, { "name": "address", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "**Limit 60 requests per 60 seconds**\n\n`GET /v1/broker/user_info`\n\nScope: Only each builder_id's admin wallet can call this endpoint.\n\nIf `account_id` or `address` is provided, will always return the fee rate and indicate whether the user is on the builder’s default fee rate or not. Note that although both `account_id` and `address` are schema-optional, you must provide at least one of them to query a specific user's fee rate. If neither is provided, the API will fail in certain operation modes d" }, { "info": { "name": "Update user fee rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/broker/fee_rate/set", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/broker/fee_rate/set`\n\nSend a list of accounts assigned to a new fee rate. Max 500 accounts per request.\n\nScope: Only each builder_id's admin wallet can call this endpoint.\n" }, { "info": { "name": "Reset user fee rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/broker/fee_rate/set_default", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/broker/fee_rate/set_default`\n\nAssign users to a default fee rate. Only send accounts that need to be updated. Max 500 accounts per request.\n\nScope: Only each builder’s admin can create the referral code for accounts that are related to the builder_id\n" }, { "info": { "name": "Get default builder fee", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/broker/fee_rate/default", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 1 requests per second**\n\n`GET /v1/broker/fee_rate/default`\n\nGet default fee rate.\n\nScope: Only each builder_id’s admin wallet can call this endpoint\n" }, { "info": { "name": "Update default builder fee", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/broker/fee_rate/default", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/broker/fee_rate/default`\n\nUpdate the default fee rate for users assigned to a default fee rate.\n\nScope: Only each builder_id’s admin wallet can call this endpoint\n" }, { "info": { "name": "Create referral code", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/create", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/referral/create`\n\nScope: Only each builder’s admin can create the referral code for accounts that are related to the builder_id\n" }, { "info": { "name": "Get referral code info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/admin_info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query", "description": "Only one of `user_address` and `account_id` can be provided" }, { "name": "user_address", "value": "", "type": "query" }, { "name": "account_id", "value": "", "type": "query", "description": "Only one of `user_address` and `account_id` can be provided" }, { "name": "sort_by", "value": "", "type": "query", "description": "`total_invites`/`total_traded`/`referee_volume` descending" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/admin_info`\n\nScope: Only each builder’s admin wallet can call this endpoint.\n" }, { "info": { "name": "Update referral code", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/update", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/referral/update`\n\nScope: Only each Builder’s admin wallet can call this endpoint.\n" }, { "info": { "name": "Bind referral code", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/bind", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/referral/bind`\n" }, { "info": { "name": "Get referral info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/info`\n" }, { "info": { "name": "Get referral history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/referral_history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "start date range that you wish to query, in the format ‘YYYY-MM-DD’" }, { "name": "end_date", "value": "", "type": "query", "description": "end date range that you wish to query, in the format ‘YYYY-MM-DD’" }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query (max: 500)" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/referral_history`\n\nProvides a detailed history of referral rebates paid to the user.\n" }, { "info": { "name": "Get referral rebate summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/rebate_summary", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/rebate_summary`\n" }, { "info": { "name": "Get referee history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/referee_history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "start date range that you wish to query, in the format ‘YYYY-MM-DD’" }, { "name": "end_date", "value": "", "type": "query", "description": "end date range that you wish to query, in the format ‘YYYY-MM-DD’" }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query (max: 500)" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/referee_history`\n\nProvides a summary of all referee activity for the requesting user.\n" }, { "info": { "name": "Get referee info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/referee_info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "sort", "value": "ascending_volume", "type": "query", "description": "`ascending_code_binding_time`\n`descending_code_binding_time`\n`ascending_referral_rebate`\n`descending_referral_rebate`\n`ascending_volume`\n`descending_volume`\n" } ] }, "docs": "**Limit: 10 requests per second**\n\n\n`GET /v1/referral/referee_info`\n" }, { "info": { "name": "Get referee rebate summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/referee_rebate_summary", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "start date range that you wish to query, in the format ‘YYYY-MM-DD’" }, { "name": "end_date", "value": "", "type": "query", "description": "end date range that you wish to query, in the format ‘YYYY-MM-DD’" } ] }, "docs": "**Limit: 10 requests per second**\n\n\n`GET /v1/referral/referee_rebate_summary`\n\n\nProvides daily statistics on referee rebates\n" }, { "info": { "name": "Edit referral code split", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/edit_split", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/referral/edit_split`\n" }, { "info": { "name": "Builder admin update auto referral", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/auto_referral/update", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/referral/auto_referral/update`\n\nScope: Only each Builder’s admin wallet can call this endpoint.\n" }, { "info": { "name": "Builder admin get auto referral info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/auto_referral/info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 1 requests per second**\n\n`GET /v1/referral/auto_referral/info`\n\nScope: Only each Builder’s admin wallet can call this endpoint.\n" }, { "info": { "name": "Get auto referral progress", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/auto_referral/progress", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 1 requests per second**\n\n`GET /v1/referral/auto_referral/progress`\n" }, { "info": { "name": "Edit referral code", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/edit_referral_code", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per second**\n\n`POST /v1/referral/edit_referral_code`\n\nOnly Auto generated code can be updated.\n\nThe referral code can only be changed if it hasn’t been bound by other user yet. \n\nThere is no limit to the number of times it can be changed.\n\nThe referral code must be unique platform-wise.\n" }, { "info": { "name": "Get max rebate rate", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/max_rebate_rate", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 1 request per second**\n\n`GET /v1/referral/multi_level/max_rebate_rate`\n\nReturns the maximum rebate rate for the user in the multilevel referral program.\n" }, { "info": { "name": "Claim referral code", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/claim_code", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/referral/multi_level/claim_code`\n\nClaims a referral code for the user.\n" }, { "info": { "name": "Get rebate info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/rebate_info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 1 request per second**\n\n`GET /v1/referral/multi_level/rebate_info`\n\nReturns detailed rebate information for the referral code.\n" }, { "info": { "name": "Update referee rebate rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/rebate_rate/update", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/referral/multi_level/rebate_rate/update`\n\nUpdates the rebate rate for referees. Users can only update the rate for their direct referees.\n" }, { "info": { "name": "Reset referee rebate rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/rebate_rate/set_default", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/referral/multi_level/rebate_rate/set_default`\n\nResets the referee rebate rate to default. Users can only reset the rate for their direct referees.\n" }, { "info": { "name": "Get multilevel statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/statistics", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "time_range", "value": "7d", "type": "query", "description": "Time range for statistics: 1d, 7d, 30d, all_time" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/multi_level/statistics`\n\nReturns multilevel referral statistics for the user.\n" }, { "info": { "name": "Get referee list", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/referee_list", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "page", "value": "1", "type": "query", "description": "Page number" }, { "name": "size", "value": "25", "type": "query", "description": "Page size" }, { "name": "address", "value": "", "type": "query", "description": "Filter by address" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort by field: code_binding_time, referral_rebate_rate, referee_rebate_rate, direct_invites, indirect_invites, direct_volume, indirect_volume" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort order: ascending, descending" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/multi_level/referee_list`\n\nReturns the list of direct referees (those who used your code). Includes both multilevel and legacy referral codes.\n" }, { "info": { "name": "Get volume prerequisite", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/volume_prerequisite", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/multi_level/volume_prerequisite`\n\nReturns the volume prerequisite for the multilevel referral program.\n" }, { "info": { "name": "Get multilevel referral config", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/admin", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ] }, "docs": "**Limit: 1 request per second**\n\n`GET /v1/referral/multi_level/admin`\n\nReturns the multilevel referral configuration. Restricted to Admin users only.\n" }, { "info": { "name": "Enable or configure multilevel referral", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/admin", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/referral/multi_level/admin`\n\nEnables or configures the multilevel referral program. Restricted to Admin users only.\n" }, { "info": { "name": "Update multilevel referral config", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/admin/update", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/referral/multi_level/admin/update`\n\nUpdates the multilevel referral configuration. Restricted to Admin users only.\n" }, { "info": { "name": "Update L1 affiliate rebate rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/admin/update/affiliate", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/referral/multi_level/admin/update/affiliate`\n\nUpdates the max rebate rate of an L1 affiliate. Broker (DEX owner) can only update the rate for L1 affiliates. Restricted to Admin users only.\n" }, { "info": { "name": "Reset L1 affiliate rebate rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/admin/reset/affiliate", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/referral/multi_level/admin/reset/affiliate`\n\nResets an L1 affiliate's rebate rate. Admin can only update the rate for L1 referees. Restricted to Admin users only.\n" }, { "info": { "name": "Get multilevel info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/admin/info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "user_address", "value": "", "type": "query", "description": "Only one of user_address and account_id can be provided" }, { "name": "account_id", "value": "", "type": "query", "description": "Only one of user_address and account_id can be provided" }, { "name": "referrer_account", "value": "", "type": "query", "description": "Only one of referrer_account and referrer_address can be provided" }, { "name": "referrer_address", "value": "", "type": "query", "description": "Only one of referrer_account and referrer_address can be provided" }, { "name": "page", "value": "1", "type": "query", "description": "Page number" }, { "name": "size", "value": "25", "type": "query", "description": "Page size" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort by field: total_invites, total_traded, referee_volume" }, { "name": "level", "value": "", "type": "query", "description": "Return all if not provided" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/multi_level/admin/info`\n\nReturns detailed multilevel referral information. Users without a created code will not appear in the response. Restricted to Admin users only.\n" }, { "info": { "name": "Get admin referee list", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/admin/referee_list", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "page", "value": "1", "type": "query", "description": "Page number" }, { "name": "size", "value": "25", "type": "query", "description": "Page size" }, { "name": "user_address", "value": "", "type": "query", "description": "Only one of user_address and account_id can be provided" }, { "name": "account_id", "value": "", "type": "query", "description": "Only one of user_address and account_id can be provided" }, { "name": "referrer_address", "value": "", "type": "query", "description": "Filter by referrer address" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort by field: code_binding_time, referral_rebate_rate, referee_rebate_rate, direct_invites, indirect_invites, direct_volume, indirect_volume" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort order: ascending, descending" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/multi_level/admin/referee_list`\n\nReturns a list of referees for a builder admin. Includes legacy code referrals. Restricted to Admin users only.\n" }, { "info": { "name": "Get multilevel summary info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/referral/multi_level/admin/summary", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "start_date", "value": "2025-01-01", "type": "query", "description": "Start date (YYYY-MM-DD)" }, { "name": "end_date", "value": "2025-12-31", "type": "query", "description": "End date (YYYY-MM-DD)" }, { "name": "page", "value": "1", "type": "query", "description": "Page number, default 1" }, { "name": "size", "value": "20", "type": "query", "description": "Page size, default 20" }, { "name": "aggregate_by", "value": "account_id", "type": "query", "description": "Aggregate by: date, account_id" }, { "name": "account_id", "value": "", "type": "query", "description": "Only one of account_id and user_address can be provided" }, { "name": "user_address", "value": "", "type": "query", "description": "Only one of account_id and user_address can be provided" }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort by field: broker_fee, total_volume, total_invites" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/referral/multi_level/admin/summary`\n\nReturns summary information for multilevel referral. Restricted to Admin users only.\n" }, { "info": { "name": "Create multilevel referral code on affiliate's behalf", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/referral/multi_level/admin/create/affiliate", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per second**\n\n`POST /v1/referral/multi_level/admin/create/affiliate`\n\nCreates a multilevel referral code on an affiliate's behalf. Restricted to Admin users only.\n" }, { "info": { "name": "Get stage parameters", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/points/stage", "headers": [ { "name": "orderly-timestamp", "value": "" }, { "name": "orderly-account-id", "value": "" }, { "name": "orderly-key", "value": "" }, { "name": "orderly-signature", "value": "" } ], "params": [ { "name": "stage_id", "value": "", "type": "query", "description": "Filter by specific Stage" } ] }, "docs": "**Limit: 10 requests per 1 second per user per IP address**\n\n`GET /v1/admin/points/stage`\n\nGet a specific stage (series of epochs).\n\nOnly callable by Broker Admin.\n" }, { "info": { "name": "Create/update stage parameters", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/admin/points/stage", "headers": [ { "name": "orderly-timestamp", "value": "" }, { "name": "orderly-account-id", "value": "" }, { "name": "orderly-key", "value": "" }, { "name": "orderly-signature", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second per user per IP address**\n\n`POST /v1/admin/points/stage`\n\nCreate a new stage (series of epochs). Only callable by Broker Admin.\n\nMake sure there's only 1 active stage at any time.\n" }, { "info": { "name": "Delegate signer withdraw request", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/delegate_withdraw_request", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/delegate_withdraw_request`\n\nCreates a withdrawal request on behalf of an account using an authorized delegate signer.\n" }, { "info": { "name": "Delegate signer settle PnL", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/delegate_settle_pnl", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 requests per second**\n\n`POST /v1/delegate_settle_pnl`\n\nRequests PnL settlement on behalf of an account using an authorized delegate signer.\n" }, { "info": { "name": "Get distribution history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/client/distribution_history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "status", "value": "true", "type": "query", "description": "One of `CREATED`/`SPLIT`/`COMPLETED`" }, { "name": "type", "value": "true", "type": "query", "description": "One of `BROKER_FEE`/`REFEREE_REBATE`/`REFERRER_REBATE`" }, { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per second**\n\n`GET /v1/client/distribution_history`\n" }, { "info": { "name": "Sign up campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/client/campaign/sign_up", "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 10 requests per 1 second**\n\n`POST /v1/client/campaign/sign_up`\n" }, { "info": { "name": "Get wallet's current staked balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/staking/balance", "params": [ { "name": "address", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n`GET /v1/staking/balance`\n" }, { "info": { "name": "Get unstaking order details", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/staking/unstake_details", "params": [ { "name": "address", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n`GET /v1/staking/unstake_details`\n" }, { "info": { "name": "Get valor2 redeem info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/staking/valor2/redeem", "params": [ { "name": "address", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\nThe redeemed VALOR amount may come from multiple batches\n\n`GET /v1/staking/valor2/redeem`\n" }, { "info": { "name": "Get valor redeem info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/staking/valor/redeem", "params": [ { "name": "address", "value": "", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n\n`GET /v1/staking/valor/redeem`\n" }, { "info": { "name": "Get esorder vesting list", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/staking/esorder/vesting_list", "params": [ { "name": "address", "value": "", "type": "query" }, { "name": "is_vesting", "value": "False", "type": "query" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n\n`GET /v1/staking/esorder/vesting_list`\n" }, { "info": { "name": "Add SP Orderly key", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/sv/sp_orderly_key", "body": { "type": "json", "data": "{}" } }, "docs": "\n**Limit: 10 requests per second per IP address**\n\n`POST /v1/sv/sp_orderly_key`\n\nAdds an Orderly access key to a SP account\n" }, { "info": { "name": "Request SP PnL settlement", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/sv/sp_settle_pnl", "body": { "type": "json", "data": "{}" } }, "docs": "\n**Limit: 1 request per second**\n\n`POST /v1/sv/sp_settle_pnl`\n" }, { "info": { "name": "Trigger manual period delivery", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/sv/manual_period_delivery", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n**Limit: 1 request per second per account**\n\n`POST /v1/sv/manual_period_delivery`\n" }, { "info": { "name": "Get account information", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/client/info", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 10 requests per 60 seconds**\n\n`GET /v1/admin/client/info`\n" }, { "info": { "name": "Get current holding", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/client/holding", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "all", "value": "", "type": "query", "description": "true/false. If true then will return all token even if balance is empty." }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 10 requests per 1 seconds**\n\n`GET /v1/admin/client/holding`\n" }, { "info": { "name": "Get internal transfer history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/internal_transfer_history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "status", "value": "", "type": "query", "description": "`CREATED`/`PENDING`/`COMPLETED`/`FAILED`" }, { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "side", "value": "", "type": "query", "description": "`IN`/`OUT`" }, { "name": "from_account_id", "value": "", "type": "query" }, { "name": "to_account_id", "value": "", "type": "query" }, { "name": "main_sub_only", "value": "", "type": "query", "description": "If True, return only internal transfers between main account and sub accounts. \nIf False, return only internal transfers between main account and other main accounts. \nIf empty, return all transfer history.\n" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 10 requests per 1 seconds**\n\n`GET /v1/admin/internal_transfer_history`\n" }, { "info": { "name": "Get asset history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/asset/history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "token", "value": "", "type": "query", "description": "token name you want to search" }, { "name": "side", "value": "", "type": "query", "description": "`DEPOSIT`/`WITHDRAW`" }, { "name": "status", "value": "", "type": "query", "description": "`NEW`/`CONFIRM`/`PROCESSING`/`COMPLETED`/`FAILED`/`PENDING_REBALANCE`" }, { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/admin/asset/history`\n" }, { "info": { "name": "Get leverage setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/client/leverage", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "PERP_BTC_USDC", "type": "query" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 1 requests per 1 second per IP address**\n\n`GET /v1/admin/asset/history`\n" }, { "info": { "name": "Get orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/orders", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "PERP_ETH_USDC", "type": "query", "description": "Filter results to a specific trading symbol, for example `PERP_ETH_USDC`." }, { "name": "side", "value": "", "type": "query", "description": "`BUY`/`SELL`" }, { "name": "order_type", "value": "", "type": "query", "description": "`LIMIT`/`MARKET`" }, { "name": "status", "value": "", "type": "query", "description": "`NEW`/`CANCELLED`/`PARTIAL_FILLED`/`FILLED`/`REJECTED`/`INCOMPLETE`/`COMPLETED`" }, { "name": "order_tag", "value": "", "type": "query", "description": "Filter by a custom tag assigned to the order." }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query (max: 500)" }, { "name": "sort_by", "value": "", "type": "query", "description": "If empty: \n\nDescending order by updated_time if user passed update_start_t or update_end_t; descending order by order_id if updated_time are the same; \n\nOtherwise descending order by created_time; descending order by order_id if created_time are the same;\n\n\nIf not empty:\n\nIf sort_by == `CREATED_TIME_DESC`, descending order by created_time. Descending order by order_id if created_time are same;\n\nIf sort_by == `CREATED_TIME_ASC`, ascending order by created_time. Ascending order by order_id if created_time are same;\n\nIf sort_by == `UPDATED_TIME_DESC`, descending order by updated_time. Descending order by order_id if updated_time are same;\n\nIf sort_by == `UPDATED_TIME_ASC`, ascending order by updated_time. Ascending order by order_id if updated_time are same;\n" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/admin/orders`\n\nNote: This endpoint requires `trading` scope in orderly key.\n" }, { "info": { "name": "Get one position info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/position/:symbol", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "path" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 30 requests per 10 second per user**\n\n`GET /v1/admin/position/{symbol}`\n" }, { "info": { "name": "Get all positions info", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/positions", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 30 requests per 10 second per user**\n\n`GET /v1/admin/positions`\n" }, { "info": { "name": "Get funding fee history", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/funding_fee/history", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "PERP_ETH_USDC", "type": "query", "description": "omit to get funding fee history for all symbols" }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that you wish to query, noted that the time stamp is a 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that you wish to query, noted that the time stamp is a 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "Default: 60" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 20 requests per 60 second per user**\n\n`GET /v1/admin/funding_fee/history`\n" }, { "info": { "name": "Get user volume statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/volume/user/stats", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit 10 requests per 60 seconds**\n\n`GET /v1/admin/volume/user/stats`\n" }, { "info": { "name": "Get liquidated positions (admin)", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/liquidations", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "start_t", "value": "", "type": "query" }, { "name": "end_t", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "start from 1" }, { "name": "size", "value": "", "type": "query" }, { "name": "sort_by", "value": "", "type": "query", "description": "`liquidation_id`/`time`" }, { "name": "liquidation_id", "value": "", "type": "query", "description": "return the designed liquidation_id only" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 10 requests per 1 second per IP address**\n\n`GET /v1/admin/liquidations`\n\nGet liquidated positions for admin usage.\n" }, { "info": { "name": "Get algo orders (admin)", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/algo/orders", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "order_type", "value": "", "type": "query", "description": "`LIMIT`/`MARKET`" }, { "name": "status", "value": "", "type": "query", "description": "`NEW`/`CANCELLED`/`PARTIAL_FILLED`/`FILLED`/`REJECTED`/`INCOMPLETE`/`COMPLETED`" }, { "name": "order_tag", "value": "", "type": "query", "description": "Filter by a custom tag assigned to the order." }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query (max: 500)" }, { "name": "side", "value": "", "type": "query", "description": "`BUY`/`SELL`" }, { "name": "algo_type", "value": "", "type": "query", "description": "Supported types are `STOP`, `TPSL`, `positional_TPSL`" }, { "name": "is_triggered", "value": "", "type": "query" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 5 requests per 1 second**\n\n`GET /v1/admin/algo/orders`\n\nGet algo order details by customized filters for admin usage.\n" }, { "info": { "name": "Get trades (admin)", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/admin/trades", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query" }, { "name": "start_t", "value": "", "type": "query", "description": "start time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "end_t", "value": "", "type": "query", "description": "end time range that wish to query, noted the time stamp is 13-digits timestamp." }, { "name": "page", "value": "", "type": "query", "description": "the page you wish to query. start from 1" }, { "name": "size", "value": "", "type": "query", "description": "the page size you wish to query. (max: 500)" }, { "name": "user_account", "value": "", "type": "query", "description": "Target user account to query for admin usage, required for either user_account or user_address" }, { "name": "user_address", "value": "", "type": "query", "description": "Target user address to query for admin usage, required for either user_account or user_address" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/admin/trades`\n\nReturn client's trades history within a time range for admin usage.\n\nOnly return the latest 500 entries.\n" }, { "info": { "name": "Create order tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/broker/order_enum", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/broker/order_enum`\n\nCreate a new order tag fee config. The fee config identifier is `enum_id`; the order tag value sent on orders is `enum:`.\n" }, { "info": { "name": "Get single order tag with stats", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/broker/order_enum/:enum_id", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "enum_id", "value": "", "type": "path", "description": "Fee config ID (`enum_id`)" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/broker/order_enum/{enum_id}`\n\nGet a single order tag fee config with usage stats.\n" }, { "info": { "name": "Update order tag", "type": "http" }, "http": { "method": "PUT", "url": "https://api.orderly.org/v1/broker/order_enum/:enum_id", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "enum_id", "value": "", "type": "path", "description": "Fee config ID (`enum_id`)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`PUT /v1/broker/order_enum/{enum_id}`\n\nUpdate an order tag fee config. Cannot change `enum_id`.\n" }, { "info": { "name": "List all order tags for a builder", "type": "http" }, "http": { "method": "GET", "url": "https://api.orderly.org/v1/broker/order_enums", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "params": [ { "name": "symbol", "value": "", "type": "query", "description": "Filter by trading pair (e.g., `PERP_BTC_USDC`)" }, { "name": "enum_id", "value": "", "type": "query", "description": "Filter by fee config ID (`enum_id`, partial match supported)" }, { "name": "include_archived", "value": "", "type": "query", "description": "Include archived order tags in results (default: false)" } ] }, "docs": "**Limit: 10 requests per 1 second**\n\n`GET /v1/broker/order_enums`\n\nList all order tag fee configs for the broker with usage stats.\n" }, { "info": { "name": "Archive an order tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/broker/order_enum/archive", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/broker/order_enum/archive`\n\nArchive an order tag fee config.\n" }, { "info": { "name": "Unarchive an order tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.orderly.org/v1/broker/order_enum/unarchive", "headers": [ { "name": "orderly-timestamp", "value": "1649920583000" }, { "name": "orderly-account-id", "value": "6.858456565150415e+75" }, { "name": "orderly-key", "value": "ed25519:8tm7dnKYkSc3FzgPuJaw1wztr79eeZpN35nHW5pL5XhX" }, { "name": "orderly-signature", "value": "dG4bkKiqG0dUYLzViRZkvbI6Sy239JxAdNMIBxFZ4w030Jofr0ORV06GHtvXZkaZaWUXE+XAU3fnzKN/5fDeBQ==" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Limit: 1 request per second**\n\n`POST /v1/broker/order_enum/unarchive`\n\nUnarchive an order tag fee config.\n" } ] } ], "bundled": true }