o2 Exchange API Endpoints Reference

Complete reference of all available API endpoints with interactive examples and detailed documentation.

Network Configuration

Use the network selector in the top navigation bar to choose your preferred API environment. All interactive examples and code snippets will automatically update to use the selected network.

Overview

The o2 Exchange API provides comprehensive access to trading functionality, market data, and account management for the Fuel-based decentralized exchange. This documentation is organized into logical sections for easy navigation:

Endpoint Categories

• Market Data - Trading pair information, market statistics, and real-time ticker data
• Order Book & Depth - Real-time order book depth data showing current bids and asks
• Trading Data - Historical trade data and OHLCV candlestick information
• Account & Balance - Trading account creation and asset balance management
• Order Management - Order history retrieval and individual order details
• Session Management - Trading session keys for automated trading operations
• Account Operations - Advanced account operations including contract calls and withdrawals
• System Endpoints - Health checks, metrics, and WebSocket connections
• Error Codes - Structured error responses and numeric error code reference

Quick Start

1. Network Selection: Choose your target environment using the network selector above
2. Authentication: Most endpoints are public; account-specific operations require signatures
3. Rate Limits: See Rate Limits section below for detailed limits per endpoint
4. Response Format: All endpoints return JSON responses with structured error codes

Rate Limits

These are application-level rate limits. Infrastructure providers may enforce additional limits at the network level.

Rate Limiter Types

1. IP-based - Based on public IP address
2. Owner ID-based - Uses o2-owner-id header (Fuel address)

Session Endpoints

Endpoint	Rate Limit	Type
PUT /v1/session	5/s	Owner ID-based
POST /v1/session/actions	5/s	Owner ID-based

Account Endpoints

Endpoint	Rate Limit	Type
POST /v1/accounts	1/s	IP-based
POST /v1/accounts/actions	10/m	Owner ID-based
POST /v1/accounts/upgrade	10/m	Owner ID-based
POST /v1/accounts/withdraw	10/m	Owner ID-based

Market Endpoints

Endpoint	Rate Limit	Type
GET /v1/markets/fees	5/s	IP-based

Aggregated Endpoints

Endpoint	Rate Limit	Type
GET /v1/aggregated/assets	5/s	IP-based
GET /v1/aggregated/orderbook	5/s	IP-based
GET /v1/aggregated/summary	5/s	IP-based
GET /v1/aggregated/ticker	5/s	IP-based
GET /v1/aggregated/trades	5/s	IP-based
GET /v1/aggregated/coingecko/tickers	5/s	IP-based
GET /v1/aggregated/coingecko/orderbook	5/s	IP-based

All aggregated endpoints are also available under the /v1/agg/ alias with the same rate limits.

Interactive Testing

Each endpoint page includes interactive ApiTryIt components where you can:

• Input parameters and see the URL update in real-time
• Execute actual API calls to test endpoints
• View responses with proper formatting
• Generate code examples in Shell, Node.js, and Rust

Query Patterns & Best Practices

Pagination

Many endpoints support pagination using:

• start_timestamp + start_trade_id/start_order_id - Starting point
• direction - "asc" or "desc" for query direction
• count - Number of items to return

Identity Parameters

Endpoints accepting account identifiers support Identity variants:

• address - User wallet address (Address type)
• contract - Trading account contract ID (ContractId type)

WebSocket Real-time Data

For real-time updates, connect to the WebSocket endpoint (/ws) on your selected network with subscriptions for:

• Order book updates (subscribe_depth)
• Order updates (subscribe_orders)
• Trade updates (subscribe_trades)
• Balance updates (subscribe_balances)

For comprehensive parameter documentation, see the Parameters Reference.

Smart Contract ABIs

For developers building applications that integrate directly with o2 smart contracts, the contract ABIs are publicly available:

• Repository: o2-exchange/contracts

The repository contains the currently deployed smart contract ABIs for the o2 exchange on the Fuel network. Refer to the markets API endpoint for the on-chain contract IDs.

Source Code References

All endpoints include direct references to the source code implementation in the packages/api/src/ directory for developers who want to understand the underlying implementation details.

Need help? Navigate through the sections above or use the sidebar to explore specific endpoint categories.