# Ekiden Docs

- [Getting Started with Ekiden](https://docs.ekiden.fi/getting-started.md): Create your account, activate access, bridge funds to Canton, and fund your Trading Account.
- [Trading on Ekiden](https://docs.ekiden.fi/trade.md): Open and manage positions, set leverage and TP/SL, and use Portfolio, Stats, and Referral on Ekiden.
- [Introduction](https://docs.ekiden.fi/index.md)
- [Architecture](https://docs.ekiden.fi/architecture.md)
- [Fees](https://docs.ekiden.fi/fees.md): Ekiden is built for serious traders. Our fee structure is designed to reward both volume and liquidity. If you’re trading size or consistently making markets, you’ll benefit from lower costs and in many cases, get paid to provide liquidity.  Fees are calculated using a standard maker-taker model, wi…
- [VIP Program](https://docs.ekiden.fi/vip-program.md): Volume-based fee benefits and rewards for active Ekiden traders.
- [Earning XP](https://docs.ekiden.fi/points-program.md): Learn how XP is earned from trading, holding positions, referrals, multipliers, and quests.
- [How the Referral Program Works](https://docs.ekiden.fi/untitled-page.md): Learn how Mainnet invite codes, referral XP, and affiliate commissions work on Ekiden.
- [Untitled page 2](https://docs.ekiden.fi/untitled-page-2.md)
- [Untitled page 2](https://docs.ekiden.fi/untitled-page-2.md)
- [Introduction](https://docs.ekiden.fi/api-reference/introduction.md)
- [Conventions](https://docs.ekiden.fi/api-reference/conventions.md)
- [Rate Limits](https://docs.ekiden.fi/api-reference/rate-limits.md)
- [Installation](https://docs.ekiden.fi/api-reference/integration/installation.md)
- [Quick Start](https://docs.ekiden.fi/api-reference/integration/quick-start.md)
- [Configuration](https://docs.ekiden.fi/api-reference/integration/configuration.md): This section lists the available endpoint URLs for REST and WebSocket, helping you configure your client for seamless integration with Ekiden’s services.
- [Client Initialization](https://docs.ekiden.fi/api-reference/integration/initialization.md): Initialize the Ekiden TypeScript SDK to connect to the REST and WebSocket APIs.
- [API Authentication](https://docs.ekiden.fi/api-reference/integration/onboarding-auth.md)
- [Deposit & Withdraw Funds](https://docs.ekiden.fi/api-reference/integration/deposit-and-withdraw.md)
- [Market Data](https://docs.ekiden.fi/api-reference/integration/market-data.md)
- [Insurance Pool & ADL](https://docs.ekiden.fi/api-reference/integration/risk-feeds.md)
- [Orders](https://docs.ekiden.fi/api-reference/integration/orders.md)
- [Closing Positions](https://docs.ekiden.fi/api-reference/integration/closing-position.md)
- [Leverage](https://docs.ekiden.fi/api-reference/integration/adjust-the-leverage.md)
- [TP/SL, Triggers, and Reduce-Only](https://docs.ekiden.fi/api-reference/integration/tpsl.md)
- [Market Maker Integration Guide](https://docs.ekiden.fi/api-reference/integration/market-maker-integration.md)
- [Account Data](https://docs.ekiden.fi/api-reference/integration/account-data.md)
- [Account Statistics](https://docs.ekiden.fi/api-reference/integration/account-statistics.md)
- [Referrals & Rewards](https://docs.ekiden.fi/api-reference/integration/referrals-and-rewards.md)
- [Leaderboards & Competitions](https://docs.ekiden.fi/api-reference/integration/leaderboards-and-competitions.md)
- [PnL, Margin & Funding](https://docs.ekiden.fi/api-reference/integration/pnl-margin-fr.md)
- [Root Whitelist](https://docs.ekiden.fi/api-reference/integration/root-whitelist.md)
- [Troubleshooting & Best Practices](https://docs.ekiden.fi/api-reference/integration/troubleshooting.md): Common troubleshooting tips and integration best practices.
- [Activate a closed-launch access code](https://docs.ekiden.fi/api-reference/access/activate-a-closed-launch-access-code.md)
- [Get Account Balance](https://docs.ekiden.fi/api-reference/account/get-account-balance.md): Query account balances. Returns all subaccounts' vault balances.
- [Post apiv1accountfund](https://docs.ekiden.fi/api-reference/account/post-apiv1accountfund.md)
- [Get Account Statistics](https://docs.ekiden.fi/api-reference/account/get-account-statistics.md): Query account equity, PnL, volume, and ROI. Optional step: hour/day/week/month. Newest `limit` rows (default 100, max 1000).
- [Authorize User](https://docs.ekiden.fi/api-reference/user/authorize-user.md): Authorize and obtain an access token
- [Provision Canton OIDC Ledger User](https://docs.ekiden.fi/api-reference/user/provision-canton-oidc-ledger-user.md): Verify an OIDC id_token and ensure a Ledger API user/party exists for its `sub`
- [Get apiv1authorizewhitelistcheck](https://docs.ekiden.fi/api-reference/user/get-apiv1authorizewhitelistcheck.md)
- [Put apiv1authorizewhitelist](https://docs.ekiden.fi/api-reference/user/put-apiv1authorizewhitelist.md)
- [Delete apiv1authorizewhitelist](https://docs.ekiden.fi/api-reference/user/delete-apiv1authorizewhitelist.md)
- [Post apiv1referralclick](https://docs.ekiden.fi/api-reference/user/post-apiv1referralclick.md)
- [Get apiv1useraccess](https://docs.ekiden.fi/api-reference/user/get-apiv1useraccess.md)
- [Post apiv1useraccessactivate](https://docs.ekiden.fi/api-reference/user/post-apiv1useraccessactivate.md)
- [Get apiv1useraffiliate](https://docs.ekiden.fi/api-reference/user/get-apiv1useraffiliate.md)
- [Get apiv1userinvite codes](https://docs.ekiden.fi/api-reference/user/get-apiv1userinvite-codes.md)
- [Post apiv1userinvite codes](https://docs.ekiden.fi/api-reference/user/post-apiv1userinvite-codes.md)
- [Get apiv1userquests](https://docs.ekiden.fi/api-reference/user/get-apiv1userquests.md)
- [Post apiv1userquests claim](https://docs.ekiden.fi/api-reference/user/post-apiv1userquests-claim.md)
- [Get apiv1userreferral](https://docs.ekiden.fi/api-reference/user/get-apiv1userreferral.md)
- [Post apiv1userreferral](https://docs.ekiden.fi/api-reference/user/post-apiv1userreferral.md)
- [Get apiv1userreferral codes](https://docs.ekiden.fi/api-reference/user/get-apiv1userreferral-codes.md)
- [Post apiv1userreferral codes](https://docs.ekiden.fi/api-reference/user/post-apiv1userreferral-codes.md)
- [Delete apiv1userreferral codes](https://docs.ekiden.fi/api-reference/user/delete-apiv1userreferral-codes.md)
- [Get apiv1userrewards](https://docs.ekiden.fi/api-reference/user/get-apiv1userrewards.md)
- [Get Root Account](https://docs.ekiden.fi/api-reference/user/get-root-account.md): Return the Root Account address for the current user
- [`POST /user/season-claim/redeem` — verifies a season-claim voucher issued
by the testnet side and redeems it (merging the testnet root's XP into
the caller's mainnet account), or dry-runs the entitlement when
`preview` is set. Root-only, same as the issue side.](https://docs.ekiden.fi/api-reference/user/`post-userseason-claimredeem`-—-verifies-a-season-claim-voucher-issuedby-the-testnet-side-and-redeems-it-merging-the-testnet-roots-xp-intothe-callers-mainnet-account-or-dry-runs-the-entitlement-when`preview`-is-set-root-only-same-as-the-issue-side.md)
- [`POST /user/season-claim/voucher` — issues a short-lived, server-signed
voucher attesting the caller's testnet root address. Root-only: a signed
bearer proof of the wallet's identity is only meaningful for the wallet
that owns it.](https://docs.ekiden.fi/api-reference/user/`post-userseason-claimvoucher`-—-issues-a-short-lived-server-signedvoucher-attesting-the-callers-testnet-root-address-root-only:-a-signedbearer-proof-of-the-wallets-identity-is-only-meaningful-for-the-walletthat-owns-it.md)
- [Get Sub Accounts](https://docs.ekiden.fi/api-reference/user/get-sub-accounts.md): List Sub Accounts under the Root Account
- [Get apiv1competitions](https://docs.ekiden.fi/api-reference/competitions/get-apiv1competitions.md)
- [Get apiv1competitions 1](https://docs.ekiden.fi/api-reference/competitions/get-apiv1competitions-1.md)
- [Get apiv1competitions leaderboard](https://docs.ekiden.fi/api-reference/competitions/get-apiv1competitions-leaderboard.md)
- [Get Trade History](https://docs.ekiden.fi/api-reference/trade/get-trade-history.md): Query users' execution records, sorted by execTime in descending order.
- [Amend Order](https://docs.ekiden.fi/api-reference/trade/amend-order.md): Amend an existing order
- [Batch Amend Orders](https://docs.ekiden.fi/api-reference/trade/batch-amend-orders.md): Amend multiple existing orders in a single request
- [Cancel Order](https://docs.ekiden.fi/api-reference/trade/cancel-order.md): Cancel an existing order
- [Cancel All Orders](https://docs.ekiden.fi/api-reference/trade/cancel-all-orders.md): Cancel all existing orders for a sub-account. Optionally filtered by symbol; omit symbol to cancel open orders across all markets.
- [Batch Cancel Orders](https://docs.ekiden.fi/api-reference/trade/batch-cancel-orders.md): Cancel multiple existing orders in a single request
- [Get Order History](https://docs.ekiden.fi/api-reference/trade/get-order-history.md): Query order history. As order creation/cancellation is asynchronous, the data returned from this endpoint may delay.
- [Place Order](https://docs.ekiden.fi/api-reference/trade/place-order.md): Create a new order
- [Batch Place Orders](https://docs.ekiden.fi/api-reference/trade/batch-place-orders.md): Create multiple new orders in a single request
- [Get Open & Closed Orders](https://docs.ekiden.fi/api-reference/trade/get-open-&-closed-orders.md): Primarily query unfilled or partially filled orders in real-time, but also supports querying recent 500 closed status (Cancelled, Filled) orders. Please see the usage of request param open_only.
- [Get system configuration and discovery info](https://docs.ekiden.fi/api-reference/system/get-system-configuration-and-discovery-info.md)
- [Get Long Short Ratio](https://docs.ekiden.fi/api-reference/market/get-long-short-ratio.md): This refers to the net long and short positions as percentages of all position holders during the selected time. Long account ratio = Number of holders with long positions / Total number of holders Short account ratio = Number of holders with short positions / Total number of holders Long-short acco…
- [Get ADL Alerts](https://docs.ekiden.fi/api-reference/market/get-adl-alerts.md): Get the latest ADL alert snapshot for one symbol or all pools.
- [Get ADL Alert History](https://docs.ekiden.fi/api-reference/market/get-adl-alert-history.md): Get archived ADL alert snapshots for one symbol or all pools.
- [Get Funding Rate History](https://docs.ekiden.fi/api-reference/market/get-funding-rate-history.md): Query for historical funding rates. Each symbol has a different funding interval. For example, if the interval is 8 hours and the current time is UTC 12, then it returns the last funding rate, which settled at UTC 8.
- [Get Index Price Kline](https://docs.ekiden.fi/api-reference/market/get-index-price-kline.md): Query for historical index price klines. Charts are returned in groups based on the requested interval.
- [Get apiv1marketinstruments info](https://docs.ekiden.fi/api-reference/market/get-apiv1marketinstruments-info.md)
- [Get Insurance Pool](https://docs.ekiden.fi/api-reference/market/get-insurance-pool.md): Get the latest insurance pool snapshot for one symbol or all pools.
- [Get Insurance Pool History](https://docs.ekiden.fi/api-reference/market/get-insurance-pool-history.md): Get archived insurance pool snapshots for one symbol or all pools.
- [Get Kline](https://docs.ekiden.fi/api-reference/market/get-kline.md): Query for historical klines (also known as candles/candlesticks). Charts are returned in groups based on the requested interval.
- [Get Mark Price Kline](https://docs.ekiden.fi/api-reference/market/get-mark-price-kline.md): Query for historical mark price klines. Charts are returned in groups based on the requested interval.
- [Get Open Interest](https://docs.ekiden.fi/api-reference/market/get-open-interest.md): Get historical open interest snapshots for one symbol. Values are returned as closed interval buckets sorted newest first.
- [Get Orderbook](https://docs.ekiden.fi/api-reference/market/get-orderbook.md): Query for orderbook depth data.
- [Get Order Price Limit](https://docs.ekiden.fi/api-reference/market/get-order-price-limit.md): Query for order price limit parameters.
- [Get Recent Trades](https://docs.ekiden.fi/api-reference/market/get-recent-trades.md): Query for recent public trades, optionally filtered by symbol.
- [Get Risk Limit](https://docs.ekiden.fi/api-reference/market/get-risk-limit.md): Query for the risk limit margin parameters.
- [Get Stats](https://docs.ekiden.fi/api-reference/market/get-stats.md): Query for period-filtered turnover, trades, open interest, and per-market stats.
- [Get Stats Volume](https://docs.ekiden.fi/api-reference/market/get-stats-volume.md): Query for turnover time series and 24h/7d/30d/all_time aggregates.
- [Get Tickers](https://docs.ekiden.fi/api-reference/market/get-tickers.md): Query for the latest price snapshot, best bid/ask price, and trading volume in the last 24 hours.
- [Get Closed PnL](https://docs.ekiden.fi/api-reference/position/get-closed-pnl.md): Query user's closed profit and loss records
- [Get Position Info](https://docs.ekiden.fi/api-reference/position/get-position-info.md): Query real-time position data, such as position size, cumulative realized PNL, etc.
- [Set leverage](https://docs.ekiden.fi/api-reference/position/set-leverage.md): Set leverage for a symbol
- [Set Trading Stop](https://docs.ekiden.fi/api-reference/position/set-trading-stop.md): Set the take profit, stop loss or trailing stop for the position.
- [Get apiv1userapi keys](https://docs.ekiden.fi/api-reference/user/get-apiv1userapi-keys.md)
- [Post apiv1userapi keys](https://docs.ekiden.fi/api-reference/user/post-apiv1userapi-keys.md)
- [Delete apiv1userapi keys](https://docs.ekiden.fi/api-reference/user/delete-apiv1userapi-keys.md)
- [Get apiv1usercompetitions](https://docs.ekiden.fi/api-reference/user/get-apiv1usercompetitions.md)
- [Get apiv1usercompetitions leaderboard](https://docs.ekiden.fi/api-reference/user/get-apiv1usercompetitions-leaderboard.md)
- [Get apiv1usercompetitions placement](https://docs.ekiden.fi/api-reference/user/get-apiv1usercompetitions-placement.md)
- [Get Leaderboard](https://docs.ekiden.fi/api-reference/leaderboard/get-leaderboard.md): Paginated subaccount leaderboard ranked by PnL. Realized + unrealized (mark-to-market). Timeframe required: today, 7d, 30d, all. Default limit 10, max 100.
- [Get Leaderboard Placement](https://docs.ekiden.fi/api-reference/leaderboard/get-leaderboard-placement.md): Placement(s) for the authenticated user. When sub_account is omitted, returns one entry per user trading subaccount; otherwise exactly one entry. When the user has no trading subaccounts, data is an empty array. If the account is not ranked, ranked is false and place is "0".
- [Overview](https://docs.ekiden.fi/overview.md): Introduction to the Ekiden WebSocket API.
- [Connection](https://docs.ekiden.fi/connection.md): Connect to the Ekiden WebSocket API.
- [Authentication](https://docs.ekiden.fi/authentication.md)
- [Topics](https://docs.ekiden.fi/topics.md): Available WebSocket topics.
- [Message Format](https://docs.ekiden.fi/message-format.md): Overview of WebSocket message types and structure.
- [Public](https://docs.ekiden.fi/api-reference/websockets/public.md): Market data streams — order book, trades, tickers, klines.
- [Private](https://docs.ekiden.fi/api-reference/websockets/private.md): Account streams — orders, positions, executions, balances.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## AsyncAPI Specs

- [asyncapi](/api-reference/asyncapi.yaml)
- [asyncapi](/api-reference/websocket/asyncapi.json)
- [asyncapi](/api-reference/websocket/asyncapi.yaml)

## Optional

- [Documentation](https://docs.ekiden.fi)
- [Community](https://discord.gg/37682NeRb3)
- [Blog](https://medium.com/ekidenfi)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.