API Structure
Is divided into three main sections:Market Data
Public, Read-onlyReal-time and historical market data. No authentication required.
Account Queries
Public, UnsignedQuery account state without signatures.
Trading
Authenticated, SignedState-mutating operations requiring Ed25519 signatures.
Base URLs
Quick Start
1
Query Market Data
No authentication required - start exploring immediately.
2
Check Your Account
Query your positions and orders (no signature needed).
3
Get Testnet Funds
Request testnet funds for testing. See Request Faucet for details.
4
Place Your First Order
Sign and submit a transaction. See Transaction Signing for details.
Field Notation
Bulk uses compact field names to minimize bandwidth (critical for HFT):| Short | Full Name | Description |
|---|---|---|
s | symbol | Market symbol (e.g., BTC-USD) |
c | coin | Market symbol in orders |
px | price | Price level |
sz | size | Order/position size |
b | is_buy | Buy/sell direction (true=buy) |
r | reduce_only | Order only reduces position |
t | type | Order type object |
oid | order_id | Order identifier |
tif | time_in_force | Order lifetime (GTC/IOC/ALO) |
Order Types
| Type | Description | Use Case |
|---|---|---|
| GTC | Good Till Cancel | Standard limit order, rests on book |
| IOC | Immediate or Cancel | Market order (aggressive price) |
| ALO | Add Liquidity Only | Maker-only (post-only) |
| Trigger | Stop/Take Profit | Conditional order |