Mastering OKX V5 API: Essential Tips and Tricks (Part 1)

Introduction

With the launch of its unified account trading system, OKX has upgraded its API from V3 to V5, introducing enhanced functionality and broader capabilities. This guide explores key differences between V5 and V3 APIs while sharing expert tips for pre-trading account configuration.

Key Changes in V5 API

Unified Product API Structure

V5 consolidates all product APIs into a single endpoint, eliminating product-specific divisions present in V3. For example:

POST /api/v5/trade/order

All product types now use identical request/response formats, removing the need for product-specific API models.

Optimized Naming Conventions

V5 adopts camelCase abbreviations for improved efficiency:

Field	V5 API	V3 API
Currency	ccy	currency
Instrument ID	instId	instrument_id
Underlying	uly	underlying
Unrealized PnL	upl	unrealized_pnl

Enhanced WebSocket Compression

V5 implements standard "Per-Message Deflate" WebSocket compression, automatically handling data decompression without manual intervention seen in V3.

Segregated WebSocket Channels

WebSocket channels now categorize as:

Public (market data, candlesticks)
Private (account, positions)

Each requires distinct connection URLs, with public channels rejecting login requests.

Advanced Account Configuration

Subaccount API Key Management

Perform CRUD operations via:

Operation	Endpoint
Create	POST /api/v5/users/subaccount/apikey
Retrieve	GET /api/v5/users/subaccount/apikey
Update	POST /api/v5/users/subaccount/modify-apikey
Delete	POST /api/v5/users/subaccount/delete-apikey

👉 Secure API best practices recommend IP binding for enhanced security.

Account Settings

Query configurations via:

GET /api/v5/account/config

Returns:

Account mode
Position mode
Auto-loan settings
Option Greeks configuration

Position Modes

Choose between:

One-way (single long/short position)
Two-way (simultaneous long/short positions)

Set via:

POST /api/v5/account/set-position-mode

Margin Trading Optimization

V5 offers flexible isolated/cross margin combinations per product. Leverage management now includes:

Retrieve Leverage

GET /api/v5/account/leverage-info

Set Leverage

POST /api/v5/account/set-leverage

Example configuration for BTC-USDT at 3.0x leverage:

{
  "lever": "3",
  "mgnMode": "cross",
  "instId": "BTC-USDT"
}

FAQ Section

Q: Can I use V3 and V5 APIs simultaneously?
A: Yes, but we recommend full migration to V5 for unified account support.

Q: How often should I rotate API keys?
A: Quarterly rotation aligns with security best practices.

Q: Does WebSocket compression impact performance?
A: It typically reduces bandwidth usage by 40-70% with minimal CPU overhead.

Conclusion

These V5 API enhancements provide traders with greater flexibility and efficiency. By implementing these configurations—from subaccount management to leverage settings—you can tailor OKX's powerful tools to your trading strategy.

👉 Continue to Part 2 for advanced trading techniques including WebSocket order execution and position reconciliation.

OKX continuously improves its unified account system—refer to the latest V5 API documentation for updates.