Orderly home pagelight logodark logo
  • Socials
  • Get in Touch
  • Get a Grant
  • Get a Grant
Home
Introduction
Build on Omnichain
NEAR
SDKs
Strategy Vault
Troubleshooting
Changelog
Getting Started
  • System Overview
  • Smart Contract Overview
  • Smart Contract Addresses
Partner Support
  • Partner Support
  • Integration Checklist
  • Integration FAQs
User Flows
  • Accounts
  • Wallet Authentication
  • Deposit/Withdrawal
  • Settle PnL
  • Order Management
  • Custom Fee Structure
  • Builder Staking Programme
  • Delegate Signer
  • Referral System
  • Algo Order Sample Requests
About APIs
  • Introduction
  • API Authentication
  • Error Codes
General API
  • Builder Info
  • System Info
  • USDC Faucet
User API
  • Registration
  • Key Management
  • Account/User Info
  • Account Notifications
  • Account Config
  • Delegate Signer
  • Sub-account
Trading API
  • Order Management
  • Liquidations
  • Assets/Withdraw/Settle PnL
  • Positions
  • Funding
Strategy Vault API
  • Account
Rewards API
  • Trading Rewards
  • Market Making Rewards
Staking & Valor API
  • Staking
  • Valor
Builder API
  • User Data
  • Trading Campaigns
  • Fee Setting
  • Referral Program
Market Data API
  • TradingView
  • Funding Rates
  • Market Info
Websocket API
  • Introduction
  • PING/PONG
  • Authentication
  • Error Response
  • Public Market Data
  • Private User Data
Partner Support

Integration FAQs

What is Orderly?

Orderly is a combination of an orderbook-based trading infrastructure and a robust liquidity layer offering perpetual futures orderbooks. Unlike traditional platforms, Orderly doesn’t have a front end; instead, it operates at the core of the ecosystem, providing essential services to projects built on top of it.Our DEX white-label solution is carefully crafted to save builders time and capital while granting access to our bootstrapped liquidity. Picture having the best features of CEXs while keeping settlements on-chain and maintaining full self-custody.With Orderly, anyone can create a trading application thanks to our seamless plug-and-play experience leveraging our liquidity and composability.Looking ahead, our grand vision is to create an omnichain protocol, connecting traders from both EVM and non-EVM chains within the same orderbook.

How to integrate?

Orderly offers multiple integration pathways:
  • React UI components
  • React hooks
  • Python connector
  • Direct API access
Documentation and examples for these can be found on their respective GitHub repositories and the official documentation site.

Creating a builder ID

Not everyone needs a builder ID.If you are an API trader please select any available builder to trade on here.If you are a builder looking to host a front-end, onboard traders, and earn revenue share, you can get in touch via email.

Fee setting, default fees, and custom fee rates

More on fees can be found here

Builder fee rebate distribution

Fees builders collect on top of Orderly base fee are collected by Orderly directly at the time of the trade. Rebates are then sent to each builder’s admin wallet account daily.To claim the rebate, builders need to log in on their own interface with the admin wallet and withdraw.

Builder admin wallet

Builder admin wallet is a wallet provided at the time of builder ID setup and has to be an EOA. Builder admin wallet is used for:
  • Receiving fee rebates daily
  • Accessing certain endpoints that require builder admin authentication such as changing user fees. Endpoints that require builder admin authentication will note that in the API page description.

Obtaining user data

Most user data can only be accessed by the user with user’s trading key. Only builder endpoints allow user data retrieval for their own users.
Integration ChecklistAccounts
twitterlinkedindiscordmedium
Powered by Mintlify
Assistant
Responses are generated using AI and may contain mistakes.