okx
Introduction
What is OKX OS
Preparation
Supported Networks
Wallet API
Introduction
Quick Start
On-Chain Information Query
Wallet Account Management
Transaction Broadcasting
Webhook
Signing SDK
Resources
DEX API
Introduction
Quick start
Swap API
Cross-chain API
Limit order API
DEX Widget
Marketplace API
Introduction
Runes API
Market API
BTC Ordinals API
Fractal Ordinals API
Error codes
DeFi API
Introduction
Quickstart
API reference
Error code
More resources
General specificationApply to display DAppsApp Universal LinkChangelogOKX Web3 Build User Agreement
More resources

Changelog#

November 25, 2024#

API/DEX APIUpdate

  • The single-chain swap API parameter swapReceiverAddress now supports the Solana chain. It is now possible to specify a different recipient address for a swap transaction on the Solana chain.

November 12, 2024#

API/DEX APIUpdate

  • Added a new referral wallet address parameter for the single-chain swap API. Both Sol and SPL tokens now support direct use of wallet addresses for referral fee collection.
  • APIs for retrieving the single-chain liquidity list and the cross-chain bridge list now support protocol logos.
  • Single-chain quote and swap APIs now recognize and return risk tokens with honeypot mechanisms or tokens with 100% buy/sell tax.

October 29, 2024#

API/DEX APIUpdate

  • Single-chain swaps now support the Sui chain.

July 1, 2024#

API/DEX APIUpdate

  • The ETH dexRouter contract 0xf3de3c0d654fda23dad170f0f320a92172509127 will no longer function normally after August 1, 2024. Please switch to the latest version.

June 19, 2024#

API/DEX APIUpdate

  • Swap API DEX Router eth contract address update

May 7, 2024#

API/DEX APIUpdate

  • Solana mainnet supports commission-sharing

April 19, 2024#

API/DEX APIUpdate

  • Cross-chain swap support SUI chain

April 19, 2024#

API/DEX APIUpdate

  • Cross-chain swap support X Layer chain

April 12, 2024#

API/DEX APIUpdate

  • Cross-chain slippage request parameter range adjusted to 0.002-0.5
  • Cross-chain swap support Merlin chain

April 12, 2024#

API/DeFi APIUpdate

  • Added new response parameters (quoteCompareList) to DEX swap endpoint

April 8, 2024#

API/DeFi APIUpdate

  • Added new response parameters (toTokenReferrerAddress) to DEX swap endpoint

April 2, 2024#

API/DeFi APIUpdate

  • Updated DEX swap trading support Merlin Chain

March 22, 2024#

API/DeFi APIUpdate

  • Added new response parameters (callDataMemo) to DEX swap endpoint

March 22, 2024#

API/DeFi APIUpdate

  • Added new request parameters (sort) to cross-chain Get route information and Cross-chain swap endpoint
  • DEX XBridge contract address update

March 13, 2024#

API/DeFi APIUpdate

  • Added new response parameters (sourceChainGasfee, destinationChainGasfee, crossChainFee) to cross-chain Get transaction status endpoint
  • Added new request parameters (onlyBridge) and new response parameters (minmumReceive，maxPriorityFeePerGas)
  • Cross-chain API Smart contract part added cross-chain contract address (DEX XBridge contract address)
  • Cross-chain API added new Get the list of tokens supported by the cross-chain bridges endpoint

March 07, 2024#

API/DeFi APIUpdate

  • Added new request parameters (priceImpactProtectionPercentage) to Cross-chain & Single-chain swap endpoint

February 29, 2024#

API/DeFi APIUpdate

  • Added new response parameters (decimal) to DEX swap endpoint

February 22, 2024#

API/DeFi APIUpdate

  • Added new response parameters (maxPriorityFeePerGas) to DEX swap endpoint

February 01, 2024#

API/DeFi APIUpdate

  • Updated DEX swap trading support solana, added new request parameters (solTokenAccountAddress)
  • Added DEX swap trading support solana quick start

January 17, 2024#

API/DeFi APIUpdate

  • Added new request parameters (feePercent, referrerAddress) to Cross-chain swap endpoint

January 11, 2024#

API/DeFi APIUpdate

  • Cross-chain slippage range adjusted to 0.005-0.5

January 02, 2024#

API/DeFi APIUpdate

  • Added new request parameters (receiveAddress) to Cross-chain swap endpoint
  • Added new request parameters (chainld) to cross-chain Get transaction status endpoint

December 28, 2023#

API/DeFi APIUpdate

  • Launched the first edition of OKX Web3 DeFi API documentation
  • Added functionality for investment, redemption, and reward claiming processes via DeFi API
  • Added methods for querying information, calculating estimated data, generating transaction data, and querying user information

December 20, 2023#

API/DEX APIUpdate

  • Added new response parameters (crossChainFeeTokenAddress) to cross-chain Get route information endpoint and Cross-chain swap endpoint
  • Added new response parameters (status) to cross-chain Get transaction status endpoint

December 14, 2023#

API/DEX APIUpdate

  • Added DEX Iframe

December 14, 2023#

API/DEX APIUpdate

  • Added new optional parameter (swapReceiverAddress) to DEX swap interface

December 08, 2023#

API/DEX APIUpdate

  • Added DEX limit order list query
  • Added DEX limit order get cancellation calldata

December 06, 2023#

API/DEX APIUpdate

  • Added new response parameters (toDexRouterList) to cross-chain Get route information endpoint
  • Added new response parameters (toAmount, errorMsg) to cross-chain Get transaction status endpoint
  • Added cross-chain refund issues to cross-chain FAQ

November 24, 2023#

API/DEX APIUpdate

  • The Order API has been expanded with a new listing module, enabling listings on OpenSea and OKX.
  • Added more detailed description to order structure

November 23, 2023#

API/DEX APIUpdate

  • Added DEX cross-chain API quick start guidelines

November 21, 2023#

API/DEX APIUpdate

  • Added DEX cross-chain API quick start guidelines

November 15, 2023#

API/DEX APIUpdate

  • Added new response parameters (crossChainFee) to cross chain Get route information endpoint cross-chain/quote
  • Added new response parameters (crossChainFee) to cross chain Cross-chain swap endpoint cross-chain/quote

November 10, 2023#

API/DEX APIUpdate

  • Added DEX API quick start guidelines

November 7, 2023#

API/DEX APIUpdate

  • Added DEX cross-chain aggregator API

October 31, 2023#

API/DEX APIUpdate

  • Added DEX limit order API

October 23, 2023#

API/DEX APIUpdate

  • Added smart contract information, including contract addresses and ABI

September 27, 2023#

DApps integration docs updatedUpdate

  • Updated the content of integrating DApps with OKX Wallet on the mobile app
  • Added guide and sub pages for integrating DApps with OKX Wallet on the mobile app

August 17, 2023#

API/Marketplace APIUpdate

  • Updated the API key authentication mechanism. Moving forward, all endpoints will require an API key generated from the Web3 developer portal.
  • Updated the URI of all endpoints to reflect the latest versioning
  • Updated error codes

API/DEX APIUpdate

  • Added API key authentication. Moving forward, all endpoints will require an API key generated from the Web3 developer portal
  • Updated error codes

API/Bitcoin ecosystemUpdate

  • Updated the API key authentication mechanism. Moving forward, all Web3 API endpoints will require an API key generated from the Web3 developer portal
  • Updated the URI of all endpoints to reflect the latest versioning

May 29, 2023#

API/Bitcoin ecosystemUpdate

  • Added new BRC-20 endpoint: brc20/token-list
  • Added new response parameters (index, location) to BRC-20 endpoint brc20/transaction-list
  • Added new response parameters (location) to BRC-20 endpoint brc20/inscriptions-list