llms-full.txt

# Orderly Network

> Orderly is an omnichain orderbook-based trading infrastructure providing perpetual futures liquidity for decentralized exchanges.

API Base: `https://api.orderly.org/` (Mainnet), `https://testnet-api.orderly.org` (Testnet). Authentication uses ed25519 signatures. Symbol format: PERP_<TOKEN>_USDC.

This file is a full documentation index. Use the source links to retrieve page details when needed.

## For AI agents

Prefer the hosted Orderly MCP server over fetching individual doc pages — it serves the Orderly docs as structured, searchable tools (docs search, code patterns, contract addresses, workflows, and API reference). The links in this file are a fallback index for when the MCP is unavailable.

- MCP endpoint (Streamable HTTP, no auth, no install): `https://mcp.orderly.network`
- Local install alternative: `npx @orderly.network/mcp-server init --client <client>`
- Onboarding skill (read this first): https://raw.githubusercontent.com/OrderlyNetwork/skills/refs/heads/master/skills/orderly-onboarding/SKILL.md
- Install all Orderly agent skills: `npx skills add OrderlyNetwork/skills --all --agent '*' -g`

MCP tools available:
- `search_orderly_docs` — search docs and type-accurate SDK symbols
- `get_contract_addresses` — contract addresses per chain and network
- `explain_workflow` — step-by-step workflows (wallet-connection, place-first-order, deposit-withdraw, subaccount-management)
- `get_api_info` — REST, WebSocket, and auth endpoint details
- `get_indexer_api_info` — Indexer API (trading metrics, events, rankings)
- `get_component_guide` — React UI component build guides
- `get_orderly_one_api_info` — Orderly One API (DEX creation, graduation, management)
- `get_strategy_vault_api_info` — Strategy Vault API (yield strategies and providers)
- `get_public_info_api_info` — zero-auth Public Info API (market and account data)

Base facts: API mainnet `https://api.orderly.org`, testnet `https://testnet-api.orderly.org`. WebSocket `wss://ws.orderly.org/ws`. Symbol format `PERP_<TOKEN>_USDC`. Authentication uses ed25519 signatures.

## Home

### Home

- [Orderly Home Page](https://orderly.network/docs/home): Orderly documentation landing page with navigation to integration guides, API references, SDKs, Strategy Vault docs, troubleshooting, and release notes.

## Introduction

### Getting started

- [What is Orderly?](https://orderly.network/docs/introduction/getting-started/what-is-orderly): Discover what Orderly is, who it is for, and how to get started with the documentation.
- [Product Roadmap](https://orderly.network/docs/introduction/getting-started/roadmap): Explore Orderly's 2026 H1 product roadmap, covering growth, trading capabilities, platform upgrades, and vault expansion.
- [Builder Onboarding](https://orderly.network/docs/introduction/getting-started/builder-onboarding): Learn how to become a Builder on Orderly, choose a launch path, set up your builder profile, and move into implementation.

### $ORDER tokenomics

- [Overview of $ORDER](https://orderly.network/docs/introduction/tokenomics/overview-of-order): Discover what the $ORDER token is and its role within the Orderly Network ecosystem.
- [Distribution and Emission Schedule](https://orderly.network/docs/introduction/tokenomics/distribution-and-emission-schedule): Explore the $ORDER token distribution breakdown and its emission schedule.

#### $ORDER staking

- [Staking](https://orderly.network/docs/introduction/tokenomics/order-staking/staking): Follow this step-by-step guide to staking $ORDER or esORDER, managing unstaking, and claiming rewards.
- [Staking Information](https://orderly.network/docs/introduction/tokenomics/order-staking/staking-information): Learn how $ORDER staking works, including VALOR mechanics and the treasury share model.

- [esORDER](https://orderly.network/docs/introduction/tokenomics/esorder): Learn how esORDER works, including staking benefits and vesting redemption schedules.
- [$ORDER Related Smart Contract Addresses](https://orderly.network/docs/introduction/tokenomics/addresses): Find smart contract addresses for the $ORDER token across all supported chains.

### Markets & trading

- [Trade on Orderly](https://orderly.network/docs/introduction/trade-on-orderly/trade-on-orderly): Get an overview of trading on Orderly Network, featuring shared liquidity and omnichain access.
- [Orderly Orderbook Design](https://orderly.network/docs/introduction/trade-on-orderly/trading-basics/orderbook-design): Learn how Orderly's central limit order book combines CEX-level performance with on-chain settlement.

#### Trading basics

- [Glossary](https://orderly.network/docs/introduction/trade-on-orderly/trading-basics/glossary): Review definitions of key trading terms used across Orderly, from order book to ADL.
- [Perpetual Futures Trading](https://orderly.network/docs/introduction/trade-on-orderly/trading-basics/perpetual-futures): Get an introduction to perpetual futures trading, leverage, and settlement on Orderly.
- [Accounts](https://orderly.network/docs/introduction/trade-on-orderly/trading-basics/accounts): Explore the account structure and how it works within the Orderly Network ecosystem.
- [Order Types](https://orderly.network/docs/introduction/trade-on-orderly/trading-basics/order-types): Discover the supported order types on Orderly, including Market, Limit, and execution rules.
- [Trading fees](https://orderly.network/docs/introduction/trade-on-orderly/trading-basics/trading-fees): Understand the fee structure for traders and the Builder Staking programme.

#### Perpetual futures basics

- [Formulas and Definitions](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/formulas-definitions): Explore the formulas for margin, collateral, PnL, and liquidation price calculations on Orderly.
- [Margin, Leverage & PnL](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/margin-leverage-and-pnl): Explore notional value, margin ratio, leverage tiers, and unrealized PnL on Orderly.
- [Isolated Margin](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/isolated-margin): Discover how Isolated Margin mode works on Orderly, including per-position risk isolation.
- [Mark Price, Index Price, and Last Price](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/mark-price-index-price-and-last-price): Learn how Orderly computes Mark Price, Index Price, and Last Price with manipulation safeguards.
- [Order Price Limit](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/orders-price-limits): Understand the price range limits enforced on futures orders to prevent manipulation.
- [Funding Rate](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/funding-rate): Learn how funding rates are calculated and settled between long and short traders.
- [Liquidations](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/liquidations): Understand how Orderly triggers and processes liquidations when margin falls below the threshold.
- [Insurance Fund & ADL](https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/insurance-fund-and-adl): Understand how the Orderly Insurance Fund protects against insolvency during liquidations.

- [Supported Markets](https://orderly.network/docs/introduction/trade-on-orderly/supported-markets): See the full list of perpetual futures markets available on Orderly, including contract identifiers.
- [Permissionless Vault](https://orderly.network/docs/introduction/trade-on-orderly/permissionless-vault): Learn how anyone can create and manage a Strategy Vault on Orderly without permission or manual onboarding.
- [Supported Chains](https://orderly.network/docs/introduction/trade-on-orderly/supported-chains): Explore the list of supported chains on Orderly Network.
- [Multi-Collateral](https://orderly.network/docs/introduction/trade-on-orderly/multi-collateral): Understand supported collateral types, deposit caps, discount rates, and cross-chain rules.
- [Builders](https://orderly.network/docs/introduction/trade-on-orderly/builders): Discover how to shape the future of DeFi with Orderly.
- [Emergency Exit — Offboarding Tool](https://orderly.network/docs/introduction/trade-on-orderly/emergency-exit-offboarding-tool): A simple and quick tool for closing all positions and withdrawing funds from Orderly Network DEXs.

### Affiliate program

- [Orderly DEX's Affiliate Program (Affiliate's Quick Guide)](https://orderly.network/docs/introduction/be-a-broker/orderly-dex-affiliate-program-affiliates-quick-guide): Learn how affiliates can earn commission and manage a multilevel referral network.
- [Orderly DEX's Affiliate Program (Builder's Quick Guide)](https://orderly.network/docs/introduction/be-a-broker/orderly-dex-affiliate-program-brokers-quick-guide): Learn how builders can set up and manage the Orderly DEX Affiliate Program.
- [Affiliate & Referral Program (Legacy)](https://orderly.network/docs/introduction/be-a-broker/affiliate-referral-program): Explore the legacy documentation for the Orderly referral ecosystem for Builders, Affiliates, and Traders.

### Builder programs

- [Orderly One Builder Guidelines](https://orderly.network/docs/introduction/orderly-one/builder-guidelines): Review the responsibilities, expectations, and best practices for builders launching DEXs with Orderly One.
- [Supplemental Terms for Front-End DEXes](https://orderly.network/docs/introduction/orderly-one/supplemental-terms-for-dexes): Understand the supplemental legal terms for developers building and operating Front-End DEXes on Orderly.
- [Orderly Distributor Program](https://orderly.network/docs/introduction/orderly-one/vanguard-distributor-program): Learn about the tiered revenue-sharing program that incentivizes distributors to onboard new builders.

### Security, legal & FAQ

- [FAQ](https://orderly.network/docs/introduction/faqs): Find answers to frequently asked questions about Orderly Network, covering supported chains, fees, and key concepts.
- [Delisting Standards](https://orderly.network/docs/introduction/delisting-standards): Learn about the criteria and metrics Orderly uses to evaluate and delist underperforming perpetual futures markets.
- [Security](https://orderly.network/docs/introduction/security): Explore the audit history, governance model, and security measures that protect the Orderly protocol.
- [Terms of Service](https://orderly.network/docs/introduction/terms-of-service): Review the legal terms governing the use of Orderly Network services, including user obligations and restrictions.
- [Privacy Policy](https://orderly.network/docs/introduction/privacy-policy): Read the Orderly Network privacy policy to understand how user data is collected, used, and shared.

## Build on Omnichain

### Builder quickstart

- [Building on Orderly](https://orderly.network/docs/build-on-omnichain/building-on-omnichain): Start building your dApp on Orderly's omnichain trading infrastructure.
- [Smart Contract Overview](https://orderly.network/docs/build-on-omnichain/overview): Visualize the interaction between Orderly smart contracts for deposits, trades, and PnL.
- [Smart Contract Addresses](https://orderly.network/docs/build-on-omnichain/addresses): Smart contract addresses for Orderly vault, USDC, and Verifier on each supported chain (mainnet and testnet).
- [Integration Checklist](https://orderly.network/docs/build-on-omnichain/integration-checklist): A structured guide for builders integrating with Orderly Network.

### Partner onboarding & support

- [Partner Support](https://orderly.network/docs/build-on-omnichain/partner-support): Technical support and resources for builders integrating with Orderly Network.
- [Integration FAQs](https://orderly.network/docs/build-on-omnichain/integration-faqs): Frequently asked questions for builders integrating with Orderly Network.

### Core integration flows

- [Accounts](https://orderly.network/docs/build-on-omnichain/user-flows/accounts): Learn how to register user accounts, manage account states, and map wallets to builders on Orderly.
- [Wallet Authentication](https://orderly.network/docs/build-on-omnichain/user-flows/wallet-authentication): Authenticate wallets and manage Orderly Keys for secure API access.
- [Deposit/Withdrawal](https://orderly.network/docs/build-on-omnichain/user-flows/withdrawal-deposit): Implement secure cross-chain deposits and withdrawals with step-by-step smart contract and API integration guides.
- [Exclusive Receiver Address](https://orderly.network/docs/build-on-omnichain/user-flows/deposit-by-transfer): Each account gets a unique deposit address — users can fund their perp account by simply transferring supported tokens, with no wallet connection, gas, or contract interaction required.
- [Settle PnL](https://orderly.network/docs/build-on-omnichain/user-flows/settle-pnl): Learn how to settle realized and unrealized PnL into USDC balances via the Orderly API.
- [Order Management](https://orderly.network/docs/build-on-omnichain/user-flows/order-management): How orders flow through Orderly's architecture, from placement to execution and settlement.
- [Isolated Margin](https://orderly.network/docs/build-on-omnichain/user-flows/isolated-margin): Step-by-step guide to integrating Isolated Margin: setting leverage, placing orders, and adjusting position margin.
- [Custom Fee Structure](https://orderly.network/docs/build-on-omnichain/user-flows/custom-fees): How builders configure custom maker/taker fee structures for their users on top of Orderly base fees.
- [Custom Trading Fee Per Order](https://orderly.network/docs/build-on-omnichain/user-flows/order-enum-integration-guide): Create, discover, apply, and reconcile broker-scoped custom trading fees for individual orders.
- [Delegate Signer](https://orderly.network/docs/build-on-omnichain/user-flows/delegate-signer): How smart contracts trade on Orderly using the delegate signer pattern to bypass EOA-only signing.
- [Algo Order Sample Requests](https://orderly.network/docs/build-on-omnichain/user-flows/algo-order-samples): Sample API request payloads for creating STOP, TP/SL, Positional TP/SL, and Bracket algo orders.
- [Internal Transfer](https://orderly.network/docs/build-on-omnichain/user-flows/internal-transfer): Discover how to perform internal transfers between accounts and sub-accounts using wallet-signed requests.
- [User Flow Walkthrough](https://orderly.network/docs/build-on-omnichain/user-flow-walkthrough): End-to-end walkthrough of Orderly account creation, key management, ordering, and settlement via the API.

### Perp Anything

- [Introduction](https://orderly.network/docs/build-on-omnichain/perp-anything/introduction): Understand how Perp Anything lets Builders launch and operate perpetual markets within Orderly's supported risk controls.
- [Market Operations](https://orderly.network/docs/build-on-omnichain/perp-anything/market-operations): Prepare, launch, monitor, and operate Perp Anything markets with isolated risk and Builder-owned liquidity.
- [Builder Oracle](https://orderly.network/docs/build-on-omnichain/user-flows/builder-oracle): Create and operate Builder-pushed or Bring Your Own Key price sources, then use them in Perp Anything markets.
- [RWA Markets](https://orderly.network/docs/build-on-omnichain/perp-anything/rwa-markets): Configure supported real-world asset markets, market sessions, and closed-market behavior in Perp Anything.
- [Pre-TGE Listing](https://orderly.network/docs/build-on-omnichain/perp-anything/pre-tge-listing): Learn how Builders can list a perpetual market on a token before its TGE, using a synthetic Pre-TGE Oracle price and tightened risk caps.

### Builders Marketplace

- [Introduction](https://orderly.network/docs/build-on-omnichain/builder-marketplace/introduction): The Builders Marketplace: install, build, and publish modules and apps on Orderly.

#### Plugin Developer Handbook

- [Orderly Plugin Developer Handbook](https://orderly.network/docs/build-on-omnichain/builder-marketplace/plugin-developer-handbook): This handbook explains how to build, integrate, and publish Orderly SDK plugins using the devkit CLI (@orderly.network/devkit), the Orderly SDK Docs MCP serv...
- [Getting started](https://orderly.network/docs/build-on-omnichain/builder-marketplace/getting-started): Follow this path once per machine or project. Estimated time: 15–20 minutes.
- [Skills-first workflow (recommended)](https://orderly.network/docs/build-on-omnichain/builder-marketplace/skills-first): This is the recommended way to work with the Orderly SDK for plugin authoring, integration, and Marketplace submission, especially when you use an AI coding ...

##### Tutorials

- [Tutorial 1: First plugin from the template](https://orderly.network/docs/build-on-omnichain/builder-marketplace/first-plugin): Goal: Scaffold a plugin and make one visible change on a single interceptor target that exists in the SDK.
- [Tutorial 2: Integrate a plugin into the host app](https://orderly.network/docs/build-on-omnichain/builder-marketplace/integrate-host): Goal: Load an existing plugin package through OrderlyAppProvider’s plugins prop.
- [Tutorial 3: Submit a plugin to the Orderly Builders Marketplace](https://orderly.network/docs/build-on-omnichain/builder-marketplace/marketplace-submission): Goal: Authenticate with the devkit, validate a local plugin folder, and submit it for Marketplace review.
- [Tutorial 4: One plugin, multiple interceptor targets](https://orderly.network/docs/build-on-omnichain/builder-marketplace/multi-interceptor-targets): Register one plugin that intercepts more than one injector target so the same feature can appear in several UI surfaces.

##### How-to guides

- [How to choose a plugin type: Widget, Page, or Layout](https://orderly.network/docs/build-on-omnichain/builder-marketplace/plugin-types): | Type | Mechanism | Typical integration | | ---------- | --------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | Page | Ordinary React page using SDK UI + hoo...
- [How to implement interceptor strategies](https://orderly.network/docs/build-on-omnichain/builder-marketplace/interceptor-strategies): Interceptor entries use:
- [How to wire plugin packages in a host (workspace, path, npm)](https://orderly.network/docs/build-on-omnichain/builder-marketplace/host-integration-patterns): Use the pattern that matches your repository layout.
- [How to write `usagePrompt` and the GitHub README](https://orderly.network/docs/build-on-omnichain/builder-marketplace/usage-prompt-and-readme): Guide for how to write `usageprompt` and the github readme

##### Reference

- [CLI reference (`orderly-devkit`)](https://orderly.network/docs/build-on-omnichain/builder-marketplace/cli-reference): Package: @orderly.network/devkit. Binary: orderly-devkit.
- [Interceptor targets: runtime vs CLI template](https://orderly.network/docs/build-on-omnichain/builder-marketplace/interceptors): Guide for interceptor targets: runtime vs cli template
- [Runtime injector targets (handbook reference)](https://orderly.network/docs/build-on-omnichain/builder-marketplace/runtime-injector-targets): Interceptor target strings must match the SDK exactly (case-sensitive).
- [Manifest and Builders Marketplace submit](https://orderly.network/docs/build-on-omnichain/builder-marketplace/manifest-and-submit): Aligned with @orderly.network/devkit submit, update, and manifest wiring (see the published package for source filenames).
- [Orderly SDK Docs MCP (`orderly-sdk-docs`)](https://orderly.network/docs/build-on-omnichain/builder-marketplace/mcp-sdk-docs): Runtime npm package: @orderly.network/sdk-docs. MCP server binary: orderly-sdk-docs-mcp (stdio), commonly installed via orderly-devkit mcp install.
- [Agent skills and upstream documentation alignment](https://orderly.network/docs/build-on-omnichain/builder-marketplace/agent-skills-alignment): Orderly publishes agent skills (install via orderly-devkit skills install) for orderly-plugin-create, orderly-plugin-write, orderly-plugin-add, orderly-plugi...

##### Recipes

- [Recipe: Quick start checklist](https://orderly.network/docs/build-on-omnichain/builder-marketplace/quickstart-recipe): 1. pnpm add -g @orderly.network/devkit (or pnpm dlx @orderly.network/devkit --help).
- [Recipe: Marketplace submit checklist](https://orderly.network/docs/build-on-omnichain/builder-marketplace/marketplace-submit-recipe): 1. Ensure package.json name and GitHub origin (or .orderly-manifest.json repoUrl) are correct.



### API fundamentals

- [Introduction](https://orderly.network/docs/build-on-omnichain/introduction): Orderly API overview covering REST and WebSocket endpoints, authentication, and request conventions.
- [API Authentication](https://orderly.network/docs/build-on-omnichain/api-authentication): Implement secure request signing for the Orderly API using the ed25519 standard.
- [Error Codes](https://orderly.network/docs/build-on-omnichain/error-codes): Complete list of Orderly API error codes with HTTP status codes and descriptions.

### Public Info API

- [Introduction](https://orderly.network/docs/build-on-omnichain/public-info-api/overview): Zero-auth, single-endpoint query API for AI agents, quant traders, and analytics. POST /v1/public/query with a type field — covers market, account, and platform data.

#### Market data

- [Candles](https://orderly.network/docs/build-on-omnichain/public-info-api/market/candles): OHLCV kline series for a symbol and interval. Paginated by timestamp.
- [Funding comparison](https://orderly.network/docs/build-on-omnichain/public-info-api/market/funding-comparison): Cross-exchange funding rate comparison: last value plus 1d / 7d / 30d averages per symbol.
- [Funding rate history](https://orderly.network/docs/build-on-omnichain/public-info-api/market/funding-rate-history): Historical 8-hour funding rate and mark-price snapshots for a symbol.
- [Liquidations](https://orderly.network/docs/build-on-omnichain/public-info-api/market/liquidations): Recent liquidation events with position size, mark price, and account info.
- [Market detail](https://orderly.network/docs/build-on-omnichain/public-info-api/market/market-detail): Composite single-symbol bundle: market info, orderbook, recent trades, funding history, and candles in one call.
- [Market summary](https://orderly.network/docs/build-on-omnichain/public-info-api/market/market-summary): Multi-symbol snapshot of prices, funding, 24h volume, and open interest. Fast path when called with no symbols.
- [Market trades](https://orderly.network/docs/build-on-omnichain/public-info-api/market/market-trades): Recent taker-side trades for a symbol with address / account / broker enrichment for whale lookup.
- [Orderbook](https://orderly.network/docs/build-on-omnichain/public-info-api/market/orderbook): Orderbook snapshot with mid price and spread.

#### Account data

- [Account state](https://orderly.network/docs/build-on-omnichain/public-info-api/account/account-state): Account snapshot: collateral, open positions, margin metrics, and PnL. Response shape changes based on whether account_id is supplied.
- [Accounts](https://orderly.network/docs/build-on-omnichain/public-info-api/account/accounts): Discover all (broker, account) pairs an address controls. Includes regular and sub accounts.
- [Agent context](https://orderly.network/docs/build-on-omnichain/public-info-api/account/agent-context): Agent startup bundle: account state, open positions, held-symbol market summaries, and open order count in one parallelized call.
- [Fee rate](https://orderly.network/docs/build-on-omnichain/public-info-api/account/fee-rate): Fee tier, maker / taker rates, and 30-day rolling volume. Three response shapes based on params.
- [Funding payments](https://orderly.network/docs/build-on-omnichain/public-info-api/account/funding-payments): Funding-fee payment history with payment direction and settlement status.
- [Historical orders](https://orderly.network/docs/build-on-omnichain/public-info-api/account/historical-orders): Order history filtered by closed status (FILLED / CANCELLED / REJECTED). Auto-queries live and archive tables across the 92-day cutover.
- [Open orders](https://orderly.network/docs/build-on-omnichain/public-info-api/account/open-orders): Open and partially-filled orders (ordinary + algo) for an address, sorted DESC by created time.
- [Order status](https://orderly.network/docs/build-on-omnichain/public-info-api/account/order-status): Single order lookup by order_id. Searches live and archive tables; cross-references algo metadata.
- [Portfolio](https://orderly.network/docs/build-on-omnichain/public-info-api/account/portfolio): Daily account-value time series with cumulative PnL. UTC-day-aligned snapshots.
- [Position context](https://orderly.network/docs/build-on-omnichain/public-info-api/account/position-context): Single-symbol view: position, open orders for that symbol, market snapshot, and account risk summary — in one parallelized call.
- [Trades](https://orderly.network/docs/build-on-omnichain/public-info-api/account/trades): Trade fills (executed order fills) for an address. Combines a real-time window with an archive window so older history stays queryable.
- [Deposits and withdrawals](https://orderly.network/docs/build-on-omnichain/public-info-api/account/user-deposits-withdrawals): Deposit and withdrawal transaction history for an address, paginated DESC by transaction ID.
- [Whale context](https://orderly.network/docs/build-on-omnichain/public-info-api/account/whale-context): Whale research bundle: account state, open positions, and recent trades for an address in one call.

#### Platform data

- [Platform positions](https://orderly.network/docs/build-on-omnichain/public-info-api/platform/platform-positions): Platform-wide open-position snapshot across all users. Powers liquidation heatmaps and cross-account risk views.
- [Top addresses](https://orderly.network/docs/build-on-omnichain/public-info-api/platform/top-addresses): Leaderboard of addresses by notional / volume / PnL / trade count, with multi-window stats.


### General API

#### Builder info

- [Get Builder Volume](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-builder-volume): [GET /v1/public/volume/stats] Get builder volume
- [Get Builder List](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-builder-list): [GET /v1/public/broker/name] Get builder list
- [Get Builder Stats](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-builder-stats): [GET /v1/public/broker/stats] Get builder stats
- [Get Supported Chains Per Builder](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-supported-chains-per-builder): [GET /v1/public/chain_info] Get supported chains per builder
- [Get Market Volume By Builder](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-market-volume-by-builder): [GET /v1/public/futures_market] Get market volume by builder
- [Get Tvl By Builder](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-tvl-by-builder): [GET /v1/public/balance/stats] Get TVL by builder

#### System info

- [Get System Maintenance Status](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-system-maintenance-status): [GET /v1/public/system_info] Get system maintenance status
- [Get Vault Balance](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-vault-balance): [GET /v1/public/vault_balance] Get vault balance
- [Get Insurance Fund Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-insurance-fund-info): [GET /v1/public/insurancefund] Get insurance fund info
- [Get Announcements](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-announcements): [GET /v1/public/announcement] Get announcements
- [Get Ip Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-ip-info): [GET /v1/ip_info] Get IP info

#### USDC faucet

- [Get Faucet Usdctestnet Only](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-faucet-usdctestnet-only): [POST /v1/faucet/usdc] Get faucet usdc(testnet only)


### User API

#### Registration

- [Check If Account Exists](https://orderly.network/docs/build-on-omnichain/restful-api/public/check-if-account-exists): [GET /v1/public/account] Check if account exists
- [Check If Wallet Is Registered](https://orderly.network/docs/build-on-omnichain/restful-api/public/check-if-wallet-is-registered): [GET /v1/get_account] Check if wallet is registered
- [Check If Address Is Registered](https://orderly.network/docs/build-on-omnichain/restful-api/public/check-if-address-is-registered): [GET /v1/get_broker] Check if address is registered
- [Get Registration Nonce](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-registration-nonce): [GET /v1/registration_nonce] Get registration nonce
- [Register Account](https://orderly.network/docs/build-on-omnichain/restful-api/public/register-account): [POST /v1/register_account] Register account

#### Key management

- [Get Orderly Key](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-orderly-key): [GET /v1/get_orderly_key] Get Orderly key
- [Add Orderly Key](https://orderly.network/docs/build-on-omnichain/restful-api/public/add-orderly-key): [POST /v1/orderly_key] Add Orderly key
- [Remove Orderly Key](https://orderly.network/docs/build-on-omnichain/restful-api/private/remove-orderly-key): [POST /v1/client/remove_orderly_key] Remove Orderly key
- [Get Current Orderly Key Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-current-orderly-key-info): [GET /v1/client/key_info] Get current Orderly key info
- [Get Orderly Key Ip Restriction](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-orderly-key-ip-restriction): [GET /v1/client/orderly_key_ip_restriction] Get Orderly key IP restriction
- [Set Orderly Key Ip Restriction](https://orderly.network/docs/build-on-omnichain/restful-api/private/set-orderly-key-ip-restriction): [POST /v1/client/set_orderly_key_ip_restriction] Set Orderly key IP restriction
- [Reset Orderly Key Ip Restriction](https://orderly.network/docs/build-on-omnichain/restful-api/private/reset-orderly-key-ip-restriction): [POST /v1/client/reset_orderly_key_ip_restriction] Reset Orderly key IP restriction

#### Account/user info

- [Get User Daily Volume](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-user-daily-volume): [GET /v1/volume/user/daily] Get user daily volume
- [Get User Volume Statistics](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-user-volume-statistics): [GET /v1/volume/user/stats] Get user volume statistics
- [Get User Statistics](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-user-statistics): [GET /v1/client/statistics] Get user statistics
- [Get Account Overview Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-account-overview-info): [GET /v1/account_info] Get account overview info
- [Get Account Information](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-account-information): [GET /v1/client/info] Get account information
- [Get User Daily Statistics](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-user-daily-statistics): [GET /v1/client/statistics/daily] Get user daily statistics

#### Account notifications

- [Get All Notifications](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-all-notifications): [GET /v1/notification/inbox/notifications] Get all notifications
- [Get Unread Notifications](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-unread-notifications): [GET /v1/notification/inbox/unread] Get unread notifications
- [Set Read Status Of Notifications](https://orderly.network/docs/build-on-omnichain/restful-api/private/set-read-status-of-notifications): [POST /v1/notification/inbox/mark_read] Set read status of notifications
- [Set Read Status Of All Notifications](https://orderly.network/docs/build-on-omnichain/restful-api/private/set-read-status-of-all-notifications): [POST /v1/notification/inbox/mark_read_all] Set read status of all notifications

#### Account config

- [Get Leverage Setting](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-leverage-setting): [GET /v1/client/leverage] Get leverage setting
- [Get All Leverage Settings](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-all-leverage-settings): [GET /v1/client/leverages] Get all leverage settings
- [Update Leverage Setting](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-leverage-setting): [POST /v1/client/leverages] Update leverage setting
- [Get Margin Modes](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-margin-modes): [GET /v1/client/margin_modes] Get margin modes
- [Update Margin Mode](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-margin-mode): [POST /v1/client/margin_mode] Update margin mode
- [Add Or Reduce Position Margin](https://orderly.network/docs/build-on-omnichain/restful-api/private/add-or-reduce-position-margin): [POST /v1/position_margin] Add or reduce position margin
- [Get Max Leverage Setting](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-max-leverage-setting): [GET /v1/public/leverage] Get max leverage setting
- [Get Leverage Configuration](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-leverage-configuration): [GET /v1/public/config] Get leverage configuration
- [Configure Auto Cancel During Maintenance](https://orderly.network/docs/build-on-omnichain/restful-api/private/configure-auto-cancel-during-maintenance): [POST /v1/client/maintenance_config] Configure auto-cancel during maintenance

#### Delegate signer

- [Delegate Signer](https://orderly.network/docs/build-on-omnichain/restful-api/public/delegate-signer): [POST /v1/delegate_signer] Delegate signer
- [Add Delegate Signer Orderly Key](https://orderly.network/docs/build-on-omnichain/restful-api/public/add-delegate-signer-orderly-key): [POST /v1/delegate_orderly_key] Add delegate signer Orderly key
- [Delegate Signer Settle Pnl](https://orderly.network/docs/build-on-omnichain/restful-api/private/delegate-signer-settle-pnl): [POST /v1/delegate_settle_pnl] Delegate signer settle PnL
- [Delegate Signer Withdraw Request](https://orderly.network/docs/build-on-omnichain/restful-api/private/delegate-signer-withdraw-request): [POST /v1/delegate_withdraw_request] Delegate signer withdraw request

#### Sub-account

- [Add Sub Account](https://orderly.network/docs/build-on-omnichain/restful-api/private/add-sub-account): [POST /v1/client/add_sub_account] Add sub account
- [Get Sub Account List](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-sub-account-list): [GET /v1/client/sub_account] Get sub account list
- [Update Sub Account](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-sub-account): [POST /v1/client/update_sub_account] Update sub account
- [Get Aggregate Positions](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-aggregate-positions): [GET /v1/client/aggregate/positions] Get aggregate positions
- [Get Aggregate Holding](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-aggregate-holding): [GET /v1/client/aggregate/holding] Get aggregate holding
- [Settle Sub Account Pnl](https://orderly.network/docs/build-on-omnichain/restful-api/private/settle-sub-account-pnl): [POST /v1/sub_account_settle_pnl] Settle sub account PnL


### Trading API

#### Order management

- [Create Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-order): [POST /v1/order] Create order
- [Batch Create Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/batch-create-order): [POST /v1/batch-order] Batch create order
- [Create Algo Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-algo-order): [POST /v1/algo/order] Create algo order
- [Edit Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/edit-order): [PUT /v1/order] Edit order
- [Edit Algo Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/edit-algo-order): [PUT /v1/algo/order] Edit algo order
- [Cancel Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/cancel-order): [DELETE /v1/order] Cancel order
- [Cancel Algo Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/cancel-algo-order): [DELETE /v1/algo/order] Cancel algo order
- [Cancel Order By Client Order Id](https://orderly.network/docs/build-on-omnichain/restful-api/private/cancel-order-by-client_order_id): [DELETE /v1/client/order] Cancel order by client_order_id
- [Cancel Algo Order By Client Order Id](https://orderly.network/docs/build-on-omnichain/restful-api/private/cancel-algo-order-by-client_order_id): [DELETE /v1/algo/client/order] Cancel algo order by client_order_id
- [Cancel All Pending Algo Orders](https://orderly.network/docs/build-on-omnichain/restful-api/private/cancel-all-pending-algo-orders): [DELETE /v1/algo/orders] Cancel all pending algo orders
- [Cancel All Pending Orders](https://orderly.network/docs/build-on-omnichain/restful-api/private/cancel-all-pending-orders): [DELETE /v1/orders] Cancel all pending orders
- [Cancel All After](https://orderly.network/docs/build-on-omnichain/restful-api/private/cancel-all-after): [POST /v1/order/cancel_all_after] Cancel all after
- [Batch Cancel Orders](https://orderly.network/docs/build-on-omnichain/restful-api/private/batch-cancel-orders): [DELETE /v1/batch-order] Batch cancel orders
- [Batch Cancel Orders By Client Order Id](https://orderly.network/docs/build-on-omnichain/restful-api/private/batch-cancel-orders-by-client_order_id): [DELETE /v1/client/batch-order] Batch cancel orders by client_order_id
- [Get Order By Order Id](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-order-by-order_id): [GET /v1/order/{order_id}] Get order by order_id
- [Get Order By Client Order Id](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-order-by-client_order_id): [GET /v1/client/order/{client_order_id}] Get order by client_order_id
- [Get Algo Order By Order Id](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-algo-order-by-order_id): [GET /v1/algo/order/{order_id}] Get algo order by order_id
- [Get Algo Order By Client Order Id](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-algo-order-by-client_order_id): [GET /v1/algo/client/order/{client_order_id}] Get algo order by client_order_id
- [Get Orders](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-orders): [GET /v1/orders] Get orders
- [Get Algo Orders](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-algo-orders): [GET /v1/algo/orders] Get algo orders
- [Get Trades](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-trades): [GET /v1/trades] Get trades
- [Get Trade](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-trade): [GET /v1/trade/{trade_id}] Get trade
- [Get All Trades Of Specific Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-all-trades-of-specific-order): [GET /v1/order/{order_id}/trades] Get all trades of specific order
- [Get All Trades Of Specific Algo Order](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-all-trades-of-specific-algo-order): [GET /v1/algo/order/{order_id}/trades] Get all trades of specific algo order
- [List Order Tags For A Broker](https://orderly.network/docs/build-on-omnichain/restful-api/public/list-order-tags-for-a-broker): [GET /v1/public/broker/order_enums] List order tags for a broker
- [Get One Order Tag For A Broker](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-one-order-tag-for-a-broker): [GET /v1/public/broker/order_enum] Get one order tag for a broker

#### Liquidations

- [Get Positions Under Liquidation](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-positions-under-liquidation): [GET /v1/public/liquidation] Get positions under liquidation
- [Get Liquidated Positions Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-liquidated-positions-info): [GET /v1/public/liquidated_positions] Get liquidated positions info
- [Get Liquidated Positions By Liquidator](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-liquidated-positions-by-liquidator): [GET /v1/client/liquidator_liquidations] Get liquidated positions by liquidator
- [Get Liquidated Positions Of Account](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-liquidated-positions-of-account): [GET /v1/liquidations] Get liquidated positions of account
- [Claim Liquidated Positions](https://orderly.network/docs/build-on-omnichain/restful-api/private/claim-liquidated-positions): [POST /v1/liquidation] Claim liquidated positions
- [Claim Insurance Fund](https://orderly.network/docs/build-on-omnichain/restful-api/private/claim-insurance-fund): [POST /v1/claim_insurance_fund] Claim insurance fund

#### Assets/withdraw/settle PnL

- [Get Asset History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-asset-history): [GET /v1/asset/history] Get asset history
- [Get Current Holding](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-current-holding): [GET /v1/client/holding] Get current holding
- [Get Withdrawal Nonce](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-withdrawal-nonce): [GET /v1/withdraw_nonce] Get withdrawal nonce
- [Create Withdraw Request](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-withdraw-request): [POST /v1/withdraw_request] Create withdraw request
- [Get Settle Pnl Nonce](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-settle-pnl-nonce): [GET /v1/settle_nonce] Get settle PnL nonce
- [Request Pnl Settlement](https://orderly.network/docs/build-on-omnichain/restful-api/private/request-pnl-settlement): [POST /v1/settle_pnl] Request PnL settlement
- [Get Pnl Settlement History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-pnl-settlement-history): [GET /v1/pnl_settlement/history] Get PnL settlement history
- [Create Internal Transfer](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-internal-transfer): [POST /v1/internal_transfer] Create internal transfer
- [Create Internal Transfer With Wallet Signature](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-internal-transfer-with-wallet-signature): [POST /v2/internal_transfer] Create internal transfer with wallet signature
- [Get Transfer Nonce](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-transfer-nonce): [GET /v1/transfer_nonce] Get transfer nonce
- [Get Internal Transfer History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-internal-transfer-history): [GET /v1/internal_transfer_history] Get internal transfer history
- [Get Receiver Address](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-receiver-address): [GET /v1/client/asset/receiver_address] Get receiver address
- [Get Receiver Events](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-receiver-events): [GET /v1/client/asset/receiver_events] Get receiver events

#### Positions

- [Get All Positions Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-all-positions-info): [GET /v1/positions] Get all positions info
- [Get Lite Positions Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-lite-positions-info): [GET /v1/positions_lite] Get lite positions info
- [Get One Position Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-one-position-info): [GET /v1/position/{symbol}] Get one position info
- [Get Position History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-position-history): [GET /v1/position_history] Get position history

#### Funding

- [Get Funding Fee History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-funding-fee-history): [GET /v1/funding_fee/history] Get funding fee history


### Strategy vault API

#### Account

- [Get Strategy Vault Nonce For Account Transaction](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-strategy-vault-nonce-for-account-transaction): [GET /v1/public/sv_nonce] Get strategy vault nonce for account transaction
- [Create Strategy Vault Depositwithdrawal Request With Account](https://orderly.network/docs/build-on-omnichain/restful-api/public/create-strategy-vault-depositwithdrawal-request-with-account): [POST /v1/sv_operation_request] Create strategy vault deposit/withdrawal request with account
- [Get Account’S Strategy Vault Transaction History](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-account’s-strategy-vault-transaction-history): [GET /v1/account_sv_transaction_history] Get account’s strategy vault transaction history


### Staking & VALOR API

#### Staking

- [Get Wallets Current Staked Balance](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-wallets-current-staked-balance): [GET /v1/staking/balance] Get wallet's current staked balance
- [Get Unstaking Order Details](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-unstaking-order-details): [GET /v1/staking/unstake_details] Get unstaking order details
- [Get Staking Overview](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-staking-overview): [GET /v1/staking/overview] Get staking overview
- [Get Esorder Vesting List](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-esorder-vesting-list): [GET /v1/staking/esorder/vesting_list] Get esorder vesting list

#### VALOR

- [Get Valor Batch Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-valor-batch-info): [GET /v1/staking/valor/batch_info] Get valor batch info
- [Get Valor Pool Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-valor-pool-info): [GET /v1/staking/valor/pool_info] Get valor pool info
- [Get Valor Redeem Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-valor-redeem-info): [GET /v1/staking/valor/redeem] Get valor redeem info
- [Get Valor2 Pool Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-valor2-pool-info): [GET /v1/staking/valor2/pool_info] Get valor2 pool info
- [Get Valor2 Batch Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-valor2-batch-info): [GET /v1/staking/valor2/batch_info] Get valor2 batch info
- [Get Valor2 Redeem Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-valor2-redeem-info): [GET /v1/staking/valor2/redeem] Get valor2 redeem info
- [Get Valor2 Revenue Buyback](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-valor2-revenue-buyback): [GET /v1/staking/valor2/revenue_buyback] Get valor2 revenue buyback


### Builder API

#### User data

- [Get Builders Users Volumes](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-builders-users-volumes): [GET /v1/volume/broker/daily] Get builder's users' volumes
- [Get Builders Leaderboard](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-builders-leaderboard): [GET /v1/broker/leaderboard/daily] Get builder's leaderboard

#### Trading campaigns

- [Get Campaign Ranking](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-campaign-ranking): [GET /v1/public/campaign/ranking] Get campaign ranking
- [Get Campaign Statistics](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-campaign-statistics): [GET /v1/public/campaign/stats] Get campaign statistics
- [Get Campaign User Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-campaign-user-info): [GET /v1/public/campaign/user] Get campaign user info
- [Get Detailed Campaign Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-detailed-campaign-info): [GET /v1/public/campaign/stats/details] Get detailed campaign info
- [Get List Of Campaigns](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-list-of-campaigns): [GET /v1/public/campaigns] Get list of campaigns
- [Get Campaign Verification](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-campaign-verification): [GET /v1/public/campaign/check] Get campaign verification
- [Sign Up Campaign](https://orderly.network/docs/build-on-omnichain/restful-api/private/sign-up-campaign): [POST /v1/client/campaign/sign_up] Sign up campaign

#### Referral program

##### Referral code management (legacy)

- [Check Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/public/check-referral-code): [GET /v1/public/referral/check_ref_code] Check referral code
- [Verify Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/public/verify-referral-code): [GET /v1/public/referral/verify_ref_code] Verify referral code
- [Bind Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/private/bind-referral-code): [POST /v1/referral/bind] Bind referral code
- [Edit Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/private/edit-referral-code): [POST /v1/referral/edit_referral_code] Edit referral code

##### User statistics (legacy)

- [Get Referral Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referral-info): [GET /v1/referral/info] Get referral info
- [Get Referee Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referee-info): [GET /v1/referral/referee_info] Get referee info
- [Get Referral History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referral-history): [GET /v1/referral/referral_history] Get referral history
- [Get Referral Rebate Summary](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referral-rebate-summary): [GET /v1/referral/rebate_summary] Get referral rebate summary
- [Get Referee Rebate Summary](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referee-rebate-summary): [GET /v1/referral/referee_rebate_summary] Get referee rebate summary
- [Get Referee History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referee-history): [GET /v1/referral/referee_history] Get referee history
- [Get Distribution History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-distribution-history): [GET /v1/client/distribution_history] Get distribution history

##### Referral admin (legacy)

- [Create Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-referral-code): [POST /v1/referral/create] Create referral code
- [Get Referral Code Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referral-code-info): [GET /v1/referral/admin_info] Get referral code info
- [Update Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-referral-code): [POST /v1/referral/update] Update referral code
- [Edit Referral Code Split](https://orderly.network/docs/build-on-omnichain/restful-api/private/edit-referral-code-split): [POST /v1/referral/edit_split] Edit referral code split
- [Edit Referral Description](https://orderly.network/docs/build-on-omnichain/restful-api/private/edit-referral-description): [POST /v1/referral/edit_description] Edit referral description
- [Builder Admin Update Auto Referral](https://orderly.network/docs/build-on-omnichain/restful-api/private/builder-admin-update-auto-referral): [POST /v1/referral/auto_referral/update] Builder admin update auto referral
- [Builder Admin Get Auto Referral Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/builder-admin-get-auto-referral-info): [GET /v1/referral/auto_referral/info] Builder admin get auto referral info
- [Get Auto Referral Progress](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-auto-referral-progress): [GET /v1/referral/auto_referral/progress] Get auto referral progress

##### Multilevel referral

- [Check Multilevel Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/public/check-multilevel-referral-code): [GET /v1/public/referral/check_ref_code] Check referral code
- [Verify Multilevel Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/public/verify-multilevel-referral-code): [GET /v1/public/referral/verify_ref_code] Verify referral code
- [Bind Multilevel Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/private/bind-multilevel-referral-code): [POST /v1/referral/bind] Bind referral code
- [Edit Multilevel Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/private/edit-multilevel-referral-code): [POST /v1/referral/edit_referral_code] Edit referral code
- [Get Multilevel Referral History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-multilevel-referral-history): [GET /v1/referral/referral_history] Get referral history
- [Get Multilevel Referral Rebate Summary](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-multilevel-referral-rebate-summary): [GET /v1/referral/rebate_summary] Get referral rebate summary
- [Get Max Rebate Rate](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-max-rebate-rate): [GET /v1/referral/multi_level/max_rebate_rate] Get max rebate rate
- [Claim Referral Code](https://orderly.network/docs/build-on-omnichain/restful-api/private/claim-referral-code): [POST /v1/referral/multi_level/claim_code] Claim referral code
- [Get Rebate Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-rebate-info): [GET /v1/referral/multi_level/rebate_info] Get rebate info
- [Update Referee Rebate Rate](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-referee-rebate-rate): [POST /v1/referral/multi_level/rebate_rate/update] Update referee rebate rate
- [Reset Referee Rebate Rate](https://orderly.network/docs/build-on-omnichain/restful-api/private/reset-referee-rebate-rate): [POST /v1/referral/multi_level/rebate_rate/set_default] Reset referee rebate rate
- [Get Multilevel Statistics](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-multilevel-statistics): [GET /v1/referral/multi_level/statistics] Get multilevel statistics
- [Get Referee List](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-referee-list): [GET /v1/referral/multi_level/referee_list] Get referee list
- [Edit Direct Referee Description](https://orderly.network/docs/build-on-omnichain/restful-api/private/edit-direct-referee-description): [POST /v1/referral/edit_referee_description] Edit direct referee description
- [Get Volume Prerequisite](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-volume-prerequisite): [GET /v1/referral/multi_level/volume_prerequisite] Get volume prerequisite


#### Builder admin

##### Builder info

- [Get Builder Fee Tier Information](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-builder-fee-tier-information): [GET /v1/broker/broker_info] Get builder fee tier information
- [Get Builders Daily Revenue Settlement History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-builders-daily-revenue-settlement-history): [GET /v1/broker/daily_fee_revenue] Get builder's daily revenue settlement history

##### User data

- [Get Account Information 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-account-information-1): [GET /v1/admin/client/info] Get account information
- [Get Current Holding 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-current-holding-1): [GET /v1/admin/client/holding] Get current holding
- [Get Internal Transfer History 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-internal-transfer-history-1): [GET /v1/admin/internal_transfer_history] Get internal transfer history
- [Get Asset History 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-asset-history-1): [GET /v1/admin/asset/history] Get asset history
- [Get Asset Conversion History](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-asset-conversion-history): [GET /v1/admin/asset/convert_history] Get asset conversion history
- [Get Leverage Setting 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-leverage-setting-1): [GET /v1/admin/client/leverage] Get leverage setting
- [Get Orders 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-orders-1): [GET /v1/admin/orders] Get orders
- [Get One Position Info 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-one-position-info-1): [GET /v1/admin/position/{symbol}] Get one position info
- [Get All Positions Info 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-all-positions-info-1): [GET /v1/admin/positions] Get all positions info
- [Get Funding Fee History 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-funding-fee-history-1): [GET /v1/admin/funding_fee/history] Get funding fee history
- [Get User Volume Statistics 1](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-user-volume-statistics-1): [GET /v1/admin/volume/user/stats] Get user volume statistics
- [Get Liquidated Positions Admin](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-liquidated-positions-admin): [GET /v1/admin/liquidations] Get liquidated positions (admin)
- [Get Algo Orders Admin](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-algo-orders-admin): [GET /v1/admin/algo/orders] Get algo orders (admin)
- [Get Trades Admin](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-trades-admin): [GET /v1/admin/trades] Get trades (admin)

##### Multilevel referral admin

- [Enable Or Configure Multilevel Referral](https://orderly.network/docs/build-on-omnichain/restful-api/private/enable-or-configure-multilevel-referral): [POST /v1/referral/multi_level/admin] Enable or configure multilevel referral
- [Get Multilevel Referral Config](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-multilevel-referral-config): [GET /v1/referral/multi_level/admin] Get multilevel referral config
- [Update Multilevel Referral Config](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-multilevel-referral-config): [POST /v1/referral/multi_level/admin/update] Update multilevel referral config
- [Update L1 Affiliate Rebate Rate](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-l1-affiliate-rebate-rate): [POST /v1/referral/multi_level/admin/update/affiliate] Update L1 affiliate rebate rate
- [Reset L1 Affiliate Rebate Rate](https://orderly.network/docs/build-on-omnichain/restful-api/private/reset-l1-affiliate-rebate-rate): [POST /v1/referral/multi_level/admin/reset/affiliate] Reset L1 affiliate rebate rate
- [Get Multilevel Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-multilevel-info): [GET /v1/referral/multi_level/admin/info] Get multilevel info
- [Get Admin Referee List](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-admin-referee-list): [GET /v1/referral/multi_level/admin/referee_list] Get admin referee list
- [Get Multilevel Summary Info](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-multilevel-summary-info): [GET /v1/referral/multi_level/admin/summary] Get multilevel summary info
- [Create Multilevel Referral Code On Affiliates Behalf](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-multilevel-referral-code-on-affiliates-behalf): [POST /v1/referral/multi_level/admin/create/affiliate] Create multilevel referral code on affiliate's behalf

##### Fee settings

- [Update User Fee Rate](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-user-fee-rate): [POST /v1/broker/fee_rate/set] Update user fee rate
- [Reset User Fee Rate](https://orderly.network/docs/build-on-omnichain/restful-api/private/reset-user-fee-rate): [POST /v1/broker/fee_rate/set_default] Reset user fee rate
- [Get Default Builder Fee](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-default-builder-fee): [GET /v1/broker/fee_rate/default] Get default builder fee
- [Update Default Builder Fee](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-default-builder-fee): [POST /v1/broker/fee_rate/default] Update default builder fee
- [Get User Fee Rates](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-user-fee-rates): [GET /v1/broker/user_info] Get user fee rates

##### Order tag admin

- [Create Order Tag](https://orderly.network/docs/build-on-omnichain/restful-api/private/create-order-tag): [POST /v1/broker/order_enum] Create order tag
- [Update Order Tag](https://orderly.network/docs/build-on-omnichain/restful-api/private/update-order-tag): [PUT /v1/broker/order_enum/{enum_id}] Update order tag
- [List All Order Tags For A Builder](https://orderly.network/docs/build-on-omnichain/restful-api/private/list-all-order-tags-for-a-builder): [GET /v1/broker/order_enums] List all order tags for a builder
- [Get Single Order Tag With Stats](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-single-order-tag-with-stats): [GET /v1/broker/order_enum/{enum_id}] Get single order tag with stats
- [Archive An Order Tag](https://orderly.network/docs/build-on-omnichain/restful-api/private/archive-an-order-tag): [POST /v1/broker/order_enum/archive] Archive an order tag
- [Unarchive An Order Tag](https://orderly.network/docs/build-on-omnichain/restful-api/private/unarchive-an-order-tag): [POST /v1/broker/order_enum/unarchive] Unarchive an order tag



### Points module

#### Public API

- [Get Information About Stages](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-information-about-stages): [GET /v1/public/points/stages] Get information about stages
- [Get Merits Leaderboard](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-merits-leaderboard): [GET /v1/public/points/leaderboard] Get merits leaderboard
- [Get Users Merits](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-users-merits): [GET /v1/client/points] Get user's merits
- [Get Stage Rankings](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-stage-rankings): [GET /v1/public/points/rankings] Get stage rankings
- [Get Number Of Merits For Distribution](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-number-of-merits-for-distribution): [GET /v1/public/points/epoch] Get number of merits for distribution

#### Admin API

- [Createupdate Stage Parameters](https://orderly.network/docs/build-on-omnichain/restful-api/private/createupdate-stage-parameters): [POST /v1/admin/points/stage] Create/update stage parameters
- [Get Stage Parameters](https://orderly.network/docs/build-on-omnichain/restful-api/private/get-stage-parameters): [GET /v1/admin/points/stage] Get stage parameters
- [Delete Stage](https://orderly.network/docs/build-on-omnichain/restful-api/admin/delete-stage): [DELETE /v1/admin/points/stage] Delete stage


### Market data API

#### Tradingview

- [Get Tradingview Localized Config Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-tradingview-localized-config-info): [GET /v1/tv/config] Get tradingview localized config info
- [Get Tradingview History Bars](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-tradingview-history-bars): [GET /v1/tv/history] Get tradingview history bars
- [Get Tradingview Symbol Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-tradingview-symbol-info): [GET /v1/tv/symbol_info] Get tradingview symbol info

#### Funding rates

- [Get Funding Rate History For One Market](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-funding-rate-history-for-one-market): [GET /v1/public/funding_rate_history] Get funding rate history for one market
- [Get Predicted Funding Rate For One Market](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-predicted-funding-rate-for-one-market): [GET /v1/public/funding_rate/{symbol}] Get predicted funding rate for one market
- [Get Predicted Funding Rates For All Markets](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-predicted-funding-rates-for-all-markets): [GET /v1/public/funding_rates] Get predicted funding rates for all markets
- [Get Funding Rate For All Markets](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-funding-rate-for-all-markets): [GET /v1/public/market_info/funding_history] Get funding rate for all markets

#### Market info

- [Get Supported Collateral Info](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-supported-collateral-info): [GET /v1/public/token] Get supported collateral info
- [Get Order Rules Per Symbol](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-order-rules-per-symbol): [GET /v1/public/info/{symbol}] Get order rules per symbol
- [Get Available Symbols](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-available-symbols): [GET /v1/public/info] Get available symbols
- [Get Market Trades](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-market-trades): [GET /v1/public/market_trades] Get market trades
- [Get Price Info For All Symbols](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-price-info-for-all-symbols): [GET /v1/public/market_info/price_changes] Get price info for all symbols
- [Get Open Interests For All Symbols](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-open-interests-for-all-symbols): [GET /v1/public/market_info/traders_open_interests] Get open interests for all symbols
- [Get Market Info For All Symbols](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-market-info-for-all-symbols): [GET /v1/public/futures] Get market info for all symbols
- [Get Market Info For One Symbol](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-market-info-for-one-symbol): [GET /v1/public/futures/{symbol}] Get market info for one symbol
- [Get Index Price Source](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-index-price-source): [GET /v1/public/index_price_source] Get index price source
- [Get Historical Price List For All Symbols](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-historical-price-list-for-all-symbols): [GET /v1/public/market_info/history_charts] Get historical price list for all symbols
- [Orderbook Snapshot](https://orderly.network/docs/build-on-omnichain/restful-api/private/orderbook-snapshot): [GET /v1/orderbook/{symbol}] Orderbook snapshot
- [Get Kline](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-kline): [GET /v1/kline] Get kline
- [Get Kline History](https://orderly.network/docs/build-on-omnichain/restful-api/public/get-kline-history): [GET /v1/tv/kline_history] Get kline history


### Websocket API

- [Websocket API](https://orderly.network/docs/build-on-omnichain/websocket-api/introduction): WebSocket API base endpoints, available public and private topics, and subscription/unsubscription format.
- [PING/PONG](https://orderly.network/docs/build-on-omnichain/websocket-api/ping-pong): WebSocket keep-alive mechanism using ping/pong messages with a 10-second interval.
- [Authentication](https://orderly.network/docs/build-on-omnichain/websocket-api/authentication): How to authenticate WebSocket private stream connections using orderly-key and orderly-secret.
- [Error Response](https://orderly.network/docs/build-on-omnichain/websocket-api/error-response): Format and example of WebSocket error responses, including the client ID mapping pattern.

#### Public market data

- [Request orderbook](https://orderly.network/docs/build-on-omnichain/websocket-api/public/request-orderbook): Request a one-time orderbook snapshot for a symbol via WebSocket instead of subscribing to updates.
- [Orderbook](https://orderly.network/docs/build-on-omnichain/websocket-api/public/orderbook): Subscribe to full depth-100 orderbook snapshots for a symbol via WebSocket, pushed every second.
- [Order book update](https://orderly.network/docs/build-on-omnichain/websocket-api/public/order-book-update): Subscribe to incremental orderbook updates for a symbol via WebSocket, pushed every 200ms.
- [Trade](https://orderly.network/docs/build-on-omnichain/websocket-api/public/trade): Subscribe to real-time trade execution events for a symbol via WebSocket.
- [24h ticker](https://orderly.network/docs/build-on-omnichain/websocket-api/public/24-hour-ticker): Subscribe to 24-hour ticker data for a single symbol via WebSocket, pushed every second.
- [24h tickers](https://orderly.network/docs/build-on-omnichain/websocket-api/public/24-hour-tickers): Subscribe to 24-hour ticker data for all symbols via WebSocket, pushed every second.
- [24h ticker by builder](https://orderly.network/docs/build-on-omnichain/websocket-api/public/24-hour-ticker-by-builder): Subscribe to 24-hour ticker data for a single symbol filtered by builder ID via WebSocket.
- [24h tickers by builder](https://orderly.network/docs/build-on-omnichain/websocket-api/public/24-hour-tickers-by-builder): Subscribe to 24-hour ticker data for all symbols filtered by builder ID via WebSocket.
- [bbo](https://orderly.network/docs/build-on-omnichain/websocket-api/public/bbo): Subscribe to best bid and offer (BBO) updates for a single symbol via WebSocket, pushed every 10ms.
- [bbos](https://orderly.network/docs/build-on-omnichain/websocket-api/public/bbos): Subscribe to best bid and offer (BBO) updates for all symbols via WebSocket, pushed every second.
- [k-line](https://orderly.network/docs/build-on-omnichain/websocket-api/public/k-line): Subscribe to OHLC kline/candlestick updates for a symbol at configurable time intervals via WebSocket.
- [Market Price Changes Info](https://orderly.network/docs/build-on-omnichain/websocket-api/public/price-changes): Subscribe to market price change information for all symbols via WebSocket, pushed every minute.
- [Traders Open Interest](https://orderly.network/docs/build-on-omnichain/websocket-api/public/traders-open-interests): Subscribe to aggregated traders' open interest data via WebSocket, pushed every minute.
- [Price for Small Charts](https://orderly.network/docs/build-on-omnichain/websocket-api/public/price-for-small-charts): Subscribe to historical price data for small chart rendering via WebSocket, pushed every minute.
- [Index price](https://orderly.network/docs/build-on-omnichain/websocket-api/public/index-price): Subscribe to index price updates for a single symbol via WebSocket using the SPOT symbol format.
- [Index prices](https://orderly.network/docs/build-on-omnichain/websocket-api/public/index-prices): Subscribe to index price updates for all symbols via WebSocket, pushed every second.
- [Mark price](https://orderly.network/docs/build-on-omnichain/websocket-api/public/mark-price): Subscribe to mark price updates for a single symbol via WebSocket, pushed every second.
- [Mark prices](https://orderly.network/docs/build-on-omnichain/websocket-api/public/mark-prices): Subscribe to mark price updates for all symbols via WebSocket, pushed every second.
- [Open interest](https://orderly.network/docs/build-on-omnichain/websocket-api/public/open-interest): Subscribe to open interest updates for a symbol via WebSocket, with 1s change and 10s forced push.
- [Estimated funding rate](https://orderly.network/docs/build-on-omnichain/websocket-api/public/estimated-funding-rate): Subscribe to estimated funding rate updates for a symbol via WebSocket, pushed every 15 seconds.
- [Liquidation push](https://orderly.network/docs/build-on-omnichain/websocket-api/public/liquidation-push): Subscribe to real-time liquidation event notifications via WebSocket.
- [System maintenance status](https://orderly.network/docs/build-on-omnichain/websocket-api/public/system-maintenance-status): Subscribe to real-time system maintenance status notifications via WebSocket.
- [Announcement](https://orderly.network/docs/build-on-omnichain/websocket-api/public/announcement): Subscribe to real-time system announcements via WebSocket.

#### Private user data

- [Account](https://orderly.network/docs/build-on-omnichain/websocket-api/private/account): Subscribe to real-time account status updates via private WebSocket stream.
- [Balance](https://orderly.network/docs/build-on-omnichain/websocket-api/private/balance): Subscribe to real-time token balance updates via private WebSocket stream.
- [Execution Report](https://orderly.network/docs/build-on-omnichain/websocket-api/private/execution-report): Subscribe to order execution reports, optionally filtered by symbol, via private WebSocket stream.
- [Algo Execution Report](https://orderly.network/docs/build-on-omnichain/websocket-api/private/algo-execution-report): Subscribe to algo order execution reports via private WebSocket stream.
- [Algo Execution Report v2](https://orderly.network/docs/build-on-omnichain/websocket-api/private/algo-execution-report-v2): Subscribe to v2 algo order execution reports with enhanced fields via private WebSocket stream.
- [Position push](https://orderly.network/docs/build-on-omnichain/websocket-api/private/position-push): Subscribe to real-time position updates via private WebSocket stream.
- [Liquidation on account push](https://orderly.network/docs/build-on-omnichain/websocket-api/private/liquidation-account-push): Subscribe to account-level liquidation event notifications via private WebSocket stream.
- [Liquidator liquidations push](https://orderly.network/docs/build-on-omnichain/websocket-api/private/liquidator): Subscribe to liquidator-initiated liquidation updates via private WebSocket stream.
- [PnL Settlement](https://orderly.network/docs/build-on-omnichain/websocket-api/private/pnl-settlement): Subscribe to PnL settlement status updates via private WebSocket stream.
- [Wallet Transactions](https://orderly.network/docs/build-on-omnichain/websocket-api/private/wallet-transactions): Subscribe to deposit and withdrawal transaction updates via private WebSocket stream.
- [Asset Convert](https://orderly.network/docs/build-on-omnichain/websocket-api/private/asset-convert): Subscribe to asset conversion status updates via private WebSocket stream.


## SDKs

### Software development kits

- [List of SDKs](https://orderly.network/docs/sdks/overview): Comparison of Orderly SDKs (React components, hooks, core, perp) to help choose the right starting point.
- [SDK Best Practices](https://orderly.network/docs/sdks/best-practices): Architecture guidelines, integration best practices, and troubleshooting checklists for Orderly SDK developers and AI agents.
- [Release Notes](https://orderly.network/docs/sdks/release-notes): Links to the full Orderly TypeScript SDK release notes and related setup documentation.

### [evm] react components SDK

- [Overview](https://orderly.network/docs/sdks/react/overview): Build modern, responsive trading interfaces with Orderly Components SDK.
- [Getting started](https://orderly.network/docs/sdks/react/getting_started): Quickly install and configure the Orderly React SDK to build professional trading interfaces.
- [Theming](https://orderly.network/docs/sdks/react/theming): How to customize the Orderly SDK visual theme including colors, typography, and component overrides.
- [Wallet connect](https://orderly.network/docs/sdks/react/wallet): How to integrate wallet connection with the Orderly React SDK using WalletConnectorContext.

#### Framework guides

- [Next.js](https://orderly.network/docs/sdks/react/next): How to set up the Orderly SDK in a Next.js project with App Router or Page Router.

#### Page components

- [TradingPage](https://orderly.network/docs/sdks/react/components/trading): Full-featured TradingPage component with orderbook, chart, order form, positions, and responsive layout.

#### Block components

- [Deposit](https://orderly.network/docs/sdks/react/components/deposit): Pre-built React component for token deposits with wallet connection handling and modal support.
- [Withdraw](https://orderly.network/docs/sdks/react/components/withdraw): Pre-built React component for token withdrawals with wallet connection handling and modal support.
- [Order Book](https://orderly.network/docs/sdks/react/components/order_book): Pre-built React OrderBook component with depth merging, price display, and height adaptation.
- [Portfolio](https://orderly.network/docs/sdks/react/components/portfolio): Pre-built React portfolio components including history, settings, and mobile-responsive pages.
- [Scaffold](https://orderly.network/docs/sdks/react/components/scaffold): Layout scaffold component with navigation, sidebar, footer, and responsive desktop/mobile support.


### [evm] react hooks SDK

- [Overview](https://orderly.network/docs/sdks/hooks/overview): Power your trading application with performant, React-native Orderly Hooks.
- [Setup](https://orderly.network/docs/sdks/hooks/setup): How to install, configure, and connect wallet adapters with the Orderly React hooks SDK.

#### API requests

- [Low-level API](https://orderly.network/docs/sdks/hooks/api/api): Access low-level REST and WebSocket APIs for custom Orderly integrations.
- [useQuery](https://orderly.network/docs/sdks/hooks/api/use-query): Hook to fetch data from public API endpoints with automatic JSON serialization.
- [usePrivateQuery](https://orderly.network/docs/sdks/hooks/api/use-private-query): Hook to fetch data from authenticated private API endpoints.
- [usePrivateInfiniteQuery](https://orderly.network/docs/sdks/hooks/api/use-private-infinite-query): Hook for paginated private API queries with infinite scroll support.
- [useLazyQuery](https://orderly.network/docs/sdks/hooks/api/use-lazy-query): Hook for on-demand fetching of public API data, triggered manually rather than on mount.
- [useMutation](https://orderly.network/docs/sdks/hooks/api/use-mutation): Hook for POST, PUT, and DELETE API requests such as creating or cancelling orders.
- [useWS](https://orderly.network/docs/sdks/hooks/api/use-ws): Hook to subscribe to public WebSocket topics with custom message handlers.
- [useWsStatus](https://orderly.network/docs/sdks/hooks/api/use-ws-status): Hook to monitor the current WebSocket connection status.

#### Utility

- [Utility](https://orderly.network/docs/sdks/hooks/util/util): Enhance your application with Orderly utility hooks for config and state management.
- [useConfig](https://orderly.network/docs/sdks/hooks/util/use-config): Hook to read Orderly configuration values like brokerId, networkId, and API URLs.
- [useEventEmitter](https://orderly.network/docs/sdks/hooks/util/use-event-emitter): Hook for cross-component event communication using an emit/on pattern.
- [useLocalStorage](https://orderly.network/docs/sdks/hooks/util/use-local-storage): Hook to read and write values in browser localStorage with React state binding.
- [useSessionStorage](https://orderly.network/docs/sdks/hooks/util/use-session-storage): Hook to read and write values in browser sessionStorage with React state binding.
- [useMediaQuery](https://orderly.network/docs/sdks/hooks/util/use-media-query): Hook to evaluate a CSS media query and return a boolean for responsive layouts.

#### Account

- [Account](https://orderly.network/docs/sdks/hooks/account/account): Register accounts, manage Orderly Keys, and handle wallet-level events.
- [useAccount](https://orderly.network/docs/sdks/hooks/account/use-account): Hook for creating an Orderly account, generating Orderly keys, and managing the KeyStore.
- [useAccountInfo](https://orderly.network/docs/sdks/hooks/account/use-account-info): Hook to fetch basic account information like fee rates, leverage, and account mode from the API.
- [useAccountInstance](https://orderly.network/docs/sdks/hooks/account/use-account-instance): Hook to access the Account singleton for registration, Orderly Key creation, and wallet details.
- [useWalletConnector](https://orderly.network/docs/sdks/hooks/account/use-wallet-connector): Hook to connect, disconnect, and switch chains for a user's wallet.
- [useWalletSubscription](https://orderly.network/docs/sdks/hooks/account/use-wallet-subscription): Hook to subscribe to on-chain wallet events like deposit and withdrawal completions.
- [useLeverage](https://orderly.network/docs/sdks/hooks/account/use-leverage): Hook to get and update the account's maximum leverage setting.
- [useMarginRatio](https://orderly.network/docs/sdks/hooks/account/use-margin-ratio): Hook to get the current margin ratio, leverage, and maintenance margin ratio for an account.
- [useSettleSubscription](https://orderly.network/docs/sdks/hooks/account/use-settle-subscription): Hook to subscribe to PnL settlement status events via WebSocket for the current account.
- [useDaily](https://orderly.network/docs/sdks/hooks/account/use-daily): Hook to retrieve daily trading volume for the current account over a date range.

#### Assets

- [Assets](https://orderly.network/docs/sdks/hooks/assets/assets): Handle collateral, deposits, withdrawals, and balances with Orderly asset hooks.
- [useCollateral](https://orderly.network/docs/sdks/hooks/assets/use-collateral): Hook to get collateral details including total value, free collateral, and unsettled PnL.
- [useMaxQty](https://orderly.network/docs/sdks/hooks/assets/use-max-qty): Hook to get the maximum tradeable quantity for a symbol and order side.
- [useChain](https://orderly.network/docs/sdks/hooks/assets/use-chain): Hook to get chain information for a specific token.
- [useChains](https://orderly.network/docs/sdks/hooks/assets/use-chains): Hook to retrieve the list of chains supported by Orderly with a chain-ID lookup helper.
- [useDeposit](https://orderly.network/docs/sdks/hooks/assets/use-deposit): Hook for managing token deposits, including wallet balance lookup and deposit execution.
- [useWithdraw](https://orderly.network/docs/sdks/hooks/assets/use-withdraw): Hook for managing withdrawals with available balance, max withdrawable amount, and unsettled PnL.
- [useHoldingStream](https://orderly.network/docs/sdks/hooks/assets/use-holding-stream): Hook to receive real-time token holding balances via WebSocket.

#### Market data

- [Market data](https://orderly.network/docs/sdks/hooks/market-data/markets): Stream real-time prices, orderbooks, and trade history with market data hooks.
- [useOrderbookStream](https://orderly.network/docs/sdks/hooks/market-data/use-orderbook-stream): Hook to stream formatted orderbook data with depth control and auto symbol switching.
- [useIndexPrice](https://orderly.network/docs/sdks/hooks/market-data/use-index-price): Hook to receive real-time index price updates for a symbol via WebSocket.
- [useMarkPrice](https://orderly.network/docs/sdks/hooks/market-data/use-mark-price): Hook to receive real-time mark price updates for a symbol via WebSocket.
- [useMarkPricesStream](https://orderly.network/docs/sdks/hooks/market-data/use-mark-prices-stream): Hook to stream mark prices for all symbols as a symbol-to-price map.
- [useMarketTradeStream](https://orderly.network/docs/sdks/hooks/market-data/use-market-trade-stream): Hook to stream recent trade executions for a given symbol via WebSocket.
- [useMarkets](https://orderly.network/docs/sdks/hooks/market-data/use-markets): Hook extending useMarketsStream with favorites, recent views, and history tracking.
- [useMarketsStream](https://orderly.network/docs/sdks/hooks/market-data/use-markets-stream): Hook to stream 24h ticker data for all markets via WebSocket.
- [useTickerStream](https://orderly.network/docs/sdks/hooks/market-data/use-ticker-stream): Hook to stream market information (mark price, index price, 24h stats) for a single symbol.
- [useSymbolsInfo](https://orderly.network/docs/sdks/hooks/market-data/use-symbols-info): Hook to subscribe to symbol configuration data for all tradeable instruments.
- [useSymbolPriceRange](https://orderly.network/docs/sdks/hooks/market-data/use-symbol-price-range): Hook to get the allowed price range for an order based on symbol, side, and trigger price.

#### Orders

- [Orders](https://orderly.network/docs/sdks/hooks/orders/orders): Execute trades, manage orders, and stream live orderbook data.
- [useOrderEntry](https://orderly.network/docs/sdks/hooks/orders/use-order-entry): Hook for building order forms with validation, max quantity, estimated liquidation price, and submission.
- [useOrderStream](https://orderly.network/docs/sdks/hooks/orders/use-order-stream): Hook to stream, filter, edit, and cancel orders by status, symbol, or side.
- [useTPSL](https://orderly.network/docs/sdks/hooks/orders/use-tp-sl): Hook for creating and managing take-profit and stop-loss (TP/SL) algo orders on positions.

#### Positions

- [usePositionStream](https://orderly.network/docs/sdks/hooks/positions/use-position-stream): Hook to stream position data with calculated values for margin, liquidation price, and unrealized PnL.
- [usePoster](https://orderly.network/docs/sdks/hooks/positions/use-poster): Hook to generate shareable poster images from position information with customizable styling.

#### Funding

- [Funding](https://orderly.network/docs/sdks/hooks/funding/funding): Manage funding rates, payments, and history with Orderly funding hooks.
- [useFundingRate](https://orderly.network/docs/sdks/hooks/funding/use-funding-rate): Hook to receive the current funding rate for a given perpetual futures symbol.

#### Referral

- [Referral](https://orderly.network/docs/sdks/hooks/referral/referral): Implement referral programs, track referees, and manage rebate summaries.
- [useCheckReferralCode](https://orderly.network/docs/sdks/hooks/referral/use-check-referral-code): Hook to verify whether a given referral code exists.
- [useGetReferralCode](https://orderly.network/docs/sdks/hooks/referral/use-get-referral-code): Hook to obtain a referral code by account ID.
- [useDaily](https://orderly.network/docs/sdks/hooks/referral/use-daily): Hook to retrieve daily perpetual volume data for referral tracking over a date range.
- [useRefereeInfo](https://orderly.network/docs/sdks/hooks/referral/use-referee-info): Hook to retrieve paginated referee information with date filtering.
- [useRefereeHistory](https://orderly.network/docs/sdks/hooks/referral/use-referee-history): Hook to retrieve paginated referee history with date filtering.
- [useRefereeRebateSummary](https://orderly.network/docs/sdks/hooks/referral/use-referee-rebate-summary): Hook to get daily referee rebate statistics over a date range.
- [useReferralInfo](https://orderly.network/docs/sdks/hooks/referral/use-referral-info): Hook to get referral profile info including affiliate/trader status and first referral code.
- [useReferralRebateSummary](https://orderly.network/docs/sdks/hooks/referral/use-referral-rebate-summary): Hook to get daily referral rebate statistics over a date range.


### [evm] core SDK

- [Overview](https://orderly.network/docs/sdks/core/overview): Integrate core Orderly Network functionality into any JavaScript environment.

### [evm] perp SDK

- [Overview](https://orderly.network/docs/sdks/perp/overview): Streamline perpetual futures trading with the Orderly Perp SDK.

### Autogenerated technical reference

- [README](https://orderly.network/docs/sdks/tech-doc/README): Orderly SDKs / Modules Orderly EVM SDKs ![Hooks NPM Version](https://www.npmjs.com/package/@orderly.network/hooks) ![Core NPM Version](https://www.npmjs.com/package/@orderly.network/core) ![Perp NPM Version](https://www.npmjs.com/package/@orderly.network/pe...
- [Modules](https://orderly.network/docs/sdks/tech-doc/modules): Orderly SDKs / Modules Orderly SDKs

#### Modules

- [Orderly Network Core.EventEmitter](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_core.EventEmitter): Orderly SDKs / Modules / @orderly.network/core / EventEmitter Namespace: EventEmitter @orderly.network/core.EventEmitter Table of contents Interfaces EventEmitterStatic ListenerFn Type Aliases ArgumentMap EventArgs EventListener EventNames ValidEventTypes V...
- [Orderly Network Core](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_core): Orderly SDKs / Modules / @orderly.network/core Module: @orderly.network/core Table of contents Namespaces EventEmitter utils Classes Account BaseKeyStore BaseOrderlyKeyPair BaseSigner DefaultConfigStore EtherAdapter EventEmitter LocalStorageStore MockKeySto...
- [Orderly Network Core.Utils](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_core.utils): Orderly SDKs / Modules / @orderly.network/core / utils Namespace: utils @orderly.network/core.utils Table of contents Type Aliases SignatureDomain Functions base64url calculateStringHash formatByUnits getGlobalObject getTimestamp isHex isHexString parseAcco...
- [Orderly Network Hooks.RefferalAPI](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI): Orderly SDKs / Modules / @orderly.network/hooks / RefferalAPI Namespace: RefferalAPI @orderly.network/hooks.RefferalAPI Table of contents Interfaces ReferralInfo Type Aliases DayliVolume Distribution Referee RefereeInfoItem RefereeRebateSummary ReferralCode...
- [Orderly Network Hooks](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_hooks): Orderly SDKs / Modules / @orderly.network/hooks Module: @orderly.network/hooks Table of contents Namespaces RefferalAPI utils Enumerations MarketsType WsNetworkStatus Interfaces CallOptions ConfigProviderProps ControlFunctions DebouncedState Favorite Favori...
- [Orderly Network Hooks.Utils](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_hooks.utils): Orderly SDKs / Modules / @orderly.network/hooks / utils Namespace: utils @orderly.network/hooks.utils Table of contents References cleanStringStyle Functions findPositionTPSLFromOrders findTPSLFromOrder findTPSLFromOrders formatNumber getPositionBySymbol pr...
- [Orderly Network Net](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_net): Orderly SDKs / Modules / @orderly.network/net Module: @orderly.network/net Table of contents Enumerations WebSocketEvent Classes WS Variables \_\_ORDERLY_API_URL_KEY\_\_ version Functions del get mutate post put Variables \_\_ORDERLY_API_URL_KEY\_\_ • Const...
- [Orderly Network Perp.Account](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_perp.account): Orderly SDKs / Modules / @orderly.network/perp / account Namespace: account @orderly.network/perp.account Table of contents Type Aliases AccountMMRInputs AvailableBalanceInputs FreeCollateralInputs IMRInputs MaxQtyInputs OtherIMsInputs PositionNotionalWithO...
- [Orderly Network Perp](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_perp): Orderly SDKs / Modules / @orderly.network/perp Module: @orderly.network/perp Table of contents References order Namespaces account orderUtils positions Variables version References order Renames and re-exports orderUtils Variables version • version: "3.3.7"...
- [Orderly Network Perp.OrderUtils](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_perp.orderUtils): Orderly SDKs / Modules / @orderly.network/perp / orderUtils Namespace: orderUtils @orderly.network/perp.orderUtils Table of contents Type Aliases EstimatedLeverageInputs EstimatedLiquidationPriceInputs Functions estLeverage estLiqPrice maxPrice minPrice ord...
- [Orderly Network Perp.Positions](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_perp.positions): Orderly SDKs / Modules / @orderly.network/perp / positions Namespace: positions @orderly.network/perp.positions Table of contents Type Aliases LiqPriceInputs MMInputs MMRInputs TotalUnsettlementPnLInputs UnrealPnLInputs UnrealPnLROIInputs UnsettlementPnLInp...
- [Orderly Network React.Calendar](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.Calendar): Orderly SDKs / Modules / @orderly.network/react / Calendar Namespace: Calendar @orderly.network/react.Calendar Table of contents Variables displayName Variables displayName • displayName: string Defined in packages/component/src/datePicker/calendar.tsx:68
- [Orderly Network React.DialogBody](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.DialogBody): Orderly SDKs / Modules / @orderly.network/react / DialogBody Namespace: DialogBody @orderly.network/react.DialogBody Table of contents Variables displayName Variables displayName • displayName: undefined \| string Defined in packages/component/src/dialog/di...
- [Orderly Network React.DialogFooter](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.DialogFooter): Orderly SDKs / Modules / @orderly.network/react / DialogFooter Namespace: DialogFooter @orderly.network/react.DialogFooter Table of contents Variables displayName Variables displayName • displayName: string Defined in packages/component/src/dialog/dialog.ts...
- [Orderly Network React.DialogHeader](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.DialogHeader): Orderly SDKs / Modules / @orderly.network/react / DialogHeader Namespace: DialogHeader @orderly.network/react.DialogHeader Table of contents Variables displayName Variables displayName • displayName: string Defined in packages/component/src/dialog/dialog.ts...
- [Orderly Network React.DropdownMenuShortcut](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.DropdownMenuShortcut): Orderly SDKs / Modules / @orderly.network/react / DropdownMenuShortcut Namespace: DropdownMenuShortcut @orderly.network/react.DropdownMenuShortcut Table of contents Variables displayName Variables displayName • displayName: string Defined in packages/compon...
- [Orderly Network React.SheetFooter](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.SheetFooter): Orderly SDKs / Modules / @orderly.network/react / SheetFooter Namespace: SheetFooter @orderly.network/react.SheetFooter Table of contents Variables displayName Variables displayName • displayName: string Defined in packages/component/src/sheet/sheet.tsx:128
- [Orderly Network React.SheetHeader](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.SheetHeader): Orderly SDKs / Modules / @orderly.network/react / SheetHeader Namespace: SheetHeader @orderly.network/react.SheetHeader Table of contents Variables displayName Variables displayName • displayName: string Defined in packages/component/src/sheet/sheet.tsx:114
- [Orderly Network React.TabPane](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.TabPane): Orderly SDKs / Modules / @orderly.network/react / TabPane Namespace: TabPane @orderly.network/react.TabPane Table of contents Variables displayName Variables displayName • displayName: undefined \| string Defined in packages/component/src/tab/tabPane.tsx:16
- [Orderly Network React.Tooltip](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react.Tooltip): Orderly SDKs / Modules / @orderly.network/react / Tooltip Namespace: Tooltip @orderly.network/react.Tooltip Table of contents Variables displayName Variables displayName • displayName: undefined \| string Defined in packages/component/src/tooltip/tooltip.ts...
- [Orderly Network React](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_react): Orderly SDKs / Modules / @orderly.network/react Module: @orderly.network/react Table of contents References Numeral Namespaces Calendar DialogBody DialogFooter DialogHeader DropdownMenuShortcut SheetFooter SheetHeader TabPane Tooltip Enumerations ExtensionP...
- [Orderly Network Trading View](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_trading_view): Orderly SDKs / Modules / @orderly.network/trading-view Module: @orderly.network/trading-view Table of contents Enumerations ChartMode Classes Datafeed Interfaces DisplayControlSettingInterface TradingViewOptions TradingViewPorps Variables TradingViewSDKLoca...
- [Orderly Network Types.API](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_types.API): Orderly SDKs / Modules / @orderly.network/types / API Namespace: API @orderly.network/types.API Table of contents Interfaces AccountInfo AlgoOrder AlgoOrderExt Chain ChainDetail FundingRate Holding MarketInfo MarketInfoExt NetworkInfos Order OrderExt OrderR...
- [Orderly Network Types.WSMessage](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_types.WSMessage): Orderly SDKs / Modules / @orderly.network/types / WSMessage Namespace: WSMessage @orderly.network/types.WSMessage Table of contents Interfaces AlgoOrder MarkPrice Order Position Ticker VaultBalance
- [Orderly Network Types](https://orderly.network/docs/sdks/tech-doc/modules/orderly_network_types): Orderly SDKs / Modules / @orderly.network/types Module: @orderly.network/types Table of contents References Chain Namespaces API WSMessage Enumerations AccountStatusEnum AlgoOrderRootType AlgoOrderType ExchangeStatusEnum OrderSide OrderStatus OrderType Posi...

#### Interfaces

- [Orderly Network Core.AccountState](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.AccountState): Orderly SDKs / Modules / @orderly.network/core / AccountState Interface: AccountState @orderly.network/core.AccountState Table of contents Properties accountId address connectWallet isNew status userId validating Properties accountId • Optional accountId: s...
- [Orderly Network Core.ConfigStore](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.ConfigStore): Orderly SDKs / Modules / @orderly.network/core / ConfigStore Interface: ConfigStore @orderly.network/core.ConfigStore Implemented by DefaultConfigStore DefaultConfigStore Table of contents Methods clear get getOr set Methods clear ▸ clear(): void Returns vo...
- [Orderly Network Core.EventEmitter.EventEmitterStatic](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.EventEmitter.EventEmitterStatic): Orderly SDKs / Modules / @orderly.network/core / EventEmitter / EventEmitterStatic Interface: EventEmitterStatic @orderly.network/core.EventEmitter.EventEmitterStatic Table of contents Constructors constructor Constructors constructor • new EventEmitterStat...
- [Orderly Network Core.EventEmitter.ListenerFn](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.EventEmitter.ListenerFn): Orderly SDKs / Modules / @orderly.network/core / EventEmitter / ListenerFn @orderly.network/core.EventEmitter.ListenerFn Type parameters | Name | Type | | :----- | :------------------------ | | Args | extends any[] = any[] | Callable ListenerFn ▸ ListenerFn...
- [Orderly Network Core.IContract](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.IContract): Orderly SDKs / Modules / @orderly.network/core / IContract Interface: IContract @orderly.network/core.IContract Table of contents Methods getContractInfoByEnv Methods getContractInfoByEnv ▸ getContractInfoByEnv(): OrderlyContracts Returns OrderlyContracts D...
- [Orderly Network Core.OrderlyKeyPair](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair): Orderly SDKs / Modules / @orderly.network/core / OrderlyKeyPair Interface: OrderlyKeyPair @orderly.network/core.OrderlyKeyPair Implemented by BaseOrderlyKeyPair BaseOrderlyKeyPair Table of contents Properties secretKey sign Methods getPublicKey Properties s...
- [Orderly Network Core.OrderlyKeyStore](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore): Orderly SDKs / Modules / @orderly.network/core / OrderlyKeyStore Interface: OrderlyKeyStore @orderly.network/core.OrderlyKeyStore Implemented by BaseKeyStore BaseKeyStore MockKeyStore MockKeyStore Table of contents Properties cleanAllKey cleanKey generateKe...
- [Orderly Network Core.Signer](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.Signer): Orderly SDKs / Modules / @orderly.network/core / Signer Interface: Signer @orderly.network/core.Signer Singer interface Example const signer = new BaseSigner(keyStore); const payload = await signer.sign({ url: "https://api.orderly.io/get_account?address=0x1...
- [Orderly Network Core.WalletAdapter](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_core.WalletAdapter): Orderly SDKs / Modules / @orderly.network/core / WalletAdapter Interface: WalletAdapter @orderly.network/core.WalletAdapter Implemented by EtherAdapter EtherAdapter Table of contents Properties formatUnits getBalance getTransactionRecipect parseUnits pollTr...
- [Orderly Network Hooks.CallOptions](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.CallOptions): Orderly SDKs / Modules / @orderly.network/hooks / CallOptions Interface: CallOptions @orderly.network/hooks.CallOptions Hierarchy CallOptions ↳ Options ↳ Options Table of contents Properties leading trailing Properties leading • Optional leading: boolean Co...
- [Orderly Network Hooks.ConfigProviderProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.ConfigProviderProps): Orderly SDKs / Modules / @orderly.network/hooks / ConfigProviderProps Interface: ConfigProviderProps @orderly.network/hooks.ConfigProviderProps Table of contents Properties brokerId chainFilter configStore contracts getWalletAdapter keyStore networkId Prope...
- [Orderly Network Hooks.ControlFunctions](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.ControlFunctions): Orderly SDKs / Modules / @orderly.network/hooks / ControlFunctions Interface: ControlFunctions @orderly.network/hooks.ControlFunctions Hierarchy ControlFunctions ↳ DebouncedState ↳ DebouncedState Table of contents Properties cancel flush isPending Propertie...
- [Orderly Network Hooks.DebouncedState](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.DebouncedState): Orderly SDKs / Modules / @orderly.network/hooks / DebouncedState @orderly.network/hooks.DebouncedState Subsequent calls to the debounced function debounced.callback return the result of the last func invocation. Note, that if there are no previous invocatio...
- [Orderly Network Hooks.Favorite](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.Favorite): Orderly SDKs / Modules / @orderly.network/hooks / Favorite Interface: Favorite @orderly.network/hooks.Favorite Table of contents Properties name tabs Properties name • name: string Defined in packages/hooks/src/orderly/useMarkets.ts:41 --- tabs • tabs: Favo...
- [Orderly Network Hooks.FavoriteTab](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.FavoriteTab): Orderly SDKs / Modules / @orderly.network/hooks / FavoriteTab Interface: FavoriteTab @orderly.network/hooks.FavoriteTab Table of contents Properties id name Properties id • id: number Defined in packages/hooks/src/orderly/useMarkets.ts:37 --- name • name: s...
- [Orderly Network Hooks.Options](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.Options): Orderly SDKs / Modules / @orderly.network/hooks / Options Interface: Options @orderly.network/hooks.Options Hierarchy CallOptions ↳ Options Table of contents Properties leading maxWait trailing Properties leading • Optional leading: boolean Controls if the ...
- [Orderly Network Hooks.OrderlyConfigContextState](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.OrderlyConfigContextState): Orderly SDKs / Modules / @orderly.network/hooks / OrderlyConfigContextState Interface: OrderlyConfigContextState @orderly.network/hooks.OrderlyConfigContextState Table of contents Properties configStore fetcher filteredChains getWalletAdapter keyStore netwo...
- [Orderly Network Hooks.Recent](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.Recent): Orderly SDKs / Modules / @orderly.network/hooks / Recent Interface: Recent @orderly.network/hooks.Recent Table of contents Properties name Properties name • name: string Defined in packages/hooks/src/orderly/useMarkets.ts:46
- [Orderly Network Hooks.RefferalAPI.ReferralInfo](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.RefferalAPI.ReferralInfo): Orderly SDKs / Modules / @orderly.network/hooks / RefferalAPI / ReferralInfo Interface: ReferralInfo @orderly.network/hooks.RefferalAPI.ReferralInfo Table of contents Properties referee_info referrer_info Properties referee_info • referee_info: Referee Defi...
- [Orderly Network Hooks.StatusContextState](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.StatusContextState): Orderly SDKs / Modules / @orderly.network/hooks / StatusContextState Interface: StatusContextState @orderly.network/hooks.StatusContextState Table of contents Properties ws Properties ws • Optional ws: WsNetworkStatus Defined in packages/hooks/src/statusPro...
- [Orderly Network Hooks.WalletAdapter](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_hooks.WalletAdapter): Orderly SDKs / Modules / @orderly.network/hooks / WalletAdapter Interface: WalletAdapter @orderly.network/hooks.WalletAdapter Table of contents Properties formatUnits getBalance getTransactionRecipect parseUnits pollTransactionReceiptWithBackoff send signTy...
- [Orderly Network React.AccountStatusProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.AccountStatusProps): Orderly SDKs / Modules / @orderly.network/react / AccountStatusProps Interface: AccountStatusProps @orderly.network/react.AccountStatusProps Table of contents Properties accountInfo address balance chains className currency loading onConnect onDisconnect sh...
- [Orderly Network React.DepositProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.DepositProps): Orderly SDKs / Modules / @orderly.network/react / DepositProps Interface: DepositProps @orderly.network/react.DepositProps Table of contents Properties onCancel onOk Properties onCancel • Optional onCancel: () => void Type declaration ▸ (): void Returns voi...
- [Orderly Network React.InputProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.InputProps): Orderly SDKs / Modules / @orderly.network/react / InputProps Interface: InputProps @orderly.network/react.InputProps Hierarchy Omit\<InputHTMLAttributes\<HTMLInputElement\>, "size" \| "prefix" \| "disabled" \| "inputMode"\> ↳ InputProps Table of contents Pr...
- [Orderly Network React.MarketsProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.MarketsProps): Orderly SDKs / Modules / @orderly.network/react / MarketsProps Interface: MarketsProps @orderly.network/react.MarketsProps Table of contents Properties className dataSource onItemClick Properties className • Optional className: string Defined in packages/co...
- [Orderly Network React.ModalHocProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.ModalHocProps): Orderly SDKs / Modules / @orderly.network/react / ModalHocProps Interface: ModalHocProps @orderly.network/react.ModalHocProps Table of contents Properties defaultVisible id keepMounted Properties defaultVisible • Optional defaultVisible: boolean Defined in ...
- [Orderly Network React.OrderBookProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.OrderBookProps): Orderly SDKs / Modules / @orderly.network/react / OrderBookProps Interface: OrderBookProps @orderly.network/react.OrderBookProps Table of contents Properties activeDepth asks autoSize base bids cellHeight className depth isLoading lastPrice level markPrice ...
- [Orderly Network React.OrderEntryProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.OrderEntryProps): Orderly SDKs / Modules / @orderly.network/react / OrderEntryProps Interface: OrderEntryProps @orderly.network/react.OrderEntryProps Table of contents Properties disabled estLeverage estLiqPrice formattedOrder freeCollateral helper markPrice maxQty metaState...
- [Orderly Network React.OrdersViewProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.OrdersViewProps): Orderly SDKs / Modules / @orderly.network/react / OrdersViewProps Interface: OrdersViewProps @orderly.network/react.OrdersViewProps Table of contents Properties cancelAlgoOrder cancelOrder cancelTPSLOrder dataSource editAlgoOrder editOrder isLoading isStopO...
- [Orderly Network React.PositionsViewProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.PositionsViewProps): Orderly SDKs / Modules / @orderly.network/react / PositionsViewProps Interface: PositionsViewProps @orderly.network/react.PositionsViewProps Table of contents Properties aggregated dataSource isLoading loadMore onLimitClose onMarketClose onMarketCloseAll on...
- [Orderly Network React.TabContextState](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.TabContextState): Orderly SDKs / Modules / @orderly.network/react / TabContextState Interface: TabContextState @orderly.network/react.TabContextState Table of contents Properties contentVisible data height toggleContentVisible updateData Properties contentVisible • contentVi...
- [Orderly Network React.TabPaneProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.TabPaneProps): Orderly SDKs / Modules / @orderly.network/react / TabPaneProps Interface: TabPaneProps @orderly.network/react.TabPaneProps Table of contents Properties active className disabled id title value Properties active • Optional active: boolean Defined in packages...
- [Orderly Network React.TradeHistoryProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.TradeHistoryProps): Orderly SDKs / Modules / @orderly.network/react / TradeHistoryProps Interface: TradeHistoryProps @orderly.network/react.TradeHistoryProps Table of contents Properties className dataSource headerClassName loading Properties className • Optional className: st...
- [Orderly Network React.TradingPageContextValue](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.TradingPageContextValue): Orderly SDKs / Modules / @orderly.network/react / TradingPageContextValue Interface: TradingPageContextValue @orderly.network/react.TradingPageContextValue Table of contents Properties disableFeatures onSymbolChange overrides symbol Properties disableFeatur...
- [Orderly Network React.WithdrawProps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_react.WithdrawProps): Orderly SDKs / Modules / @orderly.network/react / WithdrawProps Interface: WithdrawProps @orderly.network/react.WithdrawProps Table of contents Properties onCancel onOk Properties onCancel • Optional onCancel: () => void Type declaration ▸ (): void Returns ...
- [Orderly Network Trading View.DisplayControlSettingInterface](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_trading_view.DisplayControlSettingInterface): Orderly SDKs / Modules / @orderly.network/trading-view / DisplayControlSettingInterface Interface: DisplayControlSettingInterface @orderly.network/trading-view.DisplayControlSettingInterface Table of contents Properties buySell limitOrders position position...
- [Orderly Network Trading View.TradingViewOptions](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_trading_view.TradingViewOptions): Orderly SDKs / Modules / @orderly.network/trading-view / TradingViewOptions Interface: TradingViewOptions @orderly.network/trading-view.TradingViewOptions
- [Orderly Network Trading View.TradingViewPorps](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_trading_view.TradingViewPorps): Orderly SDKs / Modules / @orderly.network/trading-view / TradingViewPorps Interface: TradingViewPorps @orderly.network/trading-view.TradingViewPorps Table of contents Properties closePositionConfirmCallback colorConfig displayControlSetting fullscreen inter...
- [Orderly Network Types.API.AccountInfo](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.AccountInfo): Orderly SDKs / Modules / @orderly.network/types / API / AccountInfo Interface: AccountInfo @orderly.network/types.API.AccountInfo Table of contents Properties account_id account_mode email futures_maker_fee_rate futures_taker_fee_rate futures_tier imr_facto...
- [Orderly Network Types.API.AlgoOrder](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.AlgoOrder): Orderly SDKs / Modules / @orderly.network/types / API / AlgoOrder Interface: AlgoOrder @orderly.network/types.API.AlgoOrder Hierarchy AlgoOrder ↳ AlgoOrderExt ↳ AlgoOrderExt Table of contents Properties algo_order_id algo_status algo_type child_orders creat...
- [Orderly Network Types.API.AlgoOrderExt](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.AlgoOrderExt): Orderly SDKs / Modules / @orderly.network/types / API / AlgoOrderExt Interface: AlgoOrderExt @orderly.network/types.API.AlgoOrderExt Hierarchy AlgoOrder ↳ AlgoOrderExt Table of contents Properties algo_order_id algo_status algo_type child_orders created_tim...
- [Orderly Network Types.API.Chain](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.Chain): Orderly SDKs / Modules / @orderly.network/types / API / Chain Interface: Chain @orderly.network/types.API.Chain Table of contents Properties chain_details decimals dexs minimum_withdraw_amount nativeToken network_infos token token_hash token_infos Propertie...
- [Orderly Network Types.API.ChainDetail](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.ChainDetail): Orderly SDKs / Modules / @orderly.network/types / API / ChainDetail Interface: ChainDetail @orderly.network/types.API.ChainDetail Table of contents Properties chain_id chain_name contract_address decimals withdrawal_fee Properties chain_id • chain_id: strin...
- [Orderly Network Types.API.FundingRate](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.FundingRate): Orderly SDKs / Modules / @orderly.network/types / API / FundingRate Interface: FundingRate @orderly.network/types.API.FundingRate Table of contents Properties est_funding_rate est_funding_rate_timestamp last_funding_rate last_funding_rate_timestamp next_fun...
- [Orderly Network Types.API.Holding](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.Holding): Orderly SDKs / Modules / @orderly.network/types / API / Holding Interface: Holding @orderly.network/types.API.Holding Table of contents Properties frozen holding pending_short token updated_time Properties frozen • frozen: number Defined in packages/types/s...
- [Orderly Network Types.API.MarketInfo](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfo): Orderly SDKs / Modules / @orderly.network/types / API / MarketInfo Interface: MarketInfo @orderly.network/types.API.MarketInfo Hierarchy MarketInfo ↳ MarketInfoExt ↳ MarketInfoExt Table of contents Properties 24h_amount 24h_close 24h_high 24h_low 24h_open 2...
- [Orderly Network Types.API.MarketInfoExt](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.MarketInfoExt): Orderly SDKs / Modules / @orderly.network/types / API / MarketInfoExt Interface: MarketInfoExt @orderly.network/types.API.MarketInfoExt Hierarchy MarketInfo ↳ MarketInfoExt Table of contents Properties 24h_amount 24h_close 24h_high 24h_low 24h_open 24h_volu...
- [Orderly Network Types.API.NetworkInfos](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.NetworkInfos): Orderly SDKs / Modules / @orderly.network/types / API / NetworkInfos Interface: NetworkInfos @orderly.network/types.API.NetworkInfos Table of contents Properties bridge_enable bridgeless chain_id currency_symbol est_txn_mins explorer_base_url mainnet minimu...
- [Orderly Network Types.API.Order](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.Order): Orderly SDKs / Modules / @orderly.network/types / API / Order Interface: Order @orderly.network/types.API.Order Hierarchy Order ↳ OrderExt ↳ OrderExt Table of contents Properties algo_order_id amount average_executed_price client_order_id created_time execu...
- [Orderly Network Types.API.OrderExt](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.OrderExt): Orderly SDKs / Modules / @orderly.network/types / API / OrderExt Interface: OrderExt @orderly.network/types.API.OrderExt Hierarchy Order ↳ OrderExt Table of contents Properties algo_order_id amount average_executed_price client_order_id created_time execute...
- [Orderly Network Types.API.OrderResponse](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.OrderResponse): Orderly SDKs / Modules / @orderly.network/types / API / OrderResponse Interface: OrderResponse @orderly.network/types.API.OrderResponse Table of contents Properties meta rows Properties meta • meta: Object Type declaration | Name | Type | | :---------------...
- [Orderly Network Types.API.Position](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.Position): Orderly SDKs / Modules / @orderly.network/types / API / Position Interface: Position @orderly.network/types.API.Position Hierarchy Position ↳ PositionExt ↳ PositionExt Table of contents Properties IMR_withdraw_orders MMR_with_orders average_open_price cost_...
- [Orderly Network Types.API.PositionExt](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.PositionExt): Orderly SDKs / Modules / @orderly.network/types / API / PositionExt Interface: PositionExt @orderly.network/types.API.PositionExt Hierarchy Position ↳ PositionExt ↳↳ PositionTPSLExt ↳↳ PositionTPSLExt Table of contents Properties IMR_withdraw_orders MMR_wit...
- [Orderly Network Types.API.PositionInfo](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.PositionInfo): Orderly SDKs / Modules / @orderly.network/types / API / PositionInfo Interface: PositionInfo @orderly.network/types.API.PositionInfo Table of contents Properties current_margin_ratio_with_orders free_collateral initial_margin_ratio initial_margin_ratio_with...
- [Orderly Network Types.API.PositionTPSLExt](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.PositionTPSLExt): Orderly SDKs / Modules / @orderly.network/types / API / PositionTPSLExt Interface: PositionTPSLExt @orderly.network/types.API.PositionTPSLExt Hierarchy PositionExt ↳ PositionTPSLExt Table of contents Properties IMR_withdraw_orders MMR_with_orders algo_order...
- [Orderly Network Types.API.Symbol](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.Symbol): Orderly SDKs / Modules / @orderly.network/types / API / Symbol Interface: Symbol @orderly.network/types.API.Symbol v1/public/info Hierarchy Symbol ↳ SymbolExt ↳ SymbolExt Table of contents Properties base_imr base_max base_min base_mmr base_tick cap_funding...
- [Orderly Network Types.API.SymbolExt](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.SymbolExt): Orderly SDKs / Modules / @orderly.network/types / API / SymbolExt Interface: SymbolExt @orderly.network/types.API.SymbolExt v1/public/info Hierarchy Symbol ↳ SymbolExt Table of contents Properties base base_dp base_imr base_max base_min base_mmr base_tick c...
- [Orderly Network Types.API.Token](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.Token): Orderly SDKs / Modules / @orderly.network/types / API / Token Interface: Token @orderly.network/types.API.Token Table of contents Properties chain_details decimals minimum_withdraw_amount token token_hash Properties chain_details • chain_details: ChainDetai...
- [Orderly Network Types.API.TokenInfo](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.TokenInfo): Orderly SDKs / Modules / @orderly.network/types / API / TokenInfo Interface: TokenInfo @orderly.network/types.API.TokenInfo Table of contents Properties address decimals display_name symbol Properties address • address: string Defined in packages/types/src/...
- [Orderly Network Types.API.TokenItem](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.TokenItem): Orderly SDKs / Modules / @orderly.network/types / API / TokenItem Interface: TokenItem @orderly.network/types.API.TokenItem Table of contents Properties chain_details decimals minimum_withdraw_amount token token_hash Properties chain_details • chain_details...
- [Orderly Network Types.API.Trade](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.API.Trade): Orderly SDKs / Modules / @orderly.network/types / API / Trade Interface: Trade @orderly.network/types.API.Trade Table of contents Properties executed_price executed_quantity executed_timestamp side symbol ts Properties executed_price • executed_price: numbe...
- [Orderly Network Types.BaseAlgoOrderEntity](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.BaseAlgoOrderEntity): Orderly SDKs / Modules / @orderly.network/types / BaseAlgoOrderEntity @orderly.network/types.BaseAlgoOrderEntity Type parameters | Name | Type | | :--- | :------------------------------------------------------------------------------------------ | | T | ext...
- [Orderly Network Types.ChainConfig](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.ChainConfig): Orderly SDKs / Modules / @orderly.network/types / ChainConfig Interface: ChainConfig @orderly.network/types.ChainConfig Table of contents Properties blockExplorerName chainInfo chainLogo chainName chainNameShort id maxPrepayCrossGas minCrossGasBalance minGa...
- [Orderly Network Types.ChainInfo](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.ChainInfo): Orderly SDKs / Modules / @orderly.network/types / ChainInfo Interface: ChainInfo @orderly.network/types.ChainInfo Table of contents Properties blockExplorerUrls chainId chainName nativeCurrency rpcUrls Properties blockExplorerUrls • blockExplorerUrls: strin...
- [Orderly Network Types.NativeCurrency](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.NativeCurrency): Orderly SDKs / Modules / @orderly.network/types / NativeCurrency Interface: NativeCurrency @orderly.network/types.NativeCurrency Table of contents Properties decimals fix name symbol Properties decimals • decimals: number Defined in packages/types/src/chain...
- [Orderly Network Types.OrderEntity](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.OrderEntity): Orderly SDKs / Modules / @orderly.network/types / OrderEntity Interface: OrderEntity @orderly.network/types.OrderEntity Hierarchy OrderEntity ↳ BaseAlgoOrderEntity ↳ BaseAlgoOrderEntity Table of contents Properties algo_type broker_id isStopOrder order_amou...
- [Orderly Network Types.WSMessage.AlgoOrder](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.AlgoOrder): Orderly SDKs / Modules / @orderly.network/types / WSMessage / AlgoOrder Interface: AlgoOrder @orderly.network/types.WSMessage.AlgoOrder Table of contents Properties algoOrderId algoStatus algoType averageExecutedPrice executedPrice executedQuantity fee feeA...
- [Orderly Network Types.WSMessage.MarkPrice](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.MarkPrice): Orderly SDKs / Modules / @orderly.network/types / WSMessage / MarkPrice Interface: MarkPrice @orderly.network/types.WSMessage.MarkPrice Table of contents Properties price symbol Properties price • price: number Defined in packages/types/src/types/api.ts:336...
- [Orderly Network Types.WSMessage.Order](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.Order): Orderly SDKs / Modules / @orderly.network/types / WSMessage / Order Interface: Order @orderly.network/types.WSMessage.Order Table of contents Properties avgPrice clientOrderId executedPrice executedQuantity fee feeAsset maker orderId price quantity reason r...
- [Orderly Network Types.WSMessage.Position](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.Position): Orderly SDKs / Modules / @orderly.network/types / WSMessage / Position Interface: Position @orderly.network/types.WSMessage.Position Table of contents Properties averageOpenPrice costPosition estLiqPrice fee24H imr imrwithOrders lastSumUnitaryFunding markPr...
- [Orderly Network Types.WSMessage.Ticker](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.Ticker): Orderly SDKs / Modules / @orderly.network/types / WSMessage / Ticker Interface: Ticker @orderly.network/types.WSMessage.Ticker Table of contents Properties amount close count high low open symbol volume Properties amount • amount: number Defined in packages...
- [Orderly Network Types.WSMessage.VaultBalance](https://orderly.network/docs/sdks/tech-doc/interfaces/orderly_network_types.WSMessage.VaultBalance): Orderly SDKs / Modules / @orderly.network/types / WSMessage / VaultBalance Interface: VaultBalance @orderly.network/types.WSMessage.VaultBalance Table of contents Properties balance chain_id token Properties balance • balance: number Defined in packages/typ...

#### Enums

- [Orderly Network Hooks.MarketsType](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_hooks.MarketsType): Orderly SDKs / Modules / @orderly.network/hooks / MarketsType Enumeration: MarketsType @orderly.network/hooks.MarketsType Table of contents Enumeration Members ALL FAVORITES RECENT Enumeration Members ALL • ALL = 2 Defined in packages/hooks/src/orderly/useM...
- [Orderly Network Hooks.WsNetworkStatus](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_hooks.WsNetworkStatus): Orderly SDKs / Modules / @orderly.network/hooks / WsNetworkStatus Enumeration: WsNetworkStatus @orderly.network/hooks.WsNetworkStatus Table of contents Enumeration Members Connected Disconnected Unstable Enumeration Members Connected • Connected = "connecte...
- [Orderly Network Net.WebSocketEvent](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_net.WebSocketEvent): Orderly SDKs / Modules / @orderly.network/net / WebSocketEvent Enumeration: WebSocketEvent @orderly.network/net.WebSocketEvent Table of contents Enumeration Members CLOSE CONNECTING ERROR MESSAGE OPEN RECONNECTING Enumeration Members CLOSE • CLOSE = "close"...
- [Orderly Network React.ExtensionPosition](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_react.ExtensionPosition): Orderly SDKs / Modules / @orderly.network/react / ExtensionPosition Enumeration: ExtensionPosition @orderly.network/react.ExtensionPosition Table of contents Enumeration Members DepositForm WithdrawForm Enumeration Members DepositForm • DepositForm = "depos...
- [Orderly Network React.TradingFeatures](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_react.TradingFeatures): Orderly SDKs / Modules / @orderly.network/react / TradingFeatures Enumeration: TradingFeatures @orderly.network/react.TradingFeatures Table of contents Enumeration Members AssetAndMarginInfo Footer Header Kline OrderBook Orders Positions Sider TopNavBar Tra...
- [Orderly Network Trading View.ChartMode](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_trading_view.ChartMode): Orderly SDKs / Modules / @orderly.network/trading-view / ChartMode Enumeration: ChartMode @orderly.network/trading-view.ChartMode Table of contents Enumeration Members ADVANCED BASIC MOBILE UNLIMITED Enumeration Members ADVANCED • ADVANCED = 1 Defined in tr...
- [Orderly Network Types.AccountStatusEnum](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.AccountStatusEnum): Orderly SDKs / Modules / @orderly.network/types / AccountStatusEnum Enumeration: AccountStatusEnum @orderly.network/types.AccountStatusEnum Table of contents Enumeration Members Connected DisabledTrading EnableTrading NotConnected NotSignedIn SignedIn Enume...
- [Orderly Network Types.AlgoOrderRootType](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.AlgoOrderRootType): Orderly SDKs / Modules / @orderly.network/types / AlgoOrderRootType Enumeration: AlgoOrderRootType @orderly.network/types.AlgoOrderRootType Table of contents Enumeration Members POSITIONAL_TP_SL STOP TP_SL Enumeration Members POSITIONAL_TP_SL • POSITIONAL_T...
- [Orderly Network Types.AlgoOrderType](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.AlgoOrderType): Orderly SDKs / Modules / @orderly.network/types / AlgoOrderType Enumeration: AlgoOrderType @orderly.network/types.AlgoOrderType Table of contents Enumeration Members STOP_LOSS TAKE_PROFIT Enumeration Members STOP_LOSS • STOP_LOSS = "STOP_LOSS" Defined in pa...
- [Orderly Network Types.ExchangeStatusEnum](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.ExchangeStatusEnum): Orderly SDKs / Modules / @orderly.network/types / ExchangeStatusEnum Enumeration: ExchangeStatusEnum @orderly.network/types.ExchangeStatusEnum Table of contents Enumeration Members Maintain Normal Enumeration Members Maintain • Maintain = 1 Defined in packa...
- [Orderly Network Types.OrderSide](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.OrderSide): Orderly SDKs / Modules / @orderly.network/types / OrderSide Enumeration: OrderSide @orderly.network/types.OrderSide Table of contents Enumeration Members BUY SELL Enumeration Members BUY • BUY = "BUY" Defined in packages/types/src/order.ts:36 --- SELL • SEL...
- [Orderly Network Types.OrderStatus](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.OrderStatus): Orderly SDKs / Modules / @orderly.network/types / OrderStatus Enumeration: OrderStatus @orderly.network/types.OrderStatus Table of contents Enumeration Members CANCELLED COMPLETED FILLED INCOMPLETE NEW OPEN PARTIAL_FILLED REJECTED REPLACED Enumeration Membe...
- [Orderly Network Types.OrderType](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.OrderType): Orderly SDKs / Modules / @orderly.network/types / OrderType Enumeration: OrderType @orderly.network/types.OrderType Supported types for placing an order Table of contents Enumeration Members ASK BID CLOSE_POSITION FOK IOC LIMIT MARKET POST_ONLY STOP_LIMIT S...
- [Orderly Network Types.PositionSide](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.PositionSide): Orderly SDKs / Modules / @orderly.network/types / PositionSide Enumeration: PositionSide @orderly.network/types.PositionSide Table of contents Enumeration Members LONG SHORT Enumeration Members LONG • LONG = "LONG" Defined in packages/types/src/order.ts:41 ...
- [Orderly Network Types.SystemStateEnum](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.SystemStateEnum): Orderly SDKs / Modules / @orderly.network/types / SystemStateEnum Enumeration: SystemStateEnum @orderly.network/types.SystemStateEnum Table of contents Enumeration Members Error Loading Ready Enumeration Members Error • Error = 1 Defined in packages/types/s...
- [Orderly Network Types.TriggerPriceType](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.TriggerPriceType): Orderly SDKs / Modules / @orderly.network/types / TriggerPriceType Enumeration: TriggerPriceType @orderly.network/types.TriggerPriceType Table of contents Enumeration Members MARK_PRICE Enumeration Members MARK_PRICE • MARK_PRICE = "MARK_PRICE" Defined in p...
- [Orderly Network Types.WS WalletStatusEnum](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.WS_WalletStatusEnum): Orderly SDKs / Modules / @orderly.network/types / WS_WalletStatusEnum Enumeration: WS_WalletStatusEnum @orderly.network/types.WS_WalletStatusEnum Table of contents Enumeration Members COMPLETED FAILED NO PENDING PROCESSING Enumeration Members COMPLETED • CO...
- [Orderly Network Types.WithdrawStatus](https://orderly.network/docs/sdks/tech-doc/enums/orderly_network_types.WithdrawStatus): Orderly SDKs / Modules / @orderly.network/types / WithdrawStatus Enumeration: WithdrawStatus @orderly.network/types.WithdrawStatus Table of contents Enumeration Members InsufficientBalance Normal NotConnected NotSupported Unsettle Enumeration Members Insuff...

#### Classes

- [Orderly Network Core.Account](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.Account): Orderly SDKs / Modules / @orderly.network/core / Account Class: Account @orderly.network/core.Account Account Example const account = new Account(); account.login("0x1234567890"); Table of contents Constructors constructor Properties \_ee \_singer \_state a...
- [Orderly Network Core.BaseKeyStore](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore): Orderly SDKs / Modules / @orderly.network/core / BaseKeyStore Class: BaseKeyStore @orderly.network/core.BaseKeyStore Hierarchy BaseKeyStore ↳ LocalStorageStore ↳ LocalStorageStore Implements OrderlyKeyStore Table of contents Constructors constructor Propert...
- [Orderly Network Core.BaseOrderlyKeyPair](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.BaseOrderlyKeyPair): Orderly SDKs / Modules / @orderly.network/core / BaseOrderlyKeyPair Class: BaseOrderlyKeyPair @orderly.network/core.BaseOrderlyKeyPair Implements OrderlyKeyPair Table of contents Constructors constructor Properties privateKey secretKey Methods getPublicKey ...
- [Orderly Network Core.BaseSigner](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.BaseSigner): Orderly SDKs / Modules / @orderly.network/core / BaseSigner Class: BaseSigner @orderly.network/core.BaseSigner Singer interface Example const signer = new BaseSigner(keyStore); const payload = await signer.sign({ url: "https://api.orderly.io/get_account?add...
- [Orderly Network Core.DefaultConfigStore](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.DefaultConfigStore): Orderly SDKs / Modules / @orderly.network/core / DefaultConfigStore Class: DefaultConfigStore @orderly.network/core.DefaultConfigStore Implements ConfigStore Table of contents Constructors constructor Properties map Methods clear get getOr set Constructors ...
- [Orderly Network Core.EtherAdapter](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.EtherAdapter): Orderly SDKs / Modules / @orderly.network/core / EtherAdapter Class: EtherAdapter @orderly.network/core.EtherAdapter Implements WalletAdapter Table of contents Constructors constructor Properties \_address \_chainId provider Accessors addresses chainId Meth...
- [Orderly Network Core.EventEmitter 1](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.EventEmitter-1): Orderly SDKs / Modules / @orderly.network/core / EventEmitter @orderly.network/core.EventEmitter Minimal EventEmitter interface that is molded against the Node.js EventEmitter interface. Type parameters | Name | Type | | :----------- | :--------------------...
- [Orderly Network Core.LocalStorageStore](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.LocalStorageStore): Orderly SDKs / Modules / @orderly.network/core / LocalStorageStore Class: LocalStorageStore @orderly.network/core.LocalStorageStore Hierarchy BaseKeyStore ↳ LocalStorageStore Table of contents Constructors constructor Accessors keyPrefix Methods cleanAllKey...
- [Orderly Network Core.MockKeyStore](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.MockKeyStore): Orderly SDKs / Modules / @orderly.network/core / MockKeyStore Class: MockKeyStore @orderly.network/core.MockKeyStore Implements OrderlyKeyStore Table of contents Constructors constructor Properties secretKey Methods cleanAllKey cleanKey generateKey getAccou...
- [Orderly Network Core.SimpleDI](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_core.SimpleDI): Orderly SDKs / Modules / @orderly.network/core / SimpleDI Class: SimpleDI @orderly.network/core.SimpleDI Table of contents Constructors constructor Properties KEY container Methods get getAll getContainer getOr register registerByName Constructors construct...
- [Orderly Network Net.WS](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_net.WS): Orderly SDKs / Modules / @orderly.network/net / WS Class: WS @orderly.network/net.WS Table of contents Constructors constructor Properties \_eventContainer \_eventHandlers \_eventPrivateHandlers \_pendingPrivateSubscribe \_pendingPublicSubscribe \_privateHe...
- [Orderly Network Trading View.Datafeed](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_trading_view.Datafeed): Orderly SDKs / Modules / @orderly.network/trading-view / Datafeed Class: Datafeed @orderly.network/trading-view.Datafeed Hierarchy AbstractDatafeed ↳ Datafeed Table of contents Constructors constructor Properties \_configuration \_prefixId \_publicWs \_subs...
- [Orderly Network Types.ApiError](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_types.ApiError): Orderly SDKs / Modules / @orderly.network/types / ApiError Class: ApiError @orderly.network/types.ApiError Hierarchy Error ↳ ApiError Table of contents Constructors constructor Properties code message name stack Constructors constructor • new ApiError(messa...
- [Orderly Network Types.SDKError](https://orderly.network/docs/sdks/tech-doc/classes/orderly_network_types.SDKError): Orderly SDKs / Modules / @orderly.network/types / SDKError Class: SDKError @orderly.network/types.SDKError Hierarchy Error ↳ SDKError Table of contents Constructors constructor Properties message name stack Constructors constructor • new SDKError(message) P...


## Strategy vault

### Overview & FAQ

- [Overview](https://orderly.network/docs/introduction/orderly-omniVault/overview): Explore Orderly OmniVault, an omnichain strategy vault for earning yield through market-maker strategies.
- [Mechanics](https://orderly.network/docs/introduction/orderly-omniVault/mechanics): Understand how OmniVault shares, deposits, withdrawals, and PnL distribution work.
- [Liquidity Provider](https://orderly.network/docs/introduction/orderly-omniVault/liquidity-provider): Learn how to deposit into and withdraw from Orderly OmniVault as a liquidity provider.
- [FAQ](https://orderly.network/docs/introduction/orderly-omniVault/faq): Find answers to frequently asked questions about Orderly OmniVault, covering fees, risks, and transactions.

### Vault API

#### Vault details

- [Vault Info](https://orderly.network/docs/strategy-vault/vault/public/vault-info): [GET /v1/public/strategy_vault/vault/info] Get Strategy Vault Info

#### Vault statistics

- [Vault Overall Statistics](https://orderly.network/docs/strategy-vault/vault/public/vault-overall-statistics): [GET /v1/public/strategy_vault/vault/overall_info] Get Overall Statistics of all Strategy Vaults
- [User Overall Statistics](https://orderly.network/docs/strategy-vault/vault/public/user-overall-statistics): [GET /v1/public/strategy_vault/user/overall_info] Get User Overall Statistics across Strategy Vaults
- [Vault Performance](https://orderly.network/docs/strategy-vault/vault/public/vault-performance): [GET /v1/public/strategy_vault/vault/performance] Get Strategy Vault Performance
- [Vault Performance Chart](https://orderly.network/docs/strategy-vault/vault/public/vault-performance-chart): [GET /v1/public/strategy_vault/vault/performance_chart] Get Strategy Vault TVL/PnL History

#### Order management

- [Vault Positions](https://orderly.network/docs/strategy-vault/vault/public/vault-positions): [GET /v1/public/strategy_vault/vault/positions] Get Strategy Vault Positions
- [Vault Open Orders](https://orderly.network/docs/strategy-vault/vault/public/vault-open-orders): [GET /v1/public/strategy_vault/vault/open_orders] Get Strategy Vault Open Orders
- [Get Strategy Vault Order History](https://orderly.network/docs/strategy-vault/vault/public/get-strategy-vault-order-history): [GET /v1/public/strategy_vault/vault/order_history] Get Strategy Vault Order History
- [Vault Trade History](https://orderly.network/docs/strategy-vault/vault/public/vault-trade-history): [GET /v1/public/strategy_vault/vault/trade_history] Get Strategy Vault Trade History
- [Vault Liquidator History](https://orderly.network/docs/strategy-vault/vault/public/vault-liquidator-history): [GET /v1/public/strategy_vault/vault/liquidator_history] Get Strategy Vault Liquidator History

- [Supplemental Terms for Community Strategy Vault](https://orderly.network/docs/strategy-vault/vault/public/supplemental-terms): These Supplemental Terms apply to your use of the Community Strategy Vaults, a self-custody smart contract interface provided by Orderly. These Supplemental Terms form part of the Orderly Network Ltd. General Terms of Service (the "Terms"), and are Suppleme...

### Liquidity provider

#### Liquidity provider details

- [Lp Info](https://orderly.network/docs/strategy-vault/liquidity-provider/public/lp-info): [GET /v1/public/strategy_vault/lp/info] Get Liquidity Provider Info

#### Liquidity provider statistics

- [Lp Performance](https://orderly.network/docs/strategy-vault/liquidity-provider/public/lp-performance): [GET /v1/public/strategy_vault/lp/performance] Get Liquidity Provider Performance
- [Lp Performance Chart](https://orderly.network/docs/strategy-vault/liquidity-provider/public/lp-performance-chart): [GET /v1/public/strategy_vault/lp/performance_chart] Get Liquidity Provider TVL/PnL History

#### Deposit/withdrawal

- [Lp Transaction History](https://orderly.network/docs/strategy-vault/liquidity-provider/public/lp-transaction-history): [GET /v1/public/strategy_vault/lp/transaction_history] Get Liquidity Provider Transaction History
- [Lp Claim Info](https://orderly.network/docs/strategy-vault/liquidity-provider/public/lp-claim-info): [GET /v1/public/strategy_vault/lp/claim_info] Get Liquidity Provider Claim Info

#### Fees

- [Fees History](https://orderly.network/docs/strategy-vault/liquidity-provider/public/fees-history): [GET /v1/public/strategy_vault/lp/fees_history] Get Liquidity Provider Fee History


### Strategy provider

#### Key management

- [Add Sp Orderly Key](https://orderly.network/docs/strategy-vault/strategy-provider/private/add-sp-orderly-key): [POST /v1/sv/sp_orderly_key] Add SP Orderly key

#### Settle PnL

- [Request Sp Pnl Settlement](https://orderly.network/docs/strategy-vault/strategy-provider/private/request-sp-pnl-settlement): [POST /v1/sv/sp_settle_pnl] Request SP PnL settlement

#### Strategy provider details

- [Get Strategy Providers Info](https://orderly.network/docs/strategy-vault/strategy-provider/public/get-strategy-providers-info): [GET /v1/public/strategy_vault/sp/info] Get Strategy Provider’s Info

#### Deposit/withdrawal

- [Sp Transaction History](https://orderly.network/docs/strategy-vault/strategy-provider/public/sp-transaction-history): [GET /v1/public/strategy_vault/sp/transaction_history] Get Strategy Provider Transaction History
- [Sp Claim Info](https://orderly.network/docs/strategy-vault/strategy-provider/public/sp-claim-info): [GET /v1/public/strategy_vault/sp/claim_info] Get Strategy Provider Claimable Amount

#### Fees

- [Sp Fees History](https://orderly.network/docs/strategy-vault/strategy-provider/public/sp-fees-history): [GET /v1/public/strategy_vault/sp/fees_history] Get Strategy Provider Fee History

#### Period obligations

- [Trigger Manual Period Delivery](https://orderly.network/docs/strategy-vault/strategy-provider/private/trigger-manual-period-delivery): [POST /v1/sv/manual_period_delivery] Trigger manual period delivery


### Strategy fund

#### Strategy fund details

- [Get Strategy Fund Details](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-strategy-fund-details): [GET /v1/public/strategy_vault/fund/info] Get Strategy Fund Details

#### Period details

- [Get Period History And Fund Period Instructions](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-period-history-and-fund-period-instructions): [GET /v1/public/strategy_vault/fund/period_info] Get Period History and Fund Period Instructions

#### Fund transactions

- [Get Preview Users Pending Requests](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-preview-users-pending-requests): [GET /v1/public/strategy_vault/fund/pending_transactions] Get Preview Users Pending Requests
- [Get Fund Inflow Allocation](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-fund-inflow-allocation): [GET /v1/sv/venue_transfer_history] Get fund inflow allocation
- [Get Fund Outflow Allocation](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-fund-outflow-allocation): [GET /v1/sv/venue_withdrawal_history] Get fund outflow allocation
- [Get Orderly Protocol Revenue Sharing History](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-orderly-protocol-revenue-sharing-history): [GET /v1/sv/protocol_revenue_share_history] Get Orderly protocol revenue sharing history
- [Get Liquidation Fees Sharing History](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-liquidation-fees-sharing-history): [GET /v1/sv/liquidation_fees_share_history] Get liquidation fees sharing history
- [Get Internal Transfer History](https://orderly.network/docs/strategy-vault/strategy-fund/public/get-internal-transfer-history): [GET /v1/sv/internal_transfer_history] Get internal transfer history


## Troubleshooting

### Introduction

- [Introduction overview](https://orderly.network/docs/troubleshooting/introduction): Starting point for diagnosing integration, account, transaction, and trading issues on Orderly.

### User issues

- [Transaction/order issues](https://orderly.network/docs/troubleshooting/user-issues/transaction-failures): How to triage failed transactions and orders by separating on-chain from API-level failures.
- [Stuck/delayed withdrawals](https://orderly.network/docs/troubleshooting/user-issues/withdrawal-issues): How to diagnose delayed or stuck withdrawals by checking LayerZero messaging and chain status.
- [Stuck/delayed deposits](https://orderly.network/docs/troubleshooting/user-issues/deposit-issues): How to diagnose and resolve delayed or stuck deposits using the Dune dashboard and support channels.
- [Liquidation issues](https://orderly.network/docs/troubleshooting/user-issues/liquidation-issues): How to investigate unexpected liquidations by reviewing margin requirements and market volatility.
- [Orders/position not closing at expected prices](https://orderly.network/docs/troubleshooting/user-issues/wrong-execution-price): How to investigate orders that did not execute at the expected price due to slippage or order type.

## Release notes

### Updates by area

- [Omnichain](https://orderly.network/docs/release-notes/omnichain): Release notes for the Omnichain platform
- [TypeScript SDK](https://orderly.network/docs/release-notes/sdk): Release notes for the Orderly TypeScript SDK

### Classification

- [Release Classification](https://orderly.network/docs/release-notes/classification): Classification of releases