Account/User Info

#Account/User Info

These endpoints provide the authenticated account's activity, volume, fee, balance, configuration, and daily snapshot information.

#Authentication headers

All private endpoints on this page require the signed headers: orderly-timestamp (string, request-signing timestamp in milliseconds), orderly-account-id (string, authenticated account ID), orderly-key (string, public signing key), and orderly-signature (string, signature for the request payload).

#Get User Daily Volume

GET /v1/volume/user/daily
Mainnet: GET https://api.orderly.org/v1/volume/user/daily\\ Testnet: GET https://testnet-api.orderly.org/v1/volume/user/daily\\ Rate limit: 10 requests per 60 seconds.

Required query parameters: start_date and end_date (strings in YYYY-MM-DD format). HTTP 200 returns success, required data array containing daily perpetual-volume entries for the requested dates, and timestamp (server time in milliseconds).

#Get User Volume Statistics

GET /v1/volume/user/stats
Mainnet: GET https://api.orderly.org/v1/volume/user/stats\\ Testnet: GET https://testnet-api.orderly.org/v1/volume/user/stats\\ Rate limit: 10 requests per 60 seconds.

No query or path parameters. HTTP 200 returns success, data, and server timestamp. The numeric data fields are perp_volume_ytd, perp_volume_ltd, perp_volume_today, perp_volume_last_1_day, perp_volume_last_7_days, and perp_volume_last_30_days. These represent perpetual volume year to date, since launch, since 00:00 UTC, and over the trailing 1, 7, and 30 days, respectively.

{"success":true,"data":{"perp_volume_ytd":274148.0364,"perp_volume_ltd":274148.0364,"perp_volume_today":120272.7674,"perp_volume_last_1_day":120272.7674,"perp_volume_last_7_days":120272.7674,"perp_volume_last_30_days":300730.5454},"timestamp":1702989203989}

#Get User Statistics

GET /v1/client/statistics
Mainnet: GET https://api.orderly.org/v1/client/statistics\\ Testnet: GET https://testnet-api.orderly.org/v1/client/statistics\\ Rate limit: 10 requests per 60 seconds.

No query or path parameters. HTTP 200 returns required numeric fields in data: days_since_registration (integer), fees_paid_last_30_days, perp_fees_paid_last_30_days, perp_trading_volume_last_24_hours, perp_trading_volume_last_30_days, perp_trading_volume_ytd, trading_volume_last_24_hours, trading_volume_last_30_days, and trading_volume_ytd. Optional numeric values are perp_trading_volume_last_7_days and perp_trading_volume_ltd. The envelope also contains success and server timestamp.

#Get Account Overview Info

GET /v1/account_info
Mainnet: GET https://api.orderly.org/v1/account\\_info\\ Testnet: GET https://testnet-api.orderly.org/v1/account\\_info\\ Rate limit: 10 requests per second per user.

No query or path parameters. HTTP 200 returns required numeric values in data: current_margin_ratio_with_orders, free_collateral, initial_margin_ratio, initial_margin_ratio_with_orders, maintenance_margin_ratio, maintenance_margin_ratio_with_orders, margin_ratio, open_margin_ratio, total_collateral_value, account_value, and total_pnl_24h, plus success and server timestamp.

{"success":true,"data":{"current_margin_ratio_with_orders":1.2385,"free_collateral":450315.09115,"initial_margin_ratio":0.1,"initial_margin_ratio_with_orders":0.1,"maintenance_margin_ratio":0.05,"maintenance_margin_ratio_with_orders":0.05,"margin_ratio":1.2385,"open_margin_ratio":1.2102,"total_collateral_value":489865.71329,"account_value":500000,"total_pnl_24h":0},"timestamp":1702989203989}

#Get Account Information

GET /v1/client/info
Mainnet: GET https://api.orderly.org/v1/client/info\\ Testnet: GET https://testnet-api.orderly.org/v1/client/info\\ Rate limit: 10 requests per 60 seconds.

No query or path parameters. HTTP 200 returns required data fields: account_id (string), email (string), account_mode (string), max_leverage (number), taker_fee_rate, maker_fee_rate, futures_taker_fee_rate, futures_maker_fee_rate (numbers), maintenance_cancel_orders (boolean), and imr_factor (object keyed by symbol). Optional values include rwa_taker_fee_rate and rwa_maker_fee_rate (numbers), and max_notional (object keyed by symbol). The envelope also contains success and timestamp.

{"PERP_BTC_USDC":9.1e-8,"PERP_ETH_USDC":0.0000012345}

{"PERP_BTC_USDC":10000000,"PERP_ETH_USDC":2000000}

#Get User Daily Statistics

GET /v1/client/statistics/daily
Mainnet: GET https://api.orderly.org/v1/client/statistics/daily\\ Testnet: GET https://testnet-api.orderly.org/v1/client/statistics/daily\\ Rate limit: 10 requests per 60 seconds.

Required query parameters: start_date and end_date (strings, YYYY-MM-DD). Optional page and size (numbers) control pagination; page numbering starts at 1. Optional include_historical_data (boolean): when true, archived records are included and the rate limit becomes 1 request per 60 seconds.

HTTP 200 returns required data.rows. Each row includes account_value (number), date (string, YYYY-MM-DD), perp_volume (number), pnl (number), and snapshot_time (number, snapshot-generation time in milliseconds). The response also includes success and server timestamp.

{"success":true,"data":{"rows":[{"account_value":456789.12,"date":"2023-09-14","perp_volume":451580.9523,"pnl":123.45,"snapshot_time":1722989203989}]},"timestamp":1702989203989}