Upcoming Changes

Chase limit order for FUTURES/SWAP trigger orders

Last update: July 9, 2026

FUTURES and SWAP trigger orders can now place a chase limit order once the trigger fires — a new chase value for advanceOrdType, with its parameters carried in a new advChaseParams array. The read endpoints return the spawned chase order's algoId in a new subAlgoIdList field, and the chase values can be amended while the trigger order is still pending. Expected to be available in the demo environment on July 15, 2026, with production go-live on July 21, 2026.

Place algo order

• Added a new advanceOrdType value chase and a new advChaseParams array; orderPx becomes conditional (not applicable to a chase).
  • POST / Place algo order

Attached TP/SL (attachAlgoOrds) cannot be set together with a chase in this iteration.

Parameter	Type	Required	Description
advanceOrdType	String	No	Order type placed when the trigger fires. fok, ioc, or chase. chase is only applicable to FUTURES and SWAP. Default empty (a limit or market order per orderPx).
orderPx	String	Conditional	Price of the order placed when the trigger fires. -1 for market. Not applicable when advanceOrdType is chase (a chase has no fixed price).
advChaseParams	Array of objects	Conditional	Chase parameters. Required when advanceOrdType is chase.
> chaseType	String	Conditional	Chase distance unit. distance (default): absolute price distance from the best bid/ask, in settlement currency. ratio: percentage.
> chaseVal	String	Conditional	Chase value. When chaseType is distance, the distance from the best bid/ask in settlement currency; when ratio, 0.1 = 10%. Default 0 tracks the best bid/ask directly; a value >0 sets a distance.
> maxChaseType	String	Conditional	Maximum chase distance unit. distance or ratio. Must pair with maxChaseVal.
> maxChaseVal	String	Conditional	Maximum chase distance value. Positive. Must pair with maxChaseType. The chase auto-cancels when its deviation reaches this value.

Amend algo order

• Added advChaseParams amend fields to adjust the chase values while the trigger order is pending (pre-trigger). chaseType, maxChaseType, and the chase-price mode are fixed at placement and cannot be amended.
  • POST / Amend algo order

Parameter	Type	Required	Description
advChaseParams	Array of objects	Conditional	Chase parameters to amend. Only for a pending trigger order with advanceOrdType chase.
> newChaseVal	String	Conditional	New chase value. Non-negative, interpreted per the order's existing chaseType. It cannot cross the 0 ↔ non-0 boundary of the original chaseVal — tracking the best bid/ask directly (0) and a distance offset (>0) are not interchangeable.
> newMaxChaseVal	String	Conditional	New maximum chase distance value. Positive, interpreted per the existing maxChaseType. Only applicable when maximum chase is enabled.

Read endpoints (order details, order lists, WS channel)

• Added advanceOrdType (with the new chase value), advChaseParams, and a new subAlgoIdList response parameter.
  • GET / Algo order details
  • GET / Algo order list
  • GET / Algo order history
  • WS / Algo orders channel

Parameter	Type	Description
advanceOrdType	String	Sub-order type for trigger orders. fok, ioc, chase, or empty.
advChaseParams	Array of objects	Chase parameters. Present when advanceOrdType is chase.
> chaseType	String	Chase distance unit. distance or ratio.
> chaseVal	String	Chase value. 0 tracks the best bid/ask directly; >0 is a distance.
> maxChaseType	String	Maximum chase distance unit.
> maxChaseVal	String	Maximum chase distance value.
subAlgoIdList	Array of strings	algoId(s) of the algo order(s) spawned when the trigger fires. For advanceOrdType chase, holds the spawned chase order's algoId after the trigger fires; empty before then. Mirrors ordIdList, which records spawned regular orders and stays empty for a chase.

Rebranding ELP to RPI (Retail Price Improvement) Program

Last update: July 20, 2026

OKX is rebranding Enhanced Liquidity Program (ELP) to Retail Price Improvement (RPI). This includes a new consolidated RPI order book (books-rpi) over WebSocket and REST, a renamed rpi maker order type (replacing elp), an expanded rpiTakerAccess order parameter (replacing isElpTakerAccess), a new rpiPxRound parameter for the RPI maker spacing rule, and renamed rpi/rpiMaker account fields. Expected to be available in the demo environment on July 23, 2026, with production go-live on July 28, 2026.

ELP name deprecation deadline: October 31, 2026

OKX will run the ELP and RPI names in parallel until this date, in two distinct ways:

• Renamed fields — both accepted; the RPI-named field wins when a request or response carries both:
  • isElpTakerAccess → rpiTakerAccess
  • elp → rpi
  • elpMaker → rpiMaker
• Renamed values — mutually exclusive; send or expect one or the other, not both:
  • ordType: elp → ordType: rpi
  • books-elp → books-rpi

Existing integrations continue to operate without changes. The ELP names will be retired after the sunset date above — migrate every integration to the RPI names before then.

New consolidated order book: books-rpi (WS + REST)

• Added books-rpi, consolidating organic and RPI liquidity into a single depth stream — available as a public WebSocket channel (/ws/v5/public, 400 depth levels, full snapshot + incremental updates every 100 ms) and a REST endpoint (GET /api/v5/market/books-rpi, refreshed every 200 ms server-side). No checksum; WS sequencing relies on seqId/prevSeqId. Supersedes books-elp (see migration note above).
  • WS / Order book channel

Each asks/bids element is [price, totalQty, nonRpiQty, count] — totalQty is the total depth at that price level, nonRpiQty is the organic-only portion, count is the aggregated order count at that level.

REST request: instId (required), sz (depth per side, max 400, default 1).

Taker parameter: rpiTakerAccess (replaces isElpTakerAccess)

• rpiTakerAccess renames and expands isElpTakerAccess to apply to all standard order types (limit, market, fok, ioc, optimal_limit_ioc; previously ioc only) and to be settable on amend. isElpTakerAccess remains accepted as an alias until the sunset date (see migration note above).
• Error code 54045 (previously returned when a non-ioc order attempted to take RPI liquidity) is retired — unreachable now that rpiTakerAccess is valid on all order types.

Applies to place / amend, REST + WS: - POST / Place order - POST / Place multiple orders - POST / Amend order - POST / Amend multiple orders - WS / Place order - WS / Place multiple orders - WS / Amend order - WS / Amend multiple orders

Parameter	Type	Required	Description
rpiTakerAccess	Boolean	No	Default false. When true, the order can access RPI liquidity, for all standard order types (previously ioc only). A speedbump mechanism applies to all order types except post_only on placement; on amend it applies to all types including post_only. Not inherited on amend — must be re-specified on each amend request (omitted = false for that amend).

Maker order type: rpi (replaces elp)

• To place an RPI maker order, set ordType to rpi instead of elp. elp remains accepted until the sunset date (see migration note above) — ordType takes a single value, so send one or the other, not both.

Applies to place, REST + WS: - POST / Place order - POST / Place multiple orders - WS / Place order - WS / Place multiple orders

Maker parameter: rpiPxRound

• rpiPxRound is a new parameter for the RPI maker spacing rule (see below). Effective only on RPI maker orders (ordType: rpi); silently ignored on non-RPI orders and on OPTION/EVENTS.

Applies to place / amend, REST + WS (same interfaces as rpiTakerAccess above).

Parameter	Type	Required	Description
rpiPxRound	Boolean	No	Default false. When true, a price that violates the spacing rule is auto-rounded outward to the nearest placeable, non-crossing level instead of being rejected.

• Added a new amendSource value 6 on the orders WS private channel: order price adjusted (rounded) by the system to satisfy the RPI maker spacing rule, triggered by rpiPxRound.
  • WS / Order channel

RPI maker spacing rule

RPI maker orders are subject to a spacing rule (rpiMinLevel / rpiMinPxBand below). An order that violates it is rejected unless rpiPxRound is true, in which case the price is auto-rounded to the nearest compliant level instead (see rpiPxRound above).

• Added new response parameters rpiMinLevel and rpiMinPxBand to expose the per-instrument spacing thresholds.
  • GET / Get instruments (public)

Parameter	Type	Description
rpiMinLevel	String	Minimum spacing between the RPI bid and RPI ask, in organic price levels. Default 4; 0 for Event Contracts.
rpiMinPxBand	String	Minimum distance from the opposite-side organic best price required to satisfy the spacing rule, in basis points (bps), e.g. 20.

RPI maker permission field: rpi (replaces elp)

• Added new response parameter rpi to indicate RPI maker permission. elp remains accepted as an alias until the sunset date (see migration note above).
  • GET / Get instruments (private)

Parameter	Type	Description
rpi	String	RPI maker permission. 0: not enabled for this instrument 1: enabled, but the current user has no permission to place RPI orders 2: enabled and permitted A 1/2 value does not imply RPI liquidity is present.

RPI maker fee rate field: rpiMaker (replaces elpMaker)

• Added new response parameter rpiMaker to indicate the RPI maker effective fee rate. elpMaker remains accepted as an alias until the sunset date (see migration note above).
  • GET / Get fee rates

Parameter	Type	Description
rpiMaker	String	RPI maker effective fee rate. Returns "" if RPI is not applicable to the instrument.

Trade source field: source

• Response field source value 1 on GET /api/v5/market/trades is now described as RPI order (previously ELP order). The returned value 1 itself is unchanged — only the description text is updated.
  • GET / Trades

WebSocket Orders Channel: Push Behavior Adjustment

Last update: Jul 15, 2026

To help clients more clearly determine the final status of post-only new orders (including mmp_and_post_only) and upcoming rpi new orders — and to avoid scenarios where an order is still canceled after the client has already received a state: live event — OKX will adjust the state: live event behavior for post-only and rpi orders in the Order channel.

Impact details

• The state: live event will be pushed only after the order has successfully entered the order book, instead of immediately upon order receipt (a delay of approximately 1 ms).
• In failed order placement scenarios (price crosses the BBO and is canceled), the state: live update will be removed entirely — only a state: canceled update will be pushed.

Scenario	Before	After
post-only order placement failure (price crosses the BBO and is canceled)	state: live → state: canceled	Only state: canceled (no state: live)
post-only order placed successfully	state: live pushed immediately	state: live (delayed ~1 ms)
post-only order placed successfully, then filled by one taker order	state: live → state: filled	state: live (delayed ~1 ms) → state: filled
post-only order placed successfully, then filled by multiple partial fills	state: live → state: partially_filled → state: filled	state: live (delayed ~1 ms) → state: partially_filled → state: filled
post-only order with reduceOnly: true, size modified	state: live → state: live (amendSource: 4, amendResult: 0)	state: live (amendSource: 4, amendResult: 0) → state: live
Upcoming rpi order, rpiPxRound: false, order placement failure (canceled due to not meeting the price spacing rule)	N/A	Only state: canceled (no state: live)
Upcoming rpi order, rpiPxRound: true, and price is modified	N/A	state: live (amendSource: 6, amendResult: 0) → state: live

Effective date

• For rpi orders: demo trading — July 22, 2026; production — July 28, 2026.
• For post_only and mmp_and_post_only orders: both demo trading and production — mid-August, 2026.

Scope of impact

The order types affected are: post_only, mmp_and_post_only, and rpi (Retail Price Improvement).

Other order types — such as limit (regular limit orders), market (market orders), ioc, and fok — will have their push behavior remain unchanged.

2026-07-20

TVB (Trading Volume Bonus) affiliate performance endpoint

A new Affiliate REST API endpoint under /api/v5/affiliate/tvb/* reports Trading Volume Bonus (TVB) performance — accrued bonus, valid and eligible trading volume, valid/eligible trader and invitee counts, deposits, first-time trader/depositor counts, and the affiliate bonus multiplier over a selectable stats window. Bonus is settled in USDC.

Add new endpoint

• Added a new endpoint returning aggregated TVB performance metrics for a specified time period (periodType, or a custom begin/end window of 1 to 90 days).
  • GET / Get TVB performance summary

2026-07-06

Affiliate REST API expansion

The following Affiliate endpoints, already available on the Global site, are now live on the EEA site. The invitee's detail endpoint also gains two new response parameters and an updated rate limit.

Add new endpoint

• The following new endpoints are added under Affiliate:
  • Get performance summary
  • Get invitee list
  • Get link list
  • Get co-inviter link list
  • Get sub-affiliate list

Add new response parameter

• Added new response parameters wdAmt, totalVol to the following endpoint:
  • Get the invitee's detail

Parameter	Type	Description
wdAmt	String	Accumulated amount of withdrawal in USDT. If user has not withdrawn, 0 will be returned.
totalVol	String	Lifetime accumulated trading volume in USDT. If user has not traded, 0 will be returned.

Rate limit change

• Rate limit of Get the invitee's detail has been changed from 20 requests per 2 seconds to 3 requests per second.

2026-06-30

Price limit XYZ parameters for instruments

• Added new response parameters initPxLmtPct, floatPxLmtPct, maxPxLmtPct to:
  • GET / Get instruments (public)
  • GET / Get instruments (private)

Parameter	Type	Description
initPxLmtPct	String	Initial price-limit band applied during the first 10 minutes after contract listing, e.g. 0.05 represents 5%. Use GET /api/v5/public/price-limit for the computed price limits. Only applicable to SPOT/MARGIN/SWAP/FUTURES, returns "" for OPTION and EVENTS.
floatPxLmtPct	String	Floating price-limit band during normal trading, e.g. 0.03 represents 3%. Use GET /api/v5/public/price-limit for the computed price limits. Only applicable to SPOT/MARGIN/SWAP/FUTURES, returns "" for OPTION and EVENTS.
maxPxLmtPct	String	Maximum price-limit cap (hard ceiling on order-price deviation from the index price), e.g. 0.15 represents 15%. Use GET /api/v5/public/price-limit for the computed price limits. Only applicable to SPOT/MARGIN/SWAP/FUTURES, returns "" for OPTION and EVENTS.

2026-06-23

Deprecation of checksum field in order book channels

To improve the efficiency and stability of the market data feed, the following order book channels have deprecated the checksum field in both snapshot and incremental updates. The checksum field is still present in snapshot and incremental updates, but its value is fixed to 0 and must no longer be used for integrity verification. Please use seqId/prevSeqId to verify the data continuity and accuracy.

• Deprecated the checksum field in both snapshot and incremental updates (the field remains in the push but its value is fixed to 0).
  • WS / Order book channel
    • books
    • books-l2-tbt
    • books50-l2-tbt

Note:
1. books5 and bbo-tbt channels do not carry a checksum field and are not affected by this change.
2. The WebSocket connection now fully enforces TLS (wss://), providing protection against eavesdropping and tampering, and ensuring data integrity. Together with rigorous validation of seqId and prevSeqId, it effectively prevents out-of-order messages, partial data loss, or malicious injection, providing integrity protection equivalent to or stronger than the original checksum mechanism.

2026-05-26

• Added new error code

Error Code	HTTP Status Code	Error Message
54092	200	Action Required: Please accept the TradFi Perps disclaimer on Web or App by attempting to place a TradFi Perp trade via the frontend. Each account, including sub-accounts, must separately accept the disclaimer before API trading is enabled

2026-05-07

New Endpoints

• The following new endpoint is added. Only applicable to the demo trading environment:
  • Adjust demo account balance

Request Parameters

Parameter	Type	Required	Description
type	String	Yes	Direction of adjustment. increase: add to balance reduce: deduct from balance One direction per request; increase and reduce cannot be mixed.
adjustments	Array	Yes	List of currency adjustments. At least one item required. Duplicate currencies are not allowed.
> ccy	String	Yes	Currency. Supported values: BTC ETH USDT OKB
> amt	String	Yes	Adjustment amount. Must be non-negative. Decimal places must not exceed the precision defined for the currency. Increase limits per request: BTC: 1, ETH: 1, USDT: 5000, OKB: 100. Reduce has no per-request amount limit — only constrained by available balance ≥ 0.

Response Parameters

Parameter	Type	Description
remainCnt	String	Remaining daily increase quota. Also returned for reduce requests, but reduce does not consume quota.
totalCnt	String	Total daily increase quota (default: 3).
details	Array	Per-currency operation details.
> ccy	String	Currency.
> amt	String	Adjustment amount applied.
> bal	String	Post-operation balance for this currency.

Error Codes

Error code	HTTP status code	Error message
59691	200	Daily increase limit reached {param0}. Please retry after UTC 0:00 or reset your demo account.
59692	200	Insufficient {param0} balance. Balance cannot go below zero after operation.
59693	200	{param0} transferable balance insufficient. Some funds are occupied by open orders or positions. Please cancel orders or close positions and try again.

2026-05-06

• OKX is introducing customisable slippage tolerance for spot and spot margin market-side orders via OpenAPI and WebSocket.
• A new post_only instrument state is added for SWAP contracts, restricting accepted order types to post-only limit orders.

Changes to Existing Endpoints

• New optional request parameter slippagePct for spot and spot margin market-side orders (where tgtCcy is the received currency: base_ccy for buy, quote_ccy for sell):
  • POST / Place order
  • POST / Place multiple orders
  • WS / Place order
  • WS / Place multiple orders

Request Parameters

Parameter	Type	Required	Description
slippagePct	String	No	Maximum acceptable slippage for spot and spot margin market-side orders, where tgtCcy is the received currency (base_ccy for buy, quote_ccy for sell). Range: 0 to 0.05 (0% to 5%, inclusive). Up to 2 decimal places of the percentage, e.g., 0.01 (1%) and 0.0123 (1.23%) are accepted; 0.01234 (1.234%) is rejected. If not specified or empty, defaults to 0.00%. Slippage cannot be modified on an existing order. Cancel and resubmit to change the slippage setting. Only applicable to SPOT and SPOT margin market orders.

Error Codes

Error code	HTTP status code	Error message
54084	200	Your slippage setting must be between 0% and 5% (inclusive).
54085	200	Your slippage percentage can't exceed 2 decimal places.

• Response parameter state adds new enum value post_only. When a contract is in post_only, only post-only limit orders are accepted (along with amend and cancel of existing post-only orders); market, IOC, FOK and normal limit orders are rejected. Only applicable to SWAP:
  • Get instruments (private)
  • Get instruments (public)
  • Instruments channel

Response Parameters

Parameter	Type	Description
state	String	Instrument status post_only: only post-only orders are accepted; existing post-only orders can be amended and cancelled. Other order types (market, IOC, FOK, normal limit) are rejected. Only applicable to SWAP

2026-04-14

OKX launches perpetual-style expiry futures (X-Perps)

• The following endpoints are now available to support X-Perps futures operations:
  • Get positions
  • Get positions history
  • Get account and position risk
  • Set position mode
  • Increase/decrease margin
  • Get leverage estimated info
  • Positions channel
  • Balance and position channel
  • Position risk warning
  • POST / Close position
  • Get delivery/exercise history
  • Get estimated delivery/exercise price
  • Get open interest
  • Get limit price
  • Get mark price
  • Get underlying
  • GET / Index tickers
  • GET / Index candlesticks
  • GET / Index candlesticks history
  • GET / Mark price candlesticks
  • GET / Mark price candlesticks history
  • GET / Index components
  • Open interest channel
  • Price limit channel
  • Mark price channel
  • Estimated delivery/exercise/settlement price channel
  • Liquidation orders channel
  • ADL warning channel
  • Mark price candlesticks channel
  • WS / Index tickers channel
  • WS / Index candlesticks channel

2026-04-07

Trading Fee Tier Requirement Changes

• Channels that previously required VIP6/VIP5 or above are now accessible from VIP4 and above
  
• Error codes 60029 and 60030 have been deprecated and unified to error code 64003
  
• The following table shows the changes in VIP tier requirements for accessing various Open API features:

Endpoint or Channel	Before	After (Current)	Error Code Change
SBE trades channel and books-l2-tbt channel	>= VIP6	>= VIP4	64003 unchanged
JSON books-l2-tbt channel	>= VIP6	>= VIP4	60029 → 64003
JSON books50-l2-tbt channel	>= VIP5	>= VIP4	60030 → 64003
JSON fills channel	>= VIP6	>= VIP4	60029 → 64003

Deprecate instId Request Parameter in WS Order Operation Channels

To reduce latency in WS order operations, the instId request parameter from the following order operation channels has been deprecated.

• Deprecate instId request parameter in the following channels:
  • WS / Amend order
  • WS / Amend multiple orders
  • WS / Cancel order
  • WS / Cancel multiple orders

Request Parameters

Parameter	Type	Required	Description
instId	String	-	Instrument ID Deprecated, will be ignored

Note: You can use the Get instruments endpoint to map instIdCode to instId.

KYC Level 2 Required for Placing Orders

OKX will require users to complete KYC Level 2 or above in order to place orders via WebSocket and REST API endpoints. Users who have not completed KYC Level 2 will receive error code 59113 when attempting to place orders. This requirement applies to live trading only — demo trading is not affected.

Affected Endpoints

Endpoint or Channel	Description
WS / Place order	Place a single order
WS / Place multiple orders	Place orders in batch
POST / Place order	Place a single order
POST / Place multiple orders	Place orders in batch

Error Code

Error Code	Description
59113	KYC level 2 or above is required for placing orders

Notes:

• Users must complete KYC Level 2 verification before placing orders via WebSocket / REST API endpoints
  
• This requirement applies to live trading only — demo trading is not affected
  

Bills Management Updates

• Added new endpoint:

  • GET / Bill types
    
    

• Added request parameter type

  • POST / Apply bills details (since 2021)
  • GET / Get bills details (since 2021)

Request parameters

Parameter	Type	Required	Description
type	String	No	Bill type Please refer to Get bill types for the list of available types

2026-03-26

• Delisted instId request parameter from the following channels.
  • WS / Place order
  • WS / Place multiple orders

Request Parameters

Parameter	Type	Required	Description
instId	String	-	Instrument ID Delisted. Any value provided will be ignored.

Note: Users can use the Get instruments interface to map instIdCode to instId.

2026-02-12

• Added new parameters
  • Get instruments (private)
  • Get instruments (public)
  • Instruments channel

Parameter	Type	Description
instCategory	String	The category of the instrument’s base currency (the first part of the instrument ID). For example, for BTC-USDT-SWAP, the instCategory refers to the category of BTC. 1: Crypto

2025-12-15

• Started to support spot margin.

2025-11-20

• Added new request parameter instIdCode
  • WS / Place order
  • WS / Place multiple orders
  • WS / Amend order
  • WS / Amend multiple orders
  • WS / Cancel order
  • WS / Cancel multiple orders

Request Parameter Name	Type	Required	Description
> instIdCode	Integer	Conditional	Instrument ID code. If both instId and instIdCode are provided, instIdCode takes precedence.
> instId	String	Conditional	Instrument ID Will be deprecated on March 2026.

Note: You can use the Get instruments interface to map instIdCode to instId.

2025-08-27

Fiat buy/sell is supported.

2025-07-24

• Added toAddrType parameter in the following endpoints:
  • Withdrawal
  • Withdrawal history
  • Withdrawal info channel

Parameter	Type	Required	Description
toAddrType	String	No	Address type 1: wallet address, email, phone, or login account name 2: UID (only applicable for dest=3)

2025-07-08

Open API supports Unified USD Orderbook

For more details, please refer to Unified USD Orderbook FAQ

• Added new request parameter
  
  • Place order
    
  • Place multiple orders
    
  • Place order channel
    
  • Place multiple orders channel
    
  • Place algo order
    
  • Get maximum available balance/equity
    
  • Get maximum order quantity

Parameter	Type	Required	Description
tradeQuoteCcy	String	No	The quote currency used for trading. Only applicable to SPOT. The default value is the quote currency of the instId, for example: for BTC-USD, the default is USD.

• Added new response parameter
  • Get instruments (private)
  • Get instruments (public)

Parameter	Type	Description
tradeQuoteCcyList	Array of strings	List of quote currencies available for trading, e.g. ["USD", "USDC"].

• Added new response parameter
  • Order details
  • Order List
  • Order history (last 7 days)
  • Order history (last 3 months)
  • Order channel
  • Algo order details
  • Algo order list
  • Algo order history
  • Algo orders channel
  • Advance algo orders channel

Parameter	Type	Description
tradeQuoteCcy	String	The quote currency used for trading.

Trades channel adds seqId field

• WS / Trades channel

Parameter	Type	Description
data	Array	Subscribed data
> seqId	Integer	Sequence ID of the current message.

Note: The seqId may be the same for different trade updates that occur at the same time.

Fiat

Fiat deposits and withdrawals are supported.

2025-07-02

• Added new endpoint

  • Get asset bills history

• The request parameter has been updated as follows:

  • Get asset bills details

Before

Parameter	Type	Required	Description
after	String	No	Pagination of data to return records earlier than the requested ts, Unix timestamp format in milliseconds, e.g. 1597026383085
before	String	No	Pagination of data to return records newer than the requested ts, Unix timestamp format in milliseconds, e.g. 1597026383085

After

Parameter	Type	Required	Description
after	String	No	Pagination of data to return records earlier than the requested ts or billId, Unix timestamp format in milliseconds, e.g. 1597026383085
before	String	No	Pagination of data to return records newer than the requested ts or billId, Unix timestamp format in milliseconds, e.g. 1597026383085
pagingType	String	No	PagingType 1: Timestamp of the bill record 2: Bill ID of the bill record The default is 1

• Added new response parameter
  • Get asset bills details

Parameter	Type	Description
notes	String	Notes

2025-05-28

• Added endpoints. Bills details (since 2021) endpoints below have been released in production
  • Apply bills details (since 2021)
  • Get bills details (since 2021)

2025-04-17

• Added endpoints

  • Create sub-account
    
  • Create an API Key for a sub-account
    
  • Query the API Key of a sub-account
    
  • Delete the API Key of sub-accounts
    
    

• Added new error codes

Error code	Error Message
59515	You are currently not on the custody whitelist. Please contact customer service for assistance.
59516	Please create the Copper custody funding account first.
59517	Please create the Komainu custody funding account first.
59518	You can’t create a sub-account using the API; please use the app or web.
59519	You can’t use this function/feature while it's frozen, due to: {freezereason}

2025-02-12

• Added new parameters
  • Get balance
  • Get sub-account trading balance
  • Account channel

Parameter	Type	Description
notionalUsdForBorrow	String	Notional value for Borrow in USD Applicable to Spot mode/Multi-currency margin/Portfolio margin
notionalUsdForSwap	String	Notional value of positions for Perpetual Futures in USD Applicable to Multi-currency margin/Portfolio margin
notionalUsdForFutures	String	Notional value of positions for Expiry Futures in USD Applicable to Multi-currency margin/Portfolio margin
notionalUsdForOption	String	Notional value of positions for Option in USD Applicable to Spot mode/Multi-currency margin/Portfolio margin

2025-01-14

Withdrawal API adjustment for EEA entity users

Due to compliance requirements, EEA entity users need to pass in the field rcvrInfo when making on-chain/lightning withdrawal.

Parameters	Type	Required	Description
rcvrInfo	Object	Conditional	Recipient information For the specific entity users to do on-chain withdrawal/lightning withdrawal, this information is required.
> walletType	String	Yes	Wallet Type exchange: Withdraw to exchange wallet If withdrawal to the exchange wallet, relevant information about the recipient must be provided. For the exchange wallet belongs to business recipient, rcvrFirstName may input the company name, rcvrLastName may input "N/A"
> exchId	String	Conditional	Exchange ID You can query supported exchanges through the endpoint of Get exchange list (public) If the exchange is not in the exchange list, fill in '0' in this field.
> rcvrFirstName	String	Conditional	Receiver's first name, e.g. Bruce
> rcvrLastName	String	Conditional	Receiver's last name, e.g. Wayne

Withdraw assets to the exchange wallet

If users withdraw assets to the exchange wallet, they need to provide recipient information.

• Users under the EEA entity need to pass in the following field information of the recipient (rcvrFirstName, rcvrLastName). For the exchange wallet belongs to business recipient, rcvrFirstName may input the company name, rcvrLastName may input "N/A". The examples are as follows:

Withdraw assets to the private wallet

You can't withdraw to a private wallet via API. Please withdraw via our app or website instead.

Other API adjustment

• Added new response parameters
  • Get withdrawal history
  • Withdrawal info channel

Parameter	Type	Description
note	String	Withdrawal note

• Added new enumerations
  • Get withdrawal history
  • Withdrawal info channel

Parameter	Type	Description
state	String	17: Pending response from Travel Rule vendor

Newly added error code

Error code	Error Message
58239	You can't withdraw to a private wallet via API. Please withdraw via our app or website instead.

2024-12-30

2024-09-19

• Added new response parameters
  • Get account configuration

Parameter	Type	Description
enableSpotBorrow	Boolean	Whether borrow is allowed or not in Spot mode true: Enabled false: Disabled
spotBorrowAutoRepay	Boolean	Whether auto-repay is allowed or not in Spot mode true: Enabled false: Disabled

• Added new response parameters
  • Get leverage

Parameter	Type	Description
ccy	String	Currency

• Added new response parameters
  
  • Algo order details
  • Algo order list
  • Algo order history
  • Algo orders channel
  • Advance algo orders channel

Parameter	Type	Description
isTradeBorrowMode	String	Whether borrowing currency automatically true false Only applicable to trigger order, trailing order and twap order

2024-09-18

• Added new endpoints:
  • GET / Announcements
  • GET / Announcement types