Announcement: V3 OpenAPI Support for USDT-Margined Delivery Contract Trading

Dear OKX Users,

OKX will soon launch USDT-margined delivery contracts. To support both simulated and live trading for these contracts, we have upgraded our existing API interfaces. The updated V3 OpenAPI is scheduled for release on October 31, 2019, at 16:00 (HKT), alongside updated API documentation. Simulated and live trading schedules will be announced separately.

Key Upgrades

(This announcement concerns API trading users only. Note that V1 OpenAPI does not support USDT-margined contracts.)

1. Interface Adjustments

Current Limitation: API requests cannot differentiate between ‘coin-margined’ and ‘USDT-margined’ contracts.

Endpoint: GET /api/futures/v3/accounts/
Example: GET /api/futures/v3/accounts/BTC

Post-Upgrade:

• The parameter currency is replaced with underlying.

  • Coin-margined contracts: BTC-USD
  • USDT-margined contracts: BTC-USDT

Example Requests:

• USDT-margined: GET /api/futures/v3/accounts/BTC-USDT
• Coin-margined: GET /api/futures/v3/accounts/BTC-USD

Backward Compatibility:
Legacy formats (e.g., GET /api/futures/v3/accounts/BTC) will default to BTC-USD.

Important: The POST /api/futures/v3/accounts/margin_mode interface requires explicit underlying parameters and will not support legacy formats.

2. Affected REST APIs

• Single-currency contract account info (GET /api/futures/v3/accounts/)
• Bill history query (GET /api/futures/v3/accounts/)
• Leverage adjustment (Cross-Margin) (POST /api/futures/v3/accounts/)
• Contract leverage retrieval (GET /api/futures/v3/accounts/)
• Public contract info (GET /api/futures/v3/instruments) (New fields added)
• Account mode setting (POST /api/futures/v3/accounts/margin_mode) (No compatibility)
• Multi-currency account info (GET /api/futures/v3/accounts) (New fields added)

3. Affected WebSocket APIs

• Public full contract info channel (futures/instruments) (New fields added)

• Private account channel (futures/account)

  • Example Subscriptions:

    • Coin-margined: {"op": "subscribe", "args": ["futures/account:BTC"]}
    • USDT-margined: {"op": "subscribe", "args": ["futures/account:BTC-USDT"]}

Impact Mitigation

Programs not trading USDT-margined contracts remain unaffected, though new fields may appear in responses. We apologize for any inconvenience.

👉 Upgrade to V3 API now for enhanced stability and features

FAQs

Q1: Is V1 OpenAPI being deprecated?
A: Yes, V1 will eventually be discontinued. Migrate to V3 for better performance and features.

Q2: How do I access the updated API documentation?
A: Documentation will be available at launch (October 31, 2019).

Q3: Will my existing code break after the upgrade?
A: Most legacy requests remain compatible, but review new required fields for USDT-margined contracts.

👉 Need technical support? Contact our API team

OKX is committed to delivering superior products and services. Stay tuned for more updates!

Originally published: October 30, 2019