Copy page

API Reference

API Reference

Use API Reference when you already know which technical interface you need. Start with a protocol, then choose the product and capability documented by that interface.

Scope labels

An untagged reference may still have product or account requirements. Confirm the applicability stated on the operation or stream before integrating it.

REST

REST covers public market data and supported authenticated account and trading operations. Each operation page defines its request, authentication requirements, permissions, and response.

• REST API overview
• Trading REST API
• Margin REST API
• Perpetuals REST API
• Prediction Markets REST API
• Common administration REST API

WebSocket

The WebSocket API has one core protocol. Connection, authentication, message envelopes, standard streams, and methods are shared across supported products. Prediction Market order events use the same order stream and add an outcome field.

Core protocol

• Connection and session behavior
• Authentication
• Message format
• Shared market data and account streams
• Position updates
• Shared methods playground

Prediction-market extensions

• Contract status
• Combo RFQ streams

FIX

Use the FIX reference for provisioned sessions, order entry, market data, drop copy, and message dictionaries. FIX session credentials and account mapping are interface-specific.

• FIX API overview

Authentication and account context

Before calling a private operation, verify all three separately:

1. The credential type is supported by the protocol and operation.
2. The credential has the required API-key role or OAuth scope.
3. The operation is resolved to the intended account using that interface's documented mechanism.

• API key authentication
• OAuth
• Roles and permissions
• Accounts and subaccounts

The reference remains organized under current public routes while canonical /api-reference/... operation URLs are introduced in later migration phases.