Upcoming Changes

Simple binary encoding

Last update: July 2, 2025

Overview

OKX will support Simple Binary Encoding (SBE) for data returned from the following WebSocket channels:

• WS / Trades channel: trades
• WS / Order book channel: bbo-tbt and books-l2-tbt

OKX plans to release the XML schema in mid-July 2025, with a demo environment rollout scheduled for August 2025. The production launch date will be announced later. The existing market data returned in JSON format will remain unaffected.

General Information

• Access is restricted to API users with VIP5 trading fee tier or higher for production, and VIP1 or higher for demo trading.
  
• SBE channels will use a new WebSocket URL.
  Live trading: wss://ws.okx.com:8443/ws/v5/public-sbe
  Demo trading: wss://wspap.okx.com:8443/ws/v5/public-sbe
  
• Both JSON and SBE format data will be available on the same connection, distinguishable by WebSocket frame type. opcode 1 indicates JSON, while opcode 2 indicates SBE.
  
• Prices and quantities will be encoded as scaled decimals, using a signed integer mantissa and signed scale. For example, a mantissa of 123456 and a scale of 4 represents 12.3456 (actual value = mantissa * 10 ^ -(scale)).
  
• The SBE protocol will use instIdCode , an integer will be provided by Get instruments to represent trading instruments. Users must map instIdCode to instId, noting that instIdCode will change if a trading symbol is relisted.
  

Integration Information

• To log in, transmit your API key and signature in the WebSocket connection header.
  
  • The connection requests must contain the following headers:
    
    • OK-ACCESS-KEY The API key as a String.
      
    • OK-ACCESS-SIGN The Base64-encoded signature.
      
    • OK-ACCESS-TIMESTAMP Unix Epoch time in seconds. e.g : 1751335333
      
    • OK-ACCESS-PASSPHRASE The passphrase you specified when creating the API key.
      
  • The OK-ACCESS-SIGN header is generated as follows:
    
    • Create a pre-hash string of timestamp + method + requestPath
      
    • Prepare the SecretKey.
      
    • Sign the pre-hash string with the SecretKey using the HMAC SHA256.
      
    • Encode the signature in the Base64 format. Example: sign=CryptoJS.enc.Base64.stringify(CryptoJS.HmacSHA256(timestamp + 'GET' + '/users/self/verify', SecretKey))
      
    • Example of timestamp: const timestamp = '' + Date.now() / 1,000, e.g. 1704876947
      
    • Method: always 'GET'.
      
    • RequestPath : always '/users/self/verify'
      
  • The response HTTP code of 101 indicates the successful login.
    
  • The response HTTP code 401, along with an error message in the response body, indicates a failed login. The error message will be in JSON fromat.
    

Login error message example
{
    "msg": "Invalid apiKey",
    "code": "60005"
}

• Subscription request must be sent in JSON format. The response will also be in JSON format, and can be identified by opcode 1.
  
  • The protocol is similar to existing JSON-formatted subscription requests/response.
    
  • The difference is that instIdCode should be used instead of instId.
    

Subscription request example
{
    "op": "subscribe",
    "args": [
        {
            "channel": "trades",
            "instIdCode": 211874
        }
    ]
}

Subscription response example
{
    "event": "subscribe",
    "arg": {
        "channel": "trades",
        "instIdCode": 211874
    },
    "connId": "accb8e21"
}

• The WebSocket server will send a ping frame with opcode 9 every 20 seconds after receiving a pong frame.
  

  • If the WebSocket server does not receive a pong frame back from the connection within 60 secondes, the connection will be disconnected.
    
  • Upon receiving a ping, you must respond with a pong frame using opcode 10, along with a copy of the ping‘s payload as quickly as possible (payload will be timestamp in milliseconds like 1597026383085).
    
  • Unsolicited pong frames are permitted but will not prevent disconnection. It is advisable that the payload for these pong frames be empty.
    

• For trades bbo-tbt and books-l2-tbt channels, data will be returned in binary format and can be identified by opcode 2, distinguishable by template ID. Key differences compared to existing JSON-formatted connections include:
  

  • For the trades channel, the seqId will be returned.
    
  • For the bbo-tbt channel, it usually provides real-time data, but under system overload, data loss can occur, varying by different connection.
    
  • For the books-l2-tbt:
    
    • When prices and quantities decimals change, a scale update will occur with previous sequence ID and sequence ID, identifiable by template ID. This must be processed to maintain the sequence ID consistence.
      
    • The checksum will no longer be included.
      
    • There will be no initial order book snapshot after subscription. Instead, OKX will provide a REST API endpoint that returns SBE binary data for the initial 400 levels snapshot. This endpoint will buffer requests and return data only when a new snapshot is generated, approximately every 500 ms.
      

Trades channel adds seqId field

Last update: July 2, 2025

• WS / Trades channel adds seqId field. This change will be launched to production on 8 July.
• WS / All trades channel adds seqId field. This change will be launched to production in mid-July.

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

Order channel revamp

Last update: June 27, 2025

To improve system performance, OKX has implemented technical changes that will take effect in early July. In exceptional cases, the same message may be sent multiple times (with different uTime) from the Order channel. The following guidelines are advised:

• If a tradeId is present, it means a fill. Each tradeId should only be returned once per instrument ID, and the later messages that have the same tradeId should be discarded.

• If tradeId is absent and the state is "filled," it means that the SPOT/MARGIN market order is fully filled. For messages with the same ordId, process only the first filled message and discard any subsequent messages. State = filled is the terminal state of an order.

• If the state is canceled or mmp_canceled, it indicates that the order has been canceled. For cancellation messages with the same ordId, process the first one and discard later messages. State = canceled / mmp_canceled is the terminal state of an order.

• If reqId is present, it indicates a response to a user-requested order modification. It is recommended to use a unique reqId for each modification request. For modification messages with the same reqId, process only the first message received and discard subsequent messages.

Fills channel adds clOrdId field

Last update: July 4, 2025

Fills channel adds clOrdId push data parameter. This change has been released to the demo trading environment and will be released to production on July 8, 2025.

• Fills channel adds clOrdId push data parameter, allowing users to specify clOrdId when placing orders. The field will be returned upon trade execution. Note that the fills channel will only return this field if the user-provided clOrdId conforms to the signed int64 positive integer format (1-9223372036854775807, 2^63-1); if the user does not provide this field or if clOrdId does not meet the format requirements, the field will return "0". The order endpoints and channel will continue to return the user-provided clOrdId as usual. All request and response parameters are of string type.
  • WS / Fills channel

Delist old attached stop profit and stop loss parameters

Last update: April 11, 2025

There are two ways to attach stop-loss and take-profit to an order currently. The old way is implemented through flat parameters, and the new way is implemented through the array attachAlgoOrds. In order to streamline the placement parameters and order information parameters, Open API will delist the old stop-loss and take-profit parameters.

• Related request parameters will be delisted in early-July (these fields aren’t shown in the document, and the parameters in the array attachAlgoOrds aren’t affected)
  • Place order
    
  • Place multiple orders
    

• Related request parameters will be delisted in mid-May (the parameters in the array attachAlgoOrds aren’t affected)
  • Order channel
    
  • Get order details
    
  • Get order list
    
  • Get order history (last 7 days)
    
  • Get order history (last 30 days)
    

Spot borrow mode additional agreement

Last update: April 23, 2025

The spot borrowing rules have been supplemented for the Spot borrow mode. The Open API will add order verification. The effect date is to be confirmed. You need to agree to the spot borrowing rules before that (They’ll be shown in a popup when you try to place or modify an order in app or web), otherwise error 54017 will be returned when placing or amending the order.

• 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

2025-07-02

• Added new endpoint

  • Get asset bills history

• The request parameter has been updated as follows:

  • Get asset bills details

Before

After

• Added new response parameter
  • Get asset bills details

2025-06-26

• To provide the latest data and enhance the user experience, order book endpoints do not return data immediately. Instead, they return the latest data once the server-side cache has been updated.

  • GET / Order book
  • GET / Full order book

2025-06-24

• Added new enumeration values
  • Get withdrawal history

2025-06-19

• The maximum and default of request parameter limit of the endpoint are both changed to 400.
  • Get funding rate history

2025-06-17

Fiat Buy/Sell

• Added new endpoints

  • GET Fiat Buy/Sell currency list
  • GET Fiat Buy/Sell currency pair
  • POST Fiat Buy/Sell quote
  • POST Fiat Buy/Sell trade
  • GET Fiat Buy/Sell trade history

• Added new error codes

2025-06-13

• Added auto convert related enums for bills and transaction details endpoints
  • Get bills details (last 7 days)
  • Get bills details (last 1 year)

2025-06-03

• Add currency level response parameters colBorrAutoConversion, indicating the indicator of forced repayment when the collateralized borrowing on a crypto reaches the platform limit and users' trading accounts hold this crypto.
  • Get balance
  • Get sub-account trading balance
  • Account channel

2025-05-30

• Add account level response parameters availEq, indicating the account level available equity excluding currencies that have been restricted for collateralized borrowing; add currency level response parameter collateralRestrict, which marks coin as restricted for collateralized borrowing.
  • Get balance
  • Get sub-account trading balance
  • Account channel

• Add currency level response parameter collateralRestrict, which marks coin as restricted for collateralized borrowing
  • Get discount rate and interest-free quota

2025-05-29

Add id parameter to all websocket subscribe & response

• Added an optional id parameter to the subscribe requests for websocket connections with the following url paths:
  • /ws/v5/public
  • /ws/v5/private
  • /ws/v5/business

The same id will be included in all the assoicated response messages to help users to reliably map responses to the corresponding requests:

Add pre-open related response parameters

For pre-open details, please refer to OKX call auction and pre-open mechanism.

• For tickers, return best bid/ask based on actual order book during the pre-open period, where the best ask price may be lower than the best bid price.

  • GET / Tickers
  • GET / Ticker
  • WS / Tickers channel

• For depth data, return all depth data where the best ask price may be lower than the best bid price.

  • GET / Order book
  • GET / Full order book
  • WS / Order book channel

• Add cancelSource:43, indicating batch cancellation at the end of the pre-open period.

  • WS / Order channel

• Instruments REST endpoint and WebSocket channel add new response parameters contTdSwitchTime and openType
  • Get instruments (private)
  • Get instruments (public)
  • Instruments channel

• Add error codes 51196, 51197

2025-05-28

DMA Broker Endpionts Revamp

Last update: May 14, 2025

It has been released to demo trading environment and will be in production in late-May.

• Delist enumeration value for perm field
  
  • Create an API Key for a sub-account
    
  • Query the API Key of a sub-account
    

• Field renaming and addition
  • Get sub-account list
  • Get sub-account fee rates

2025-05-27

Adjustment for websocket disconnect notification

To enhance the API service, websocket disconnect notification (event = notice) will adjust from 30 seconds prior to the upgrade of the WebSocket service to 60 seconds.

The feature has launched to production on May 27, 2025 (effective on June 2, 2025).

2025-05-26

• The request parameter has been updated as follows:
  • Get funding rate

Before

After

2025-05-21

• Added Move positions and Get move positions history endpoints

  • Move positions
  • Get move positions history

• Added move positions related enums for bills and transaction details endpoints

  • Get bills details (last 7 days)
  • Get bills details (last 1 year)
  • GET / Transaction details (last 3 days)
  • GET / Transaction details (last 1 year)

• Added move positions related error codes

2025-05-15

• Added new enumeration values
  • Asset bills details

2025-05-08

• Added new enumeration values
  • (Flexible loan) GET / Loan history

2025-05-07

• Added new enumeration values for cancelSource field
  • WS / Order channel

• Added new bill subtypes for trading account
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)
  • GET / Transaction details (last 3 days)
  • GET / Transaction details (last 1 year)

• Added new endpoints
  • (SOL staking) GET / Product info

2025-05-06

Instruments endpoints revamp

OKX revamped instruments REST endpoints and WebSocket channel, which will update listTime or expTime once the listing and delisting announcement is published.

Instrument listing

• Get instruments (public)
• Instruments channel

Instruments REST endpoint and WebSocket channel will update listTime once the listing announcement is published:

1. For SPOT/MARGIN/SWAP, this event is only applicable to instType, instId, listTime, state.
   
2. For FUTURES, this event is only applicable to instType, instFamily, listTime, state.
   
3. Other fields will be "" temporarily, but they will be updated at least 5 minutes in advance of the listTime, then the WebSocket subscription using related instId/instFamily can be available.
   

Instrument listing - Channel update example

{
  "arg": {
    "channel": "instruments",
    "instType": "SPOT"
  },
  "data": [
    {
        "alias": "",
        "auctionEndTime": "",
        "baseCcy": "",
        "category": "",
        "ctMult": "",
        "ctType": "",
        "ctVal": "",
        "ctValCcy": "",
        "expTime": "",
        "instFamily": "",
        "instId": "BTC-USDT",
        "instType": "SPOT",
        "lever": "",
        "listTime": "1606468572000",
        "lotSz": "",
        "maxIcebergSz": "",
        "maxLmtAmt": "",
        "maxLmtSz": "",
        "maxMktAmt": "",
        "maxMktSz": "",
        "maxStopSz": "",
        "maxTriggerSz": "",
        "maxTwapSz": "",
        "minSz": "",
        "optType": "",
        "quoteCcy": "",
        "settleCcy": "",
        "state": "preopen",
        "ruleType": "",
        "stk": "",
        "tickSz": "",
        "uly": ""
    }
  ]
}

Instrument delisting

• Get instruments (private)
• Get instruments (public)
• Instruments channel

Instruments REST endpoints and WebSocket channel will update expTime once the delisting announcement is published.

2025-04-28

AWS domain ceased service

AWS domain ceased service, please switch to the other service domain. AWS domain as follows:

2025-04-24

• Delisted request filed from the document
  • Get algo order list
    

• Delisted endpoints from the document
  • Cancel Advance Algo Order
  • Get the user's affiliate rebate information

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

• Added new request parameter
  • Add investment

2025-04-02

OKX plans to roll out updates to the funding rate calculation method for perpetual contracts in batches starting mid-April. The API related changes have been released to production.

For specific updates and the schedule, please refer to the announcement: Learn more.

• The premium field of the following endpoints always represents the premium index calculated by the current premium formula.

  • Get premium history
  • Get funding rate
  • Funding rate channel

• Add a new response parameter and push data parameter, formulaType, to indicate whether the funding rate is calculated by the new formula.

  • Get funding rate
  • Funding rate channel
  • Get funding rate history

• Add a new response parameter and push data parameter, interestRate and impactMargin
  • Get funding rate
  • Funding rate channel

2025-03-26

Setting collateral cryptocurrencies in multi-currency account mode

Learn more

• Added new response parameters
  • Get balance
  • Account channel

• Added new endpoints

  • Set collateral assets
  • Get collateral assets

• Added new error codes

Adding parameters for Websocket

• Added new response parameter
  • WS / Order channel

• Added new response parameter
  • Open interest channel

2025-03-21

• Add new enum third_quarter for response parameter alias. Please refer to expTime response field to get the expiration time.
  • Get instruments (public)
  • Instruments channel

2025-03-19

• Added new parameters
  • Get sub-account list

2025-03-18

One-click repay supported in SPOT mode

• Added new endpoints

  • GET / One-click repay currency list (New)
  • POST / Trade one-click repay (New)
  • GET / One-click repay history (new)

• Added new error codes

2025-03-12

Expiry futures daily settlement

OKX will launch a daily settlement mechanism for expiry futures in cross-margin mode, Learn more

• Added new endpoint

  • Get estimated future settlement info
  • Get future settlement history

• Added new response parameters

  • Get estimated delivery/exercise/settlement price

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

• Added new response parameters
  • Get positions
  • Get positions history
  • Positions channel
  • Balance and position channel

• Added new enums for parameters
  • Balance and position channel

• Added new enums for parameters
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

New cancelSource enumeration

• Added new enumeration values for cancelSource field
  • WS / Order channel

Add pagination parameters in push data in account and position channels

• Add eventType, curPage, lastPage push data parameters to account and positions WebSocket channels.
  • Account Channel
  • Positions Channel

Push data parameters

2025-03-03

Fixed Loan and Simple Earn Fixed going offline

Fixed Loan

• API offline
  • Convert fixed loan to market loan (POST /api/v5/account/fixed-loan/convert-to-market-loan)
  • Manual renew fixed loan borrowing order (POST /api/v5/account/fixed-loan/manual-reborrow)
  • Place fixed loan borrowing order (POST /api/v5/account/fixed-loan/borrowing-order)
  • Reduce liabilities for fixed loan (POST /api/v5/account/fixed-loan/reduce-liabilities)
  • Repay fixed loan borrowing order (POST /api/v5/account/fixed-loan/repay-borrowing-order)
  • Amend fixed loan borrowing order (POST /api/v5/account/fixed-loan/amend-borrowing-order)
  • Get fixed loan borrow limit (GET /api/v5/account/fixed-loan/borrowing-limit)
  • Get fixed loan borrow order list (GET /api/v5/account/fixed-loan/borrowing-orders-list)
  • Get fixed loan borrow quote (GET /api/v5/account/fixed-loan/borrowing-quote)

Simple Earn Fixed

• API offline
  • Amend lending order (POST /api/v5/finance/fixed-loan/amend-lending-order)
  • Get lending APY history (GET /api/v5/finance/fixed-loan/lending-apy-history)
  • Get lending offers (GET /api/v5/finance/fixed-loan/lending-offers)
  • Get lending order list (GET /api/v5/finance/fixed-loan/lending-orders-list)
  • Get lending sub order list (GET /api/v5/finance/fixed-loan/lending-sub-orders)
  • Get lending volume (GET /api/v5/finance/fixed-loan/pending-lending-volume)
  • Place lending order (POST /api/v5/finance/fixed-loan/lending-order)

2025-02-12

Isolated margin support base and quote mcurrency as collateral

OKX released a new isolated margin trading mode (auto_transfers_ccy) to support either base or quote currency as collateral for long and short positions. For example, when longing BTC-USDT, users were previously required to use BTC as collateral. With this update, USDT can also be used. The same applies to short positions.

After users are switched to the new isolated margin trading mode, they must specify the collateral currency using the ccy parameter when placing isolated margin orders. If the parameter is missing, an error will be returned with code 50014 and the message: "Parameter ccy cannot be empty."

The API changes are listed below:

• Add a new enumeration value auto_transfers_ccy for the isoMode request parameter. Users are not allowed to revert to the old mode once they switch to the new one.
  • Isolated margin trading settings

Request Parameters

• Add a new enumeration value auto_transfers_ccy for the mgnIsoMode response parameter.

  • Get account configuration

• For placing orders, users must pass in ccy request parameter to indicate the collateral currency for isolated margin trading when they are in the auto_transfers_ccy mode. Otherwise, an error will be returned with code as 50014 and message as "Parameter ccy cannot be empty".

  • POST / Place order
  • POST / Place multiple orders
  • WS / Place order
  • WS / Place multiple orders
  • Place algo order

• For order details, ccy response parameter will be returned if users trade isolated margin under auto_transfers_ccy mode.

  • GET / Order details
  • GET / Order List
  • GET / Order history (last 7 days)
  • GET / Order history (last 3 months)
  • WS / Order channel
  • Algo order details
  • Algo order list
  • Algo order history
  • Algo orders channel
  • Advance algo orders channel

• For position details, ccy response parameter will be returned if users trade isolated margin under auto_transfers_ccy mode.

  • Get positions
  • Get positions history
  • Positions channel
  • Balance and position channel

• For get maximum order quantity, users can pass in ccy to decide which currency to be used as collateral.

  • Get maximum order quantity

• For the endpoints below, users must pass in ccy.

  • Get maximum available balance/equity
  • Increase/decrease margin
  • Get leverage estimated info

• For the endpoints below, users must pass in mgnCcy.

  • Get the maximum loan of instrument

• Added new bill subtypes for trading account

  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

• Array attachAlgoOrds with stop-profit and stop-loss is be available
  • Place order
    
  • Place multiple orders
    

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

2025-01-17

Update margin calculation rules for the portfolio margin mode

To provide better trading services, OKX will update margin calculation rules for portfolio margin mode.

More details refer to OKX will update margin calculation rules for the portfolio margin mode

API have adjustment as follows:

• Adjusted response parameters
  • Get account configuration

• API offline
  • Set risk offset type (POST /api/v5/account/set-riskOffset-type)

2025-01-15

• Added new parameters & remove parameters
  • Position builder (new)

Request parameters

Response parameters

2025-01-07

Get oracle API is offline

Get oracle API is offline, please use Get token market data instead.

2024-12-31

• Adjusted request parameters
  • (ETH staking)Purchase&Redeem history
  • (SOL staking)Purchase&Redeem history

Before

After

2024-12-18

• OKX supports tag level cancel all after for MMP orders (ordType: mmp, mmp_and_post_only)

  • POST / Cancel All After
    

• Added new request parameters

  • First copy settings
  • Amend copy settings

• The copy trading endpoints below are open.
  • First copy settings
  • Amend copy settings
  • Stop copying
  • Copy settings
  • My lead traders

Websocket disconnect notification for service upgrade

To enhance the API service, WebSocket has introduced a new message type (event = notice). 30 seconds prior to the upgrade of the WebSocket service, the following message will be sent to users indicating that the connection will soon be disconnected. Users are encouraged to establish a new connection to prevent any disruptions caused by disconnection.

The feature is supported by WebSocket Public (/ws/v5/public) and Private (/ws/v5/private).

2024-12-16

• Added new module

  • SOL staking

• The copy trading function below is delisted.

  • Multiple leverages
  • Set Multiple leverages
  • My history lead traders
  • Existing lead or copy positions
  • Lead or copy position history
  • Place lead or copy stop order
  • Close lead or copy position
  • Copy trading notification channel
    

• The lead trading function below is delisted.

  • Apply for lead trading
  • Stop lead trading
  • Lead trader ranks (private)
  • Lead trader weekly pnl (private)
  • Lead trader daily pnl (private)
  • Lead trader stats (private)
  • Lead trader currency preferences (private)
  • Lead trader current lead positions (private)
  • Lead trader lead position history (private)
  • Copy traders (private)

2024-12-11

• Added lmtPx request parameter to block trade create rfq endpoint.
  • Create RFQ

Request Parameters

• Delayed the block trade public trades update for 15 minutes. The affected endpoints are:

  • Get public multi-leg transactions of block trades
  • Get public single-leg transactions of block trades
  • Public structure block trades channel
  • Public block trades channel

• Added fillPnl response parameter to nitro spread private trade endpoints.

  • Get trades (last 7 days)
  • Trades channel

2024-12-04

• OKX added endpoints to support users to switch account modes while holding certain types of positions. If users plan to switch account modes while holding positions, they should first call the preset endpoint to conduct necessary settings, then call the precheck endpoint to get unmatched information, margin check, and other related information, and finally call the account mode switch endpoint to switch account modes.

  • Preset account mode switch
  • Precheck account mode switch
  • Set account mode

• Added error codes.

2024-12-03

• Added new request parameter
  
  • Get trades
    

• Added new request parameter
  
  • Get trades
    
  • Structure block trades channel
    

2024-11-28

• OKX adds new push data parameter seqId for nitro spread order book channls, spread-bbo-tbt and sprd-books5.

  • Order book channel

• Broker endpoint path revamp
  Changing the URL prefix under DMA Broker from "/broker/nd" to "/broker/dma".

2024-11-22

• Added new response parameters
  • Get currencies

2024-11-21

Fixed Loan and Simple Earn Fixed going offline

As part of our ongoing endeavour to stay responsive to users' demands, we will be upgrading our fixed-term Loan and Earn products. As such, we will be taking VIP Loan and Simple Earn Fixed offline to implement changes. This will not affect Simple Earn Flexible.
Starting from 6:00 am UTC on November 21, 2024, new subscriptions will be disabled.
Announcements

Fixed Loan API adjustment

• Function restricted
  • Get fixed loan borrow limit
  • Get fixed loan borrow quote
  • Place fixed loan borrowing order
  • Amend fixed loan borrowing order
  • Manual renew fixed loan borrowing order

Simple Earn Fixed API adjustment

• Function restricted

  • GET / Lending offers (public)
  • GET / Lending APY history (public)
  • GET / Lending volume (public)
  • POST / Place lending order

• Adjusted request parameters

  • POST / Amend lending order

2024-11-20

• Adjusted request parameters
  • Get the maximum loan of instrument

Before

After

Chase order

Chase order has been launched.

• Add new request parameter or enumeration.
  • Place algo order

Chase order

It will place a Post Only order immediately and amend it continuously
Chase order and corresponding Post Only order can't be amended.

• Add new response parameters.
  • Algo order details
  • Algo order list
  • Algo order history
  • Algo orders channel

• Add new request parameter numeration.
  • Algo order list
  • Algo order history

• Add new response parameter numeration.
  • Order details
  • Order List
  • Order history (last 7 days)
  • Order history (last 3 months)
  • Order channel

2024-11-18

• Added new module

  • Flexible loan

• Added new error codes

2024-11-14

• Adjusted response parameters
  • Get currencies

Before

After

• Added new endpoint
  • Get sub-account fee rates

2024-11-11

• OKX starts to support historical position data under the portfolio margin account mode. This function has been launched in production at 04:00 AM (UTC) on November 11, 2024. After the function is launched, the newly created positions of users in the portfolio margin account mode will generate historical position records after closing; positions created before the launch of the function will not generate historical position records when closed after the launch.
  • Get positions history

2024-11-08

• Added response parameters
  • Get account configuration

For the discount rate related fields delist, the discount rate related fields that are unnecessary was delisted. There is more detail below:

Related change: OKX to change discount rate rules in multi-currency and portfolio margin modes

• Get account configuration

• Get discount rate and interest-free quota

• The limit is adjusted to 30 WebSocket connections per specific WebSocket channel per sub-account for certain channels.
  • Connection count limit

2024-10-28

• Added response parameters
  • GET / Offers

• Added response parameters
  • GET / Active orders

• Added new endpoints

  • GET / Product info

• Added response parameters

  • GET / Purchase&Redeem history

2024-10-23

• Add a new auctionEndTime response parameter to indicate the end time of call auctions. The preopen of state is introduced for certain symbol listing, and the listTime will be updated to reflect the listing time.
  • Get instruments (private)
  • Get instruments (public)
  • Instruments channel

• Added response parameters:
  • Get balance
  • Get sub-account trading balance
  • Account channel

2024-10-17

Convert revamp

Convert

• New added error code

• According trading bills
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

Easy convert

• Added new request parameters
  • GET / Easy convert currency list
  • POST / Place easy convert

• According trading bills
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

One-click repay

• According trading bills
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

Small assets convert

• API offline
  • Small assets convert

2024-10-15

• Added new response parameters
  • Get fixed loan borrow limit

• Added new request parameters
  • Get fixed loan borrow order list

• Added enumeration for parameter
  • Get sub-account list

2024-10-14

• Added new endpoints

  • Manual borrow / repay
  • Set auto repay
  • Get borrow/repay history

• Added new request parameters

  • Get leverage

• Added new bill subtypes for trading account
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

• Added new error codes

2024-10-10

• Added new response parameters
  • Get currencies

• Added new response parameters
  • Get non-tradable assets

• Nitro spread supports market orders, the request and response parameter ordType adds the enumeration value market.

  • Place order
  • Get order details
  • Get active orders
  • Get orders (last 21 days)
  • Get orders history (last 3 months)
  • WS / Place order
  • Order channel

• Nitro spread adds a new order cancellation scenario, the cancelSource response parameter adds the enumeration value 15: Order canceled: The order price is beyond the limit.

  • Get order details
  • Get active orders
  • Get orders (last 21 days)
  • Get orders history (last 3 months)
  • Order channel

2024-10-04

• Added call auction details WebSocket channel
  • WS / Call auction details channel

2024-10-01

• Added public feature for endpoint:
  • GET / Announcements

2024-09-20

• Added new endpoints

  • Convert fixed loan to market loan
  • Reduce liabilities for fixed loan

• Added enumeration for parameter

  • Get fixed loan borrow order list

• Added enumeration for response parameter adlType. For more information, please refer to the product documentation. Introduction to Auto-deleveraging (ADL).
  • Get insurance fund
  • ADL warning channel

2024-09-19

• Added new response parameters
  • Get account configuration

• Added new response parameters
  • Get leverage

• Add response parameters
  • Get discount rate and interest-free quota

• Add request parameters
  • Mass Cancel Order channel
    
  • Mass Cancel Order
    

• Add new error codes

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

• Transaction details (last 2 years) endpoints below was delisted
  • POST / Transaction details (in the past 2 years)
  • GET / Transaction details (in the past 2 years)

2024-09-18

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

2024-09-13

• Added new error codes

• Added new response parameter for rfq public-trades endpoint to get the name of the strategy.
  • GET public-trades

Response Parameters

2024-08-29

• Trade fee endpoint adds ruleType request and response parameters to distinguish trade fee rates of different trade rule types.
  • Get fee rates

Request Parameters

Response Parameters

• Added new response parameter for get open interest endpoint.
  • Get open interest

Response Parameters

2024-08-28

• Added response parameters:
  • Get balance
  • Get sub-account trading balance
  • Account channel

• Added new endpoint
  • GET / Max grid quantity (public)

2024-08-22

• Nitro spread private trade endpoints added a new response parameter szCont, presenting the filled contract amount of a single leg.
  • Get trades (last 7 days)
  • Trades channel

• To better use experience, regarding the endpoints/channels related to the account, information on crypto with a balance less than 1e-8 has been included in "details"
  • Get balance
  • Get sub-account trading balance
  • Account channel
  • Balance and positions channel
  • Get account and position risk

2024-08-21

• Added call auction details endpoint

  • GET / Call auction details

• Added new error codes

• Added new order book channel for Nitro Spread sprd-books-l2-tbt. 400 depth levels will be pushed in the initial full snapshot. Incremental data will be pushed every 10 ms for the changes in the order book during that period of time. When subscribing to this channel, the following parameters are added to the push data: action, checksum, prevSeqId, and seqId
  • Order book channel

2024-08-14

Added fills channel

• WS / Fills channel

OKX to change discount rate rules in multi-currency and portfolio margin modes

OKX will change the discount rate rules in phases. For details, please refer to OKX to change discount rate rules in multi-currency and portfolio margin modes .

The changes on API have been released in the demo trading environment and will go live in production in mid August. To avoid any impact on your trading strategies, please refer to the content below for necessary adjustments.

• As the feature is deployed in phases, you can find out the discount rule type of the current account by response parameter discountType from Get account configuration:

  • When discountType is 0, it represents that you are under the original discount rate rules, which are related to Array discountInfo from Get discount rate and interest-free quota;
  • When discountType is 1, it represents that you are under the new discount rate rules, which are related to Array details from Get discount rate and interest-free quota;

• Add new response parameter. After new discount rate rules are effective completely, this parameter will be removed from the endpoint. Advice you to prepare in advance.

  • Get account configuration

• Get discount rate and interest-free quota parameter adjustments.
  • Besides the responses of the original discount details (Array discountInfo), New discount details (Array details) will be added;
  • discountLv will be , advise you don't use it anymore;
  • After new discount rate rules are effective completely, the original discount details (Array discountInfo) will be removed from the endpoint. Advice you to prepare in advance.

Before:

After:

Added endpoints

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

Added request fields

* Amend algo order

2024-08-08

Withdrawal API adjustment for Bahamas entity users

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

(User entity information reference: https://www.okx.com/help/terms-of-service )

Withdraw assets to the exchange wallet

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

• Users under the Bahamas entity need to pass in the following field information of the recipient (rcvrFirstName, rcvrLastName, rcvrCountry, rcvrCountrySubDivision, rcvrTownName, rcvrStreetName). For the exchange wallet belongs to business recipient, rcvrFirstName may input the company name, rcvrLastName may input "N/A", location info may input the registered address of the company. The examples are as follows:

Withdraw assets to the private wallet

If users withdraw assets to the private wallet, there is no need to provide recipient information. The examples are as follows:

Newly added error code

If Bahamas entity users do not pass in the new parameter rcvrInfo, the following error code will be returned.

2024-08-01

• Add posSide response parameter in the historical positions endpoint, indicating the position mode side.
  • Get positions history

• Added new endpoint
  • POST / Order precheck

2024-07-23

• Added ruleType response parameter for instrument endpoints, indicating the trading rule types.
  • Get instruments (private)
  • Get instruments (public)
  • Instruments channel

• Added new error codes

2024-07-17

• Added subscription restriction for order book channel. After the adjustment, within the same connection, users will not be able to simultaneously subscribe to books-l2-tbt and books50-l2-tbt/books channels for the same trading symbol.
  • WS / Order book channel

If a user has already subscribed to the books-l2-tbt order book channel for a specific trading symbol within the same connection and then decides to subscribe to the books50-l2-tbt/books channels, we will retain the user's books-l2-tbt subscription since it provides more depth of the order book and is prioritized in the push sequence. An error code 64004 will be returned for the new subscription. An example is provided below.

If a user has already subscribed to the books50-l2-tbt/books order book channels for a specific trading symbol within the same connection and then decides to subscribe to the books-l2-tbt channel, we will make new subscriptions to the books-l2-tbt channel and then cancel the user's existing books50-l2-tbt/books subscriptions. This is also because the books-l2-tbt channel provides more depth and is prioritized in the push sequence.

Note that the unsubscription process may have a delay of a few seconds, meaning the user might continue to receive messages from the old channels for a few seconds after successfully subscribing to the new channel.

• Added new error code

• Added new request parameter instId for bills endpoints
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

• Added new error code

• Added new error code. For batch placement and batch amendation under portfolio margin mode, the order will get the error 54004 if its failure caused by another order's failure.

  • POST / Place multiple orders
  • POST / Amend multiple orders
  • WS / Place multiple orders
  • WS / Amend multiple orders

• Added new request parameters:
  • Place grid algo order
    

2024-07-04

2024-07-03

• Added enumeration for parameter
  • Recurring buy order list
  • Recurring buy order details
  • Recurring buy orders channel

• SPOT and MARGIN Supported TP/SL modification
  
  • POST / Amend order
  • POST / Amend multiple orders
  • POST / Amend multiple orders
    

2024-06-26

• Added new endpoints

  • (Simple earn fixed) Place lending order
  • (Simple earn fixed) Amend lending order
  • (Simple earn fixed) Get lending order list
  • (Simple earn fixed) Get lending sub order list

• Add new response parameters

  • (Simple earn fixed) Get lending offers (public)

2024-06-25

• Added a new endpoint for spread trading cancel all after
  • Cancel All After

2024-06-20

• Added new response parameter acct, indicating which account the fund is.
  • GET / Easy convert history

2024-06-19

• Add tag request and response parameters to support order tag level CAA.
  • POST / Cancel All After

• Add error code 51071

• Fix the data push sequence for different order book channels within the same connection and trading symbol. After the adjustment, the push sequence for order book channels within the same connection and trading symbol will be fixed as follows: bbo-tbt -> books-l2-tbt -> books50-l2-tbt -> books -> books5.
  • WS / Order book channel

• Only whitelist users can use the copy trading function. The lead trading function won't be affected.

  • First copy settings
  • Amend copy settings
  • Stop copying
  • Copy settings
  • Multiple leverages
  • Set Multiple leverages
  • My lead traders
  • My history lead traders
  • Existing lead or copy positions
  • Lead or copy position history
  • Place lead or copy stop order
  • Close lead or copy position

• Data from the endpoints below will be delayed 5 minutes

  • Lead trader current lead positions (private)
  • Lead trader current lead positions
  • Copy trading notification channel
    

• The sensitive parameters on endpoints below will be "" when lead traders enable lead trading protection

  • Lead trader current lead positions (private)
  • Lead trader current lead positions

These parameters are affected

2024-06-13

• Added new endpoints
  • Get contract open interest history
  • Get contract taker volume
  • Get top traders contract long/short ratio
  • Get top traders contract long/short ratio (by position)
  • Get contract long/short ratio

2024-06-05

OKX starts to enable users to customize the spot risk offset amount, only applicable to Portfolio Margin Mode. The new feature and corresponding changes are listed below:

• Add a new endpoint Set risk offset amount
• Add new response parameters clSpotInUseAmt/maxSpotInUseAmt, representing user-defined spot risk offset amount and max possible spot risk offset amount respectively. The spotInUseAmt will represent the actual spot risk offset amount.
  • Get balance
  • Account channel
  • Get positions
  • Positions channel

• Add new enumeration value for request and response parameters
  • Set risk offset type

• Add new error codes

2024-06-03

• Added new endpoints

  • Get fixed loan borrow limit
  • Get fixed loan borrow quote
  • Place fixed loan borrowing order
  • Amend fixed loan borrowing order
  • Manual renew fixed loan borrowing order
  • Repay fixed loan borrowing order
  • Get fixed loan borrow order list

• Added new enumeration value

  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

2024-05-30

• Added new module Simple earn fixed
• Added new enumeration value
  • Asset bills details

2024-05-15

• Added new response parameters:
  • Account configuration

Response parameter

2024-05-10

• Added new endpoints for spread trading market data
  • Get ticker (Public)
  • Get candlesticks
  • Get candlesticks history
  • Candlesticks channel

2024-05-09

• Add new push data parameters for spread tickers channel.
  • Tickers channel

Push data parameters

2024-05-08

• Added new endpoint

  • Add investment

• New enumeration value for sprdType field

  • Get Spreads (Public)

• Added new endpoint
  • Get instruments

2024-05-06

• Added response parameters
  • Get the invitee's detail

2024-04-25

• Commission detail download optimization
  • Get download link(ND)

Added new response fields for decompressed CSV file. Changed the data dimension from order to fill.

2024-04-24

• Added new endpoint

  • Get premium history

• Added new endpoints

  • Get contract credits
  • Activate contract credit

• Added new response parameters
  

  • Order details
  • Order List
  • Order history (last 7 days)
  • Order history (last 3 months)

• Added new response parameter ts.

  • POST / Place order
  • POST / Place multiple orders
  • POST / Amend order
  • POST / Amend multiple orders
  • POST / Cancel order
  • POST / Cancel multiple orders
  • WS / Place order
  • WS / Place multiple orders
  • WS / Amend order
  • WS / Amend multiple orders
  • WS / Cancel order
  • WS / Cancel multiple orders

Response parameter

2024-04-18

• Added new response parameters
  • GET / offers

• The moon grid has been offline

2024-04-11

• In order to improve system performance and optimize user experience, OKX decides to reduce some fields in the position risk warning channel. After the change, the corresponding fields will return "" or [], and after a period of time, it will be completely offline. Users can access the same fields using the positions channel.
  

• Position risk warning

The deleted fields are listed as follows:

• Added new response parameter acctStpMode
  • Get account configuration

2024-04-10

• For better trading experience, the exchange exempts new and amendment request count of fiat trading symbols but still keep the trading volume when calculating rate limit

• Add new request and response parameter subType for transaction details endpoints.

  • GET / Transaction details (last 3 days)
  • GET / Transaction details (last 3 months)

Request parameter

Response parameter

2024-04-02

• Added new endpoint, Cancel All after for block trading quotes
  • Cancel All After

2024-03-27

• Decommissioned the order lite book endpoint GET /api/v5/market/books-lite.

• Exempted SPOT/MARGIN orders from the sub-account rate limit.

2024-03-19

• Released new feature connection count limit per private WebSocket channel

To enhance system stability and fairness to users, the exchange starts to impose limitations on the number of concurrent WebSocket connections allowed to subscribe to the following WebSocket channels. The limit will be set at 20 WebSocket connections per specific WebSocket channel per sub-account. Each WebSocket connection is identified by the unique connId.

The WebSocket channels subject to this limitation are as follows:

1. Orders channel
2. Account channel
3. Positions channel
4. Balance and positions channel
5. Position risk warning channel
6. Account greeks channel

If users subscribe to the same channel through the same WebSocket connection through multiple arguments, for example, by using {"channel": "orders", "instType": "ANY"} and {"channel": "orders", "instType": "SWAP"}, it will be counted once only. If users subscribe to the listed channels (such as orders and accounts) using either the same or different connections, it will not affect the counting, as these are considered as two different channels. The system calculates the number of WebSocket connections per channel.

The platform will send the number of active connections to clients through the channel-conn-count event message to new channel subscriptions.

Connection count update

{
    "event":"channel-conn-count",
    "channel":"orders",
    "connCount": "2",
    "connId":"abcd1234"
}

When the limit is breached, generally the latest connection that sends the subscription request will be rejected. Client will receive the usual subscription acknowledgement followed by the channel-conn-count-error from the connection that the subscription has been terminated. In exceptional circumstances the platform may unsubscribe existing connections.

Connection limit error

{
    "event": "channel-conn-count-error",
    "channel": "orders",
    "connCount": "20",
    "connId":"a4d3ae55"
}

Order operations through WebSocket, including place, amend and cancel orders, are not impacted through this change.

2024-03-14

• Released new feature mandatory self trade prevention at 10:00 (UTC) on March 14

  • Deprecated the stpId field in the Place order(Batch place orders) REST endpoint and WebSocket channel.
  • For order book trading, the default stpMode is Cancel Maker. Users can utilize the stpMode request parameter of Place order(Batch place orders) REST endpoint and WebSocket channel to determine the stpMode for new orders of certain order types.
  • For spread trading, Cancel maker is supported by default and only.
  • For orders that are canceled due to self trade prevention, users can query the records of cancelSource = 32 in the historical orders endpoint. The order channel will also push relevant information.
  • For block trading, the RFQ will face creation failure if all makers are under the same master account of the taker, and the taker will receive error code "56004". Otherwise, the RFQ will be created but not be received by makers that are under the same master account of the taker.

• Added new enumeration values for cancelSource field

  • WS / Order channel

• New enumeration value for withdrawal state
  • Get withdrawal history
  • Get sub-account withdrawal history
  • Withdrawal info channel

• Added new response parameters and numerations
  
  • Get grid algo order list
    
  • Get grid algo order history
    
  • Get grid algo order details
    
  • Contract grid algo orders channel

• OKX restricted the use of the copy trading notification channel. Only the clients who are on the whitelist can get updates.
  • Copy trading notification channel
    

2024-03-12

• Released new feature

  • Sub-account rate limit
  • Fill ratio based sub-account rate limit

• Added new error code

2024-03-06

• Added new request parameters:
  • Place grid algo order
    
  • Amend grid algo order

• Added new response parameters and numerations
  
  • Get grid algo order list
    
  • Get grid algo order history
    
  • Get grid algo order details
    
  • Contract grid algo orders channel

• Added new error codes

2024-02-28

The function of TP limit order has been deployed to the production.

• Added new request parameter:
  • Place order
  • Place multiple orders
  • Place algo order

• Added new request parameters:
  • Amend order
  • Amend multiple orders

• Added new response parameters and numerations
  
  • Order details
  • Order List
  • Order history (last 7 days)
  • Order history (last 3 months)
  • Order channel

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

• Added new error codes

• Newly added endpoints

  • Position builder (new)

• Newly added endpoints

  • Get the user's broker rebate information

• Added a new endpoint to retrieve the full order book.

  • GET / Full order book

• Added new fields for the trial fund balance

  • Get balance
  • Account channel

• Add new response parameter for premium
  • Get funding rate
  • Funding rate channel

• Added new enumeration values of bill type and subtype for structured products
  • Get bills details (last 7 days)
  • Get bills details (last 3 months)

• Isolated margin trading settings parameter isoMode deprecated quick_margin

2024-02-07

• Newly added endpoint, which returns rate limit and fill ratio related data. For more details, please refer to Fill ratio based sub-account rate limit.
  • GET / Account rate limit

2024-02-06

• Newly added endpoints
  • Position builder (new)

2024-02-01

• Add new response parameters
  • Get deposit address
  • Lightning deposits

2024-01-31

• Add newly endpoints for signal bot trading
• Improve the updateInterval request parameter
  • Positions channel

Before:

After:

• Deleted isoMode enum (autonomy: Manual transfers) in Isolated margin trading settings

2024-01-22

OKX has migrated savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints has been offline on 2024/01/22.

• Added a new function module Savings, the relevant endpoints of the savings are adjusted as follows
  • Get saving balance adjusted endpoint path from /api/v5/asset/saving-balance to /api/v5/finance/savings/balance
  • Savings purchase/redemption adjusted endpoint path from /api/v5/asset/purchase_redempt to /api/v5/finance/savings/purchase-redempt
  • Set lending rate adjusted endpoint path from /api/v5/asset/set-lending-rate to /api/v5/finance/savings/set-lending-rate
  • Get lending history adjusted endpoint path from /api/v5/asset/lending-history to /api/v5/finance/savings/lending-history
  • Get public borrow info (public) adjusted endpoint path from /api/v5/asset/lending-rate-summary to /api/v5/finance/savings/lending-rate-summary
  • Get public borrow history (public) adjusted endpoint path from /api/v5/asset/lending-rate-history to /api/v5/finance/savings/lending-rate-history

2024-01-18

• Add new response parameters
  • Get balance
  • Get sub-account trading balance
  • Account channel

Response Parameters

2024-01-17

• Added new endpoints and channel

  • Apply for lead trading
  • Stop lead trading
  • Amend profit sharing ratio
  • Lead trader ranks (private)
  • Lead trader weekly pnl (private)
  • Lead trader daily pnl (private)
  • Lead trader stats (private)
  • Lead trader currency preferences (private)
  • Lead trader current lead positions (private)
  • Lead trader lead position history (private)
  • Copy traders (private)
  • Copy traders
  • Account configuration
  • Total unrealized profit sharing
  • Lead trading notification channel

• Added new response parameters:

  • Get profit sharing details
  • Get unrealized profit sharing details

Response parameter

• Added new error codes

Liquidation and ADL data improvements

When liquidation happens under cross margin mode

• WS / Order channel

• Bills related endpoints, Get bills details (last 7 days), Get bills details (last 3 months)

• Balance and position channel, Positions channel

When liquidation happens under isolated margin mode

• WS / Order channel

• Bills related endpoints, Get bills details (last 7 days), Get bills details (last 3 months)

• Balance and position channel, Positions channel

When Auto-Deleveraging (ADL) happens

• WS / Order channel

• Bills related endpoints, Get bills details (last 7 days), Get bills details (last 3 months)

Note: After liquidation or ADL happens, the tradeId corresponding to the position will be set to "0". Through REST endpoints and Websocket channels, users will receive "tradeId": "0" until there is a new transaction for this position.

2024-01-18

• Add new response parameters
  • Get balance
  • Get sub-account trading balance
  • Account channel

Response Parameters

2024-01-10

• Updated the error messages for the error code below

• New enumeration value for cancelSource field
  • WS / Order channel

• Added historical ADL records into get insurance fund endpoint. Added new enumeration value adl for request parameter type; added new response parameters instType, maxBal, maxBalTs, decRate, adlType.
  • Get insurance fund

Request Parameters

Response Parameters

2024-01-09

• Newly added endpoints. Spread trading supports querying historical orders in the past three months.
  • Get orders history (last 3 months)

2024-01-04

• Added request parameters
  • Create sub-account (ND)

• Added new response parameter:
  • Get sub-account list
    

• Added new error codes

2023-12-28

OKX plans to migrate savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints will be offline on 2024/01/22. Please migrate to the new endpoints as soon as possible.

• Added a new function module Savings, the relevant endpoints of the savings are adjusted as follows
  • Get saving balance adjusted endpoint path from /api/v5/asset/saving-balance to /api/v5/finance/savings/balance
  • Savings purchase/redemption adjusted endpoint path from /api/v5/asset/purchase_redempt to /api/v5/finance/savings/purchase-redempt
  • Set lending rate adjusted endpoint path from /api/v5/asset/set-lending-rate to /api/v5/finance/savings/set-lending-rate
  • Get lending history adjusted endpoint path from /api/v5/asset/lending-history to /api/v5/finance/savings/lending-history
  • Get public borrow info (public) adjusted endpoint path from /api/v5/asset/lending-rate-summary to /api/v5/finance/savings/lending-rate-summary
  • Get public borrow history (public) adjusted endpoint path from /api/v5/asset/lending-rate-history to /api/v5/finance/savings/lending-rate-history

2023-12-20

• Set one year time range limit for response results

  • Get interest accrued data

• Added new response parameter or push data parameter enabled to indicate whether the price limit is in force

  • Get limit price
  • Price limit channel

Response Parameters