Common Definitions & Terms
Order types, symbol formats, margin modes, decimal precision, and key trading terms used throughout the GaiaEx API.
SKILL.mdDrop-in Claude Code skill with HMAC-SHA256 signing, /fapi/v1 & /fapi/v2 schemas, and secret-redaction guardrails.
AGENTS.mdDrop-in repository AGENTS.md for OpenAI Codex CLI — tick-size rules, rate-limit budgets, and self-custody boundaries.
AGY.mdGoogle Antigravity (agy) & Gemini agent spec with verified async Python WebSocket + REST execution templates.
llms.txtSingle-URL machine-readable index of all GaiaEx documentation pages, OpenAPI 3.0 schema, and Postman collection.
Order Types
On /fapi/v1/order, order types use standard uppercase GaiaEx enum values in the type parameter:
| Value | Time in Force | Description |
|---|---|---|
LIMIT | GTC, IOC, FOK, GTX | Placed at a specific price. Sits on the order book until filled or canceled. |
MARKET | N/A | Executes immediately at the best available price. No price field needed. |
STOP / TAKE_PROFIT | GTC | Conditional limit order triggered when stopPrice is reached. |
STOP_MARKET / TAKE_PROFIT_MARKET | GTC | Conditional market order triggered when stopPrice is reached. |
Order Side & Position Side
Orders use the standard side string enum:
| Field | Value | Meaning |
|---|---|---|
side | BUY | Buy / Open Long (or close Short) |
side | SELL | Sell / Open Short (or close Long) |
positionSide | BOTH | One-way mode default (optional) |
Margin Modes
Margin type is configured per symbol via POST /fapi/v1/marginType:
| Mode | marginType value | Description |
|---|---|---|
| Cross | CROSSED | Shares margin across all cross positions in the same collateral pool. Unrealized PnL from other positions can help prevent liquidation. |
| Isolated | ISOLATED | Each position has its own dedicated margin. Liquidation risk is contained to that position. |
INFO
Some RWA perpetual symbols only support isolated margin. The backend automatically enforces isolated margin where required.
Symbol Format
USDC-Margined Perpetuals
USDC-margined crypto perpetual contracts use the USDC suffix (or bare ticker / -USDC alias):
BTCUSDC, ETHUSDC, SOLUSDC, ...USDT-Margined Perpetuals
USDT-margined perpetual contracts use the USDT suffix (or -USDT alias):
BTCUSDT, ETHUSDT, SOLUSDT, ...RWA, Venture & Index Perpetuals
Real-world asset (RWA), index, and pre-IPO venture perpetual contracts support both standard USDC-suffixed tickers and namespace-prefixed tickers:
| Format | Asset Class | Examples |
|---|---|---|
<ASSET>USDC / xyz:<ASSET> | Equities, commodities, indices, forex | GOLDUSDC (xyz:GOLD), NVDAUSDC (xyz:NVDA), SP500USDC (xyz:SP500) |
vntl:<TOKEN> | Pre-IPO venture tokens | vntl:OPENAI, vntl:ANTHROPIC |
cash:<INDEX> | Cash index products | cash:USA500, cash:NAS100 |
TIP
Use GET /fapi/v1/exchangeInfo to retrieve all currently supported symbols with their tick size, step size, margin asset, and precision filters.
Collateral
GaiaEx supports two independent perpetual collateral pools: USDC (for *USDC, xyz:*, cash:*, and vntl:* contracts) and USDT (for *USDT contracts). When trading RWA or venture symbols, the backend automatically handles any internal settlement token conversions — users only deposit, withdraw, and manage USDC and USDT.
Decimal Handling
- Quantity and price parameters (
quantity,price,stopPrice) are passed as decimal strings or numbers in query/form parameters, and returned as strings in JSON responses to preserve exact decimal precision. - Prices must conform to the symbol's
tickSize(PRICE_FILTER), and quantities must conform tostepSize(LOT_SIZE). UseGET /fapi/v1/exchangeInfoto inspect each symbol's filters.
Timestamps
All timestamps in the API are Unix epoch milliseconds (int64).
1743508800000 → 2026-04-01T12:00:00.000ZSigned requests require timestamp=<ms> and accept an optional recvWindow=<ms> (default 5000).
Pagination
Endpoints that return historical lists (such as GET /fapi/v1/allOrders, GET /fapi/v1/userTrades, and GET /fapi/v1/klines) support pagination via query parameters:
| Parameter | Type | Description |
|---|---|---|
limit | int | Maximum number of items to return (default 500, max 1000) |
startTime | int | Filter by start timestamp in ms |
endTime | int | Filter by end timestamp in ms |
fromId / orderId | int | Fetch records starting from a specific ID (where supported) |
Wallet Resolution & Address Format
On all /fapi/v1/* and /fapi/v2/* endpoints, your wallet address is automatically resolved server-side from your X-MBX-APIKEY header — you never need to pass a wallet address in your requests.
Where wallet addresses appear in account metadata or legacy /v1/trade/* routes, they use standard 42-character EIP-55 checksummed hexadecimal format (0x...).