Integrate the powerful OKX Widget into your product! With this widget, you can create an effective trading interface within 30 minutes.

Here is an example which shows how to use @okxweb3/dex-widget in a React project. You can find more examples through this [link](https://github.com/okx/dex-widget/tree/develop/packages/widget-configurator/src/react-cra).
Demo：https://okx.github.io/dex-widget/

; } const root = ReactDOM.createRoot(document.getElementById('root')); root.render( ); ``` ## Wallet Provider

You should pass the wallet provider information from your application if you want to connect a wallet. Then add the ON_CONNECT_WALLET event to seamlessly use the widget as part of your application.

- If it’s on Ethereum or other EVM networks, the provider must comply with EIP-1193 to implement the interface. - If it’s on Solana, the provider must pass the wallet provider information from your application. ```typeScript import { createOkxSwapWidget, ProviderType } from '@okxweb3/dex-widget'; const widgetEthInstance = createOkxSwapWidget( document.getElementById('widget'), { params: { providerType: ProviderType.EVM, }, provider: window.ethereum, // e.g. window.okexchain } ); const widgetSolanaInstance = createOkxSwapWidget( document.getElementById('widget'), { params: { providerType: ProviderType.SOLANA, }, provider: window.solana, // window.okexchain.solana } ); ```

You can check out this [link](https://github.com/okx/dex-widget/blob/faf69c76b90268f2352507c9a90fb37bb80fdbc7/example/widget-demo/src/main.tsx#L22)。 for an example of using the Rainbow kit to connect to a wallet.

## Params

The following sheet contains the descriptions of the params.

| Parameter | Type | Default | Description | | -------------- | --------------- | ------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `width` | `number` | 450 | The width of the widget in css values (px). If the width is not set, the display style for the width will be: 450px when the screen width > 767px. 100% when the screen width < 768px. 375px when the screen width < 375px. | | `theme` | `THEME` | light | The swap widget provides a default light theme and a dark theme as options. You can change the theme of the widget by following the example below. | | `lang` | `string` | en_us | The widget language is adjustable. Check the Multilanguage section for more details. | | `tradeType` | `TradeType` | auto | The type of transaction. It can be “swap”, “bridge”, or “auto”.Note: “Auto” includes “swap” and “bridge”. | | `chainIds` | `Array` | [] | The ID of the blockchain on which the single-chain swap will take place. Check the ChainId config section for all the networks that you can choose from. | | `tokenPair` | `ITokenPair` | {} | The default token pair you have set for Swap, can be found in the default tokenPair configuration section for more details. | | `bridgeTokenPair` | `ITokenPair` | {} | The default token pair you have set for Bridge, can be found in the default tokenPair configuration section for more details. | | `providerType` | `ProviderType` | ' ' | ProviderType represents the type of the provider and corresponds to it one-to-one. For example, if the provider is Solana, then the providerType would be SOLANA. | | `defaultTab` | `TradeTab ` | 'swap' | Default open mode can be set to single-chain or cross-chain. Supported from version 1.3.16 and above. | | `walletName` | `string` | ' ' | Name of the connected wallet. This parameter helps the DEX widget continuously improve its products and services to provide a better user experience. Supported from version 1.3.16 and above. | ## Type Description ```typeScript interface ITokenPair { fromChain: string | number; toChain: string | number; fromToken?: string; toToken?: string; } enum ProviderType { EVM = 'EVM', SOLANA = 'SOLANA', WALLET_CONNECT = 'WALLET_CONNECT', } enum TradeType { SWAP = 'swap', BRIDGE = 'bridge', AUTO = 'auto', } enum THEME { LIGHT = 'light', DARK = 'dark', } ``` ## Multilanguage | lang | Description | | -------- | ----------------------- | | `en_us` | English，Default | | `zh_cn` | 简体中文 | | `zh_tw` | 繁體中文 | | `fr_fr` | Français (Afrique) | | `id_id` | Bahasa Indonesia | | `ru_ru` | Русский | | `tr_tr` | Türkçe | | `vi_vn` | Tiếng Việt | | `de_de` | Deutsch | | `it_it` | Italiano | | `pl_pl` | Polski | | `pt_pt` | Português (Portugal) | | `es_es` | Español (España) | | `pt_br` | Português (Brasil) | | `es_419` | Español (Latinoamérica) | | `cs_cz` | Čeština | | `ro_ro` | Română | | `uk_ua` | Українська | | `ar_eh` | العربية | | `nl_nl` | Nederlands | ## ChainId Config | Network | ChainId | Native token contract | | ----------- | ------- | ------------------------------------------ | | Ethereum | 1 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | zkSync Era | 324 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Optimism | 10 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Polygon | 137 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Avalanche C | 43114 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Arbitrum | 42161 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Linea | 59144 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Base | 8453 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Mantle | 5000 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Scroll | 534352 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | X Layer | 196 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Blast | 81457 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | BNB Chain | 56 | 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE | | Solana | 501 | 11111111111111111111111111111111 | ## Default tokenPair Config

`tokenPair`: If tokenPair not configured, the default network for single-chain swaps is set to Ethereum, with ETH as `fromToken` and USDC as `toToken`.

`bridgeTokenPair`: If bridgeTokenPair not configured, the default bridge transaction is set to one from Ethereum to BNB Chain, with ETH as `fromToken` and BNB as `toToken`.

```javaScript import React, { useEffect, useRef } from 'react'; import { OkxSwapWidgetParams, ProviderType, TradeType, } from '@okxweb3/dex-widget'; const provider = window.ethereum; export function EvmWidget() { const widgetRef = useRef(); const params = { chainIds: ['1', '10'], lang: 'zh_cn', providerType: ProviderType.EVM, theme: 'dark', tradeType: TradeType.AUTO, tokenPair: { fromChain: 1, //ETH toChain: 1, // ETH fromToken: '0xdac17f958d2ee523a2206206994597c13d831ec7', // USDT toToken: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE', // ETH }, bridgeTokenPair: { fromChain: 1, //ETH toChain: 56, // BNB fromToken: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE', // ETH toToken: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE', // BNB }, }; const initialConfig = { params, provider, listeners: [ { event: 'ON_CONNECT_WALLET', handler: (token, preToken) => { provider.enable(); }, }, ], }; useEffect(() => { const widgetHandler = createOkxSwapWidget(widgetRef.current, initialConfig); return () => { widgetHandler?.destroy(); }; }, []); return

; } ``` | Parameter | Type | Description | | --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | fromChain | String | The ID of the source network that the fromToken belongs to (e.g., 1: Ethereum. Check ChainId config for a full list of the supported networks and the corresponding chain IDs). | | fromToken | String | The contract address of the token to be sold. E.g., ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE. If the fromToken is a blockchain’s native token, check the chain ID to get the contract address. | | toChain | String | The ID of the destination network that the toToken belongs to (e.g., 1: Ethereum. Check ChainId config for a full list of the supported networks and the corresponding chain IDs). | | toToken | String | "The contract address of a token to be bought. E.g., USDC: 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48. If the toToken is a blockchain’s native token, check the chain ID to get the contract address." | ### updateProvider

The widget supports EVM and Solana. When switching from EVM to Solana, remember to update the corresponding widget’s provider, and vice versa.
If you don’t pass in provider information for the first rendering and want the widget to respond to a wallet connection, you need to call updateProvider. Updating the provider can also include the `walletName` parameter to identify the plugin wallet connected by the user.

```javaScript // 3. Update the provider if the user connects a different wallet, EVM => SOLANA const walletName = 'phantom'; widgetHandler.updateProvider(window.solana, ProviderType.SOLANA, walletName); // SOLANA => EVM // widgetHandler.updateProvider(window.ethereum, ProviderType.EVM); ``` ### updateListeners

You can update the events that the widget listens to.

```javaScript // 4. Modify event listeners to handle new types of events widgetHandler.updateListeners([ { event: OkxEvents.ON_FROM_CHAIN_CHANGE, handler: (payload) => { // }, }, ]); ``` - Listeners mainly listen to the interfaces exposed externally by the widget, enabling customized processing through various events. The updateListeners function is used to modify custom processing after switching chains. - By adding event listeners, you can capture and handle data passed out from the iframe. This data usually represents events or state changes happening within the iframe and is passed to the external page through events. - The received data can be processed and manipulated flexibly according to your needs. This allows you to implement different logic or update UI elements based on the type or content of the data passed. - With the updateListeners method, you can add handlers for different types of events, such as OkxEvents.ON_TOKEN_CHANGE. When the event is triggered, the handler will receive the relevant payload data for further processing. ### destroy

Call this method when removing the widget module.

```javascript const widgetHandler = createOkxSwapWidget(container, initialConfig); widgetHandler.destory(); ``` #### Note： - Whenever you refresh or update, make sure to call the destroy method to remove previously connected events in order to prevent duplicate requests. ## Event Listeners

Widget provides event listeners for ON_CONNECT_WALLET and ON_FROM_CHAIN_CHANGE.

- `ON_CONNECT_WALLET`: This event is triggered when the widget is not connected to a wallet and the connect wallet button is clicked. - `ON_FROM_CHAIN_CHANGE`: This event is triggered when fromChain changes. - `ON_SUBMIT_TX`: This event is triggered after the transaction is completed and returns the `txHash` and `chainId`. Supported from version 1.3.16 and above.

Here’s how to use them:

```typeScript import {createOkxSwapWidget, OkxSwapWidgetParams, OkxEventListeners, OkxEvents} from '@okxweb3/dex-widget' const params: OkxSwapWidgetParams = { // ... } const listeners: OkxEventListeners = [ { event: OkxEvents.ON_CONNECT_WALLET, handler: () => { // open connect wallet method, eg openConnectModal of the rainbow kit. window.ethereum.enable() } }, { event: OkxEvents.ON_FROM_CHAIN_CHANGE, handler: (token) => { // } }, { event: OkxEvents.ON_SUBMIT_TX, handler: (res) => { console.log(`Transaction submitted successfully, txHash: ${res.data.txHash}`); } }, ] const { updateListeners } = createOkxSwapWidget(container, { params, listeners, provider }) ``` - [Trade API Fee](https://web3pre.okex.org/onchainos/dev-docs/trade/api-fee.md) # Trade API Fee Our API provides integration partners with various API tiers and flexible methodology to add fees to each transaction, designed to support various stages of development and commercialization. As our integration partner, you can access the API with a few different tiers to meet your specific needs. With the DEX API module, you can earn revenue by setting your own partner fee scheme to charge your users per swap. In detail, integration partners can configure partner fee and fee-receiving address for each token swap. You can charge your users up to 3% per swap for most supported chains; while for Solana, you can charge up to 10% per swap. All tiers of the API are subject to the [User agreement](https://web3.okx.com/help/okx-web3-build-user-agreement). ## Trial API Tier Our API offers a Trial tier that includes access to selected API functions. To start using the trial plan, you need to create an account on the [Developer Portal](./developer-portal) and verify your email and phone number. This plan provides a default rate limit of 1 request per second (RPS) and can be increased to 5 RPS upon review and approval. The trial tier is valid for 60 days upon the API key creation. For the trial tier, when the DEX API module secures a better price than quoted infrequently, the additional value named positive slippage is kept as our infrastructure fee. The positive slippage is capped at 10% of the trade amount. ## Start-up API Tier To continue using the API after the 60-day trial period, you can upgrade your developer account to the Start-up tier on the [Developer Portal](./developer-portal). Once upgraded to the Start-up tier, you immediately have access to additional product features, much higher RPS, standard technical and growth support. For start-up tier partners charging partner fee in token swaps, a standard revenue-sharing agreement is entered to retain 20% of your revenue as our infrastructure fee. In such cases, the positive slippage (if happened) is returned to your users by default; however, you can apply to have access to the feature to keep a portion of the positive slippage as your revenue. If you do not configure partner fees in token swaps to make revenue, we will keep the positive slippage (if happened) as our infrastructure fee, capped at 10% of the trade value. ## Enterprise API Tier For high-volume partners who need a much higher RPS, customized fee structure, dedicated technical and growth support, access to additional product features or customized features, you can upgrade to the Enterprise tier by contacting our BD team and signing a contract with us. Furthermore, Enterprise partners have access to the feature to keep the positive slippage as your revenue or provide the positive slippage entirely to your users. ## API Tiers Summary | | Trial Tier | Start-up Tier | Enterprise Tier | |--------------------- |-------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | API fee | Positive slippage only | 20% rev-share, or positive slippage if no partner fee is configured | Customized fee structure | | Features & Benefits | • RPS 1-5
• Access to standard API endpoints
• Valid for 60 days
| • RPS 2-50
• Access to most advanced API endpoints
• Access to positive slippage feature to retain as extra revenue (upon approval)
• Receive standard tech and growth support
| • Customised RPS
• Access to all advanced API endpoints, including positive slippage feature to retain as extra revenue
• Request customized feature development (upon approval)
• Receive dedicated tech and growth support
| *RPS adjustment is correlated to trading volume
*Positive slippage refers to a situation where a trade is executed at a more favorable price than initially quoted, which is relatively rare. For selected API tiers, the additional value generated by positive slippage will be retained as an API fee, capped at no more than 10% of the total traded amount.
*Start-up customers with monthly trading volume exceeding $10M need to contact our BD to upgrade to Enterprise tier for customized support
## Need Help? If you need to increase your rate limit, upgrade to the Start-up tier or Enterprise tier, or have product-related queries, please join our [discord](https://discord.com/invite/okxdexapi), or contact our BD team directly at dexapi@okx.com - [Smart Contract Safety](https://web3pre.okex.org/onchainos/dev-docs/trade/smart-contract-safety.md) # Smart Contract Safety ## Bug Bounty Program Security is our paramount priority. To learn about the security programs at OKX Web3, please visit our [website](https://web3.okx.com/security). We also have bug bounty programs to reward ethical hackers and our community to report bugs or security vulnerabilities to our product.
Submit a bug report: https://hackerone.com/okg ## Open Source Smart Contract We have open-sourced our smart contract codes on github, inviting community oversight. - Solana Chain Contract Repository https://github.com/okxlabs/DEX-Router-Solana-V1 - EVM Chain Contract Repository https://github.com/okxlabs/DEX-Router-EVM-V1 ## Join Community Discussions Join our [Discord community](https://discord.gg/okxdexapi) to share your experience with our DEX router and help other developers troubleshoot their integration issues. Our [Discord](https://discord.gg/okxdexapi) is the main hub for announcements, community interactions, technical discussion and 24/7 technical support. - [Support](https://web3pre.okex.org/onchainos/dev-docs/trade/support.md) # Support If you have any questions or feedback regarding the Trade API, please feel free to contact us through the following support channels. ## Technical Support - Technical inquiries: [Discord Developer Community](https://discord.gg/mUqMWaFGyW). - Developers are encouraged to join the real-time technical discussion channel. ## Business Support - Business cooperation: dexapi@okx.com - For enterprise service requests, please include your company name and contact information. - [Market API](https://web3pre.okex.org/onchainos/dev-docs/market/market-api-introduction.md) # Market API Our Market API is a suite of high-performance Restful JSON endpoints and real-time websocket channels to provide comprehensive multi-market and onchain data for cryptocurrency tokens, trades, transactions, accounts and more, pulling information from hundreds of decentralized exchanges (DEX) and centralized exchanges (CEX) across different blockchain ecosystems. Developers can utilize the Market API and the Trade API to build complete DEX experience with insightful market and portfolio dashboards, allowing users to monitor token performance across different exchange types in real-time, analyze portfolio changes and identify trading opportunities. - [Build with AI](https://web3pre.okex.org/onchainos/dev-docs/market/market-ai-tools-introduction.md) # Build with AI Onchain OS Market give agents and developers a unified data layer for real-time on-chain intelligence, token prices, trading activity, candlestick charts, token discovery, wallet balances, and transaction history , all from a single integration. Use it as the research and monitoring layer that runs alongside trade execution, or independently for portfolio dashboards and opportunity detection. ## Why Onchain OS Market for AI - **Dual-source price aggregation**. Market Price data is aggregated in real time from both on-chain DEX activity and centralized exchange feeds, giving a more complete picture of a token's true market price than any single-venue source. For agents that need a manipulation-resistant reference , stop-loss thresholds, risk parameters, multi-step trade validation, the Index Price API computes a stable composite price from multiple independent third-party sources (CEX, DEX, oracles), specifically designed to resist single-venue distortion. - **Token intelligence from discovery to depth**. The Token API is a full information stack: search by name, symbol, or contract address; retrieve basic metadata (decimals, contract); pull live trading metrics (24h volume, market cap, circulating supply, holders, liquidity); surface trending tokens by price change, volume, or market cap; and inspect the top 20 holder addresses for concentration analysis. An Agent can go from a user's natural language question ("what's trending on Ethereum today?") to a structured, actionable answer without leaving the tool. - **Complete portfolio visibility in one call**. The Balance API queries token balances and total USD portfolio value across all supported chains simultaneously , no need to iterate per chain. This is designed for agents that manage multi-chain portfolios or need to verify sufficient balance before executing a swap. - **Candlestick history for analysis and backtesting**. The Market Price API provides OHLCV data from minute-level to daily candles, with a historical endpoint that extends the lookback window for trend analysis, pattern detection, and strategy backtesting. - **Agent-optimized interface Skill and MCP Server**. OKX Market provides two integration paths depending on how your Agent is deployed. The Skill teaches your Agent how to call the OKX Web3 Market API through structured instructions and code generation. The MCP Server exposes the same capabilities as directly callable tools via the Model Context Protocol. ## Quickstart ### Skills Add the Skill files to the Agent’s `skill` directory. The Agent will automatically load the intent router, chain-specific execution playbooks, signing modes, and error-handling logic. ```shell npx skills add okx/onchainos-skills ``` For more details, please refer to the [GitHub repository](https://github.com/okx/onchainos-skills). ### MCP server For Claude Desktop, Cursor, and other MCP-compatible clients, add the following configuration: #### for General Claude code ```shell claude mcp add onchainos-mcp https://web3.okx.com/api/v1/onchainos-mcp -t http -H"OK-ACCESS-KEY: d573a84c-******************e9ad2478d" ``` #### for Claude Desktop Installation 1. Go to the `Settings` page and locate the `Connector` menu. 2. Scroll to the bottom, find `Add custom connector`, and enter the URL: https://web3.okx.com/api/v1/onchainos-mcp You can also try a local installation. For detailed instructions, please consult your Claude client. #### for Claude code MCP settings ```shell claude mcp add-json onchainos-mcp '{ "type": "http", "url": "https://web3.okx.com/api/v1/onchainos-mcp", "headers": { "OK-ACCESS-KEY": "d573a84c-******************e9ad2478d" } }' ``` One MCP server covers both Market and Trade capabilities. Restart your client after updating the config. - [Skills](https://web3pre.okex.org/onchainos/dev-docs/market/market-ai-tools-skills.md) # Skills Beyond simply "retrieving documentation," Skills encapsulate domain knowledge and engineering workflows into stable capabilities. They enable the Agent not only to answer "how to write the docs," but also to handle "which endpoint to choose, what the next step is, and how to deal with errors." ## Why Onchain OS Market Skills for AI - Covers the full Market data lifecycle , price lookup, token discovery, candlestick retrieval, balance queries, and trade history. - Provides an Intent Router: maps user questions ("what's ETH's price?", "who holds the most USDT?", "show me SOL's 4h chart") to the correct API family and the appropriate first action. - Plug-and-play for AI agents: Structured capability modules that directly encapsulate the OKX DEX API for AI Agents. Each Skill corresponds to a specific capability (e.g., filtering trending tokens by price change, trading volume, or market cap; retrieving real-time trading metrics; analyzing address concentration) and defines clear input/output schemas, enabling seamless integration into any Agent architecture. ## Quickstart ```shell npx skills add okx/onchainos-skills ``` For more details, please refer to the [GitHub repository](https://github.com/okx/onchainos-skills). ## Example interactions Once the Skills is uploaded to agents, an Agent can respond to natural-language queries like: ```shell What is the current price of OKB? # Call index-current-price ``` ```shell Show me OKB’s 4-hour candlesticks for the past week. # Call market-candlesticks ``` ```shell What is the hottest token on the X-layer chain right now? # Call market-token-ranking ``` ```shell Which address holds the most USDT on X-layer? # Call market-token-holder ``` ```shell What is the total asset value of wallet 0xd8dA...? # Call balance-total-value ``` - [MCP Server](https://web3pre.okex.org/onchainos/dev-docs/market/market-ai-tools-mcp-server.md) # MCP Server MCP (Model Context Protocol) connects AI tools with developer resources. After adding the OKX DEX MCP Server, the Agent can query live token prices, retrieve candlestick charts, search for tokens, inspect holder distributions, and check wallet balances all through standardized, directly callable tool interfaces, within a single conversation or editor session, without any additional integration code. For Claude Desktop, Cursor, and other MCP-compatible clients, add the following configuration: One MCP server covers both Market and Trade capabilities. Restart your client after updating the config. ## What the MCP Server exposes - **Price Tools:** `dex-okx-index-current-price`, `dex-okx-index-historical-price`, `dex-okx-market-price`, `dex-okx-market-price-chains` — real-time and historical index/DEX prices across 20+ chains. - **Candlestick Tools:** `dex-okx-market-candlesticks`, `dex-okx-market-candlesticks-history` — OHLCV data from 1-minute to daily intervals, with support for extended lookback windows. - **Token Intelligence Tools:** `dex-okx-market-token-search`, `dex-okx-market-token-price-info`, `dex-okx-market-token-ranking`, `dex-okx-market-token-holder` — token discovery, metadata, real-time metrics, and holder concentration analysis. - **Trade Data Tool:** `dex-okx-market-trades` — latest on-chain trade records for any token. - **Balance Tools:** `dex-okx-balance-chains`, `dex-okx-balance-total-token-balances`, `dex-okx-balance-specific-token-balance`, `dex-okx-balance-total-value` — multi-chain wallet balances and USD portfolio valuation. ## Quickstart ### Setup #### for General Claude code ```shell claude mcp add onchainos-mcp https://web3.okx.com/api/v1/onchainos-mcp -t http -H"OK-ACCESS-KEY: Visit [https://web3.okx.com/zh-hans/onchainos/dev-portal/project](https://web3.okx.com/zh-hans/onchainos/dev-portal/project) to register and obtain your API key." ``` #### for Claude Desktop Installation 1. Go to the `Settings` page and locate the `Connector` menu. 2. Scroll to the bottom, find `Add custom connector`, and enter the URL: https://web3.okx.com/api/v1/onchainos-mcp You can also try a local installation. For detailed instructions, please consult your Claude client. #### for Claude code MCP setting ```shell claude mcp add-json onchainos-mcp '{ "type": "http", "url": "https://web3.okx.com/api/v1/onchainos-mcp", "headers": { "OK-ACCESS-KEY": "Visit [https://web3.okx.com/zh-hans/onchainos/dev-portal/project](https://web3.okx.com/zh-hans/onchainos/dev-portal/project) to register and obtain your API key." } }' ``` ## Example interactions Once the MCP Server is active, an Agent can respond to natural-language queries like: ```shell What is the current price of OKB? # Call index-current-price ``` ```shell Show me OKB’s 4-hour candlesticks for the past week. # Call market-candlesticks ``` ```shell What is the hottest token on the X-layer chain right now? # Call market-token-ranking ``` ```shell Which address holds the most USDT on X-layer? # Call market-token-holder ``` ```shell What is the total asset value of wallet 0xd8dA...? # Call balance-total-value ``` - [llms.txt](https://web3pre.okex.org/onchainos/dev-docs/market/market-ai-tools-llm.md) # llms.txt ## Onchain OS Market llms.txt Structure `llms.txt` is a proposed standard designed to help AI language models efficiently understand and navigate documentation or websites. It enables Agents to quickly grasp the structure of documentation and locate relevant pages. Based on minimal context, it can precisely identify the appropriate module within shorter response times, reduce hallucinations, and lower token consumption—serving as a low-cost navigation layer. A typical `llms.txt` file includes: - Site title (H1) - Sections organized by module (H2) - A link to each page + a one-sentence description (used for routing and retrieval) In addition to `llms.txt`, we also provide `llms-full.txt`. Unlike a directory-style index, it aggregates the full site documentation in Markdown format (including more granular descriptions and examples) for deeper indexing and search. Please visit [OnchainOS.llms.txt](https://web3.okx.com/llms.txt) to view the detailed structure of `llms.txt`. ## Onchain OS Market llms-full.txt Structure Suitable for: - AI tools that require full-context access (deep indexing / advanced search / offline knowledge base construction) - Developers who want a comprehensive view of all pages and resources at once - Building custom AI workflows (e.g., full indexing first, then chunk-based retrieval as needed) Please visit [OnchainOS.llms-full.txt](https://web3.okx.com/llms-full.txt) to view the detailed structure of `llms-full.txt`. - [Market API Fee ](https://web3pre.okex.org/onchainos/dev-docs/market/market-api-fee.md) # Market API Fee ## Overview Market API offers a flexible, tiered fee structure designed for developers and integration partners at every stage — from prototyping to production. - All API-Key holders receive a monthly free quota. - All Market API requests within the monthly free quota are free of charge. - Once your quota is exhausted, you will need to make a payment to continue using the service. You can choose from the following payment models: 1. x402 pay-per-call 2. Subscription-based billing Both of the payment models described above **support payment only with USDG or USDT on the X Layer network**. All tiers are subject to the [User Agreement](https://web3.okx.com/zh-hans/help/okx-web3-build-user-agreement). ## For x402 pay-per-call billing You can choose the **pay-per-call** model for individual API requests. Under this model, you pay only for the API calls you actually make, but each request requires a payment signature. Among the many Market API capabilities, we continue to offer a selection of **free APIs**. Paid APIs are categorized into **Basic** and **Premium** tiers, each with its own per-call pricing. Please refer to the table below for details. **Free API** Totally free to use. | Category | Endpoint | Tier | |-------------- |:----------------------------------------------------: |:----: | | Market | /api/v6/dex/market/supported/chain | Free | | Signal | /api/v6/dex/market/signal/supported/chain | Free | | MemePump | /api/v6/dex/market/memepump/supported/chainsProtocol | Free | | Portfolio | /api/v6/dex/market/portfolio/supported/chain | Free | | BubbleMap | /api/v6/dex/market/token/cluster/supported/chain | Free | | Leaderboard | /api/v6/dex/market/leaderboard/supported/chain | Free | | Index price | /api/v6/dex/balance/supported/chain | Free | | Index price | /api/v6/dex/index/current-price | Free | | Index price | /api/v6/dex/index/historical-price | Free | | Balance | /api/v6/dex/balance/supported/chain | Free | | Balance | /api/v6/dex/balance/total-value-by-address | Free | | Balance | /api/v6/dex/balance/all-token-balances-by-address | Free | | Balance | /api/v6/dex/balance/token-balances-by-address | Free | | History | /api/v6/dex/balance/supported/chain | Free | | History | /api/v6/dex/post-transaction/transactions-by-address | Free | | History | /api/v6/dex/post-transaction/transaction-detail-by-txhash | Free | | Onchaindata | /api/v6/explorer/address/supported-chains | Free | | Onchaindata | /api/v6/explorer/transaction/supported-chains | Free | | Onchaindata | /api/v6/explorer/block/supported-chains | Free | | Onchaindata | /api/v6/explorer/info/supported-chains | Free | | Onchaindata | /api/v6/explorer/log/supported-chains | Free | **Basic API** The Basic API, ideal for low-frequency market data queries, basic market data and lightweight Agent applications.Includes 100,000 free API calls per month. After the free quota is exhausted, each additional API call is charged at $0.0001 per request. | Category | Endpoint | Tier | |:----------: |:---------------------------------------------: |:-----: | | Market | /api/v6/dex/market/price | Basic | | Market | /api/v6/dex/market/trades | Basic | | Market | /api/v6/dex/market/token/top-liquidity | Basic | | Market | /api/v6/dex/market/token/hot-token | Basic | | Market | /api/v6/dex/market/candles | Basic | | Market | /api/v6/dex/market/token/search | Basic | | Market | /api/v6/dex/market/token/basic-info | Basic | | Portfolio | /api/v6/dex/market/portfolio/token/latest-pnl | Basic | | Portfolio | /api/v6/dex/market//portfolio/dex-history | Basic | | MemePump | /api/v6/dex/market/memepump/similarToken | Basic | | OnchainData |/api/v6/explorer/address/address-active-chain| Basic | | OnchainData |/api/v6/explorer/address/information-evm| Basic | | OnchainData |/api/v6/explorer/block/block-list| Basic | | OnchainData |/api/v6/explorer/block/block-fills| Basic | | OnchainData |/api/v6/explorer/block/transaction-list| Basic | | OnchainData |/api/v6/explorer/block/block-height-by-time| Basic | | OnchainData |/api/v6/explorer/block/block-stats| Basic | | OnchainData |/api/v6/explorer/transaction/transaction-multi| Basic | | OnchainData |/api/v6/explorer/transaction/internal-transaction-multi| Basic | | OnchainData |/api/v6/explorer/transaction/token-transfer-multi| Basic | | OnchainData |/api/v6/explorer/transaction/normal-transaction-list-multi| Basic | | OnchainData |/api/v6/explorer/transaction/token-transaction-list-multi| Basic | | OnchainData |/api/v6/explorer/info/detail| Basic | | OnchainData |/api/v6/explorer/info/summary| Basic | | OnchainData |/api/v6/explorer/info/transaction| Basic | | OnchainData |/api/v6/explorer/info/block| Basic | | OnchainData |/api/v6/explorer/info/address| Basic | | OnchainData |/api/v6/explorer/info/stats| Basic | | OnchainData |/api/v6/explorer/info/hashes| Basic | | OnchainData |/api/v6/explorer/log/by-block-and-address| Basic | | OnchainData |/api/v6/explorer/log/by-address-and-topic| Basic | | OnchainData |/api/v6/explorer/log/by-address| Basic | | OnchainData |/api/v6/explorer/log/by-transaction| Basic | **Premium API** The Premium API provides features such as Smart Money tracking and token holding analysis, suitable for quantitative trading or market data platform scenarios.Includes 100,000 free API calls per month. After the free quota is exhausted, each additional API call is charged at $0.0002 per request. | Category | Endpoint | Tier | |:------------: |:--------------------------------------------: |:-------: | | Market | /api/v6/dex/market/token/advanced-info | Premium | | Market | /api/v6/dex/market/historical-candles | Premium | | Market | /api/v6/dex/market/token/holder | Premium | | Market | /api/v6/dex/market/price-info | Premium | | Portfolio | /api/v6/dex/market/portfolio/overview | Premium | | Portfolio | /api/v6/dex/market/portfolio/recent-pnl | Premium | | Portfolio | /api/v6/dex/market/token/top-trader | Premium | | Signal | /api/v6/dex/market/signal/list | Premium | | Leaderboard | /api/v6/dex/market/leaderboard/list | Premium | | MemePump | /api/v6/dex/market/memepump/tokenList | Premium | | MemePump | /api/v6/dex/market/memepump/tokenDetails | Premium | | MemePump | /api/v6/dex/market/memepump/tokenDevInfo | Premium | | MemePump | /api/v6/dex/market/memepump/tokenBundleInfo | Premium | | MemePump | /api/v6/dex/market/memepump/apedWallet | Premium | | BubbleMap | /api/v6/dex/market/token/cluster/overview | Premium | | BubbleMap | /api/v6/dex/market/token/cluster/list | Premium | | BubbleMap | /api/v6/dex/market/token/cluster/top-holders | Premium | | OnchainData | /api/v6/explorer/block/address-balance-history| Premium | ## For Subscription-based billing Subscription billing is designed for users who prefer a more stable and seamless payment experience. By prepaying for a subscription plan, you can cover your expected usage without having to manage or sign each individual API request. We offer several subscription tiers, each providing different levels of benefits and monthly quotas. Please refer to the table below for details. | Tier | Monthly Price | Basic Quota / Month | Premium Quota / Month | Supported Channels | |------|--------------:|--------------------:|-----------------------:|---------------------------------| | Free | $0 | 100K | 100K | WebSocket not supported| | Starter | $99 | 2M | 600K | All channels | | Growth | $199 | 5M | 2M | All channels | | Scale | $399 | 20M | 10M | All channels | | Pro | $599 | 50M | 20M | All channels | | Enterprise | Custom | Unlimited | Unlimited | Unlimited | *Subscriptions renew automatically by default. You can cancel at any time.
*Subscriptions renew automatically and quotas reset on the 1st of each month.
*For your first subscription or when upgrading your plan, you only pay the prorated price based on the remaining days in the current billing cycle instead of the full monthly fee. The full monthly fee will be charged automatically on the 1st of the following month.
## Charging Flow After reveiving 402 response，you can refer to [how to finish the API payment](./how-to-finish-api-payment) to complete payment. ## Need Help? For questions about tier upgrades, RPS adjustments, x402 payment integration, or any other product-related enquiries, please reach us via: - Join the [Discord community](https://discord.com/invite/mUqMWaFGyW) - Contact the BD team by email ：dexapi@okx.com - [How to Complete API Payment](https://web3pre.okex.org/onchainos/dev-docs/market/how-to-finish-api-payment.md) # How to Complete API Payment ## X402 Payment handling x402 is an on-chain micropayment protocol based on the HTTP 402 (Payment Required) status code. Users authorize transfers via EIP-3009 off-chain signatures — no need to hold OKB or submit on-chain transactions — to complete paid API calls. Flow Diagram ``` Client Server Chain | | | | 1. POST /api/xxx | | |------------------------------>| | | | | | 2. 402 + payment required | | |<------------------------------| | | | | | 3. EIP-3009 off-chain sign | | | via SDK (no gas needed) | | | or local script | | | | | | 4. POST /api/xxx | | | + PAYMENT-SIGNATURE | | |------------------------------>| | | | 5. Verify sig + deduct | | |----------------------------->| | | | | 6. 200 + response data | | |<------------------------------| | ``` ### Signing SDK (Automatic 402 Handling) Step 1: Install Node.js Make sure Node.js >= 18 is installed: ```bash node -v # should output v18.x.x or higher ``` If not installed, download from https://nodejs.org/. Step 2: Create Project and Install Dependencies ```bash mkdir x402-demo && cd x402-demo npm init -y npm install --save-dev @types/node npm install viem @okxweb3/x402-fetch @okxweb3/x402-evm dotenv ts-node typescript ``` Step 3: Configure Environment Variables Create a `.env` file in your project root: ``` EVM_PRIVATE_KEY=0xYOUR_PRIVATE_KEY_HERE OKX_ACCESS_KEY=YOUR_OKX_ACCESS_KEY OKX_SECRET_KEY=YOUR_OKX_SECRET_KEY OKX_PASSPHRASE=YOUR_OKX_PASSPHRASE ``` > ⚠️ Never hardcode secrets in your code. Add `.env` to `.gitignore`. Step 4: Ensure Your Wallet Holds Tokens on X Layer Your wallet must hold USDG or USDT on **X Layer (chainIndex: 196)**. - USDG contract address: `0x4ae46a509f6b1d9056937ba4500cb143933d2dc8` - USDT contract address: `0x779ded0c9e1022225f8e0630b35a9b54be713736` - You can withdraw USDT from the OKX exchange to the X Layer network to fund your wallet. Step 5: Receive x402 Payment Info and Sign via SDK When a paid Market API endpoint triggers x402, use the signing SDK to handle it automatically: **1. Create `tsconfig.json` in your project root:** ```json { "compilerOptions": { "module": "commonjs", "moduleResolution": "node", "esModuleInterop": true, "skipLibCheck": true, "ignoreDeprecations": "6.0" } } ``` **2. Save the following as `app.ts` and run `npx ts-node --transpileOnly app.ts`:** The SDK provides two methods, `policies` and `paymentRequirementsSelector`, to specify payment using USDT or USDG. If these methods are not used, the first token in the returned result will be used for payment by default. ```typescript import "dotenv/config"; import {createHmac} from "crypto"; import {wrapFetchWithPaymentFromConfig} from "@okxweb3/x402-fetch"; import {ExactEvmScheme, toClientEvmSigner} from "@okxweb3/x402-evm"; import {privateKeyToAccount} from "viem/accounts"; // OKX API signing function createOkxHeaders(method: string, path: string, body: string) { const timestamp = new Date().toISOString(); const sign = createHmac("sha256", process.env.OKX_SECRET_KEY!) .update(timestamp + method + path + body) .digest("base64"); return { "OK-ACCESS-KEY": process.env.OKX_ACCESS_KEY!, "OK-ACCESS-SIGN": sign, "OK-ACCESS-TIMESTAMP": timestamp, "OK-ACCESS-PASSPHRASE": process.env.OKX_PASSPHRASE!, }; } async function main() { // 1. Read private key and create wallet account const pk = process.env.EVM_PRIVATE_KEY; if (!pk) { console.error("Error: EVM_PRIVATE_KEY not found, please configure it in .env"); process.exit(1); } const privateKey = (pk.startsWith("0x") ? pk : `0x${pk}`) as `0x${string}`; const account = privateKeyToAccount(privateKey); const signer = toClientEvmSigner(account); console.log(`Wallet address: ${account.address}`); const USDG_XLAYER = "0x4ae46a509f6b1d9056937ba4500cb143933d2dc8"; const USDT_XLAYER = "0x779ded0c9e1022225f8e0630b35a9b54be713736"; // Currently supports paying with either USDG or USDT // 2. Wrap fetch with SDK to automatically handle 402 payments const fetchWithPayment = wrapFetchWithPaymentFromConfig(fetch, { schemes: [ { network: "eip155:196", // X Layer client: new ExactEvmScheme(signer), }, ], // Filter to keep only the specified token policies: [ (_v, reqs) => reqs.filter( (r) => r.network === "eip155:196" && // To switch payment token, just change the variable below r.asset.toLowerCase() === USDG_XLAYER.toLowerCase(), ), ], // Select one from multiple candidates (e.g., choose the lowest amount) paymentRequirementsSelector: (_v, reqs) => reqs.reduce((a, b) => (BigInt(a.amount) <= BigInt(b.amount) ? a : b)), }); // 3. Build request and call — automatically signs and retries on 402 const url = "https://web3.okx.com/api/v6/dex/market/price-info"; const body = JSON.stringify([ { chainIndex: 501, tokenContractAddress: "So11111111111111111111111111111111111111112", }, ]); const response = await fetchWithPayment(url, { method: "POST", headers: { "Content-Type": "application/json", ...createOkxHeaders("POST", new URL(url).pathname, body), }, body, }); // 4. Handle response const data = await response.json(); console.log("Response:", JSON.stringify(data, null, 2)); } main().catch((err) => { console.error("Failed:", err); process.exit(1); }); ``` **3. Sample Output** **Success** ``` Wallet address: 0x63294Ef9934d1482Ef5AeF57F225C28ae1B53cc5 Response: { "code": "0", "data": [ { "chainIndex": "501", "price": "133.71500000", "time": "1776761078382", "tokenContractAddress": "So11111111111111111111111111111111111111112" } ], "msg": "" } ``` **Failure** ```json { "x402Version": 2, "error": "invalid payment header", "resource": { "url": "https://web3.okx.com/api/v6/dex/market/token/search", "mimeType": "application/json" }, "accepts": [ { "scheme": "exact", "network": "eip155:196", "amount": "100", "payTo": "0x0dedc3c5e15bee45166924ea5b02f54a35b1f9c6", "maxTimeoutSeconds": 86400, "asset": "0x4ae46a509f6b1d9056937ba4500cb143933d2dc8", "extra": { "version": "1", "symbol": "USDG", "name": "Global Dollar", "transferMethod": "eip3009" } }, { "scheme": "exact", "network": "eip155:196", "amount": "100", "payTo": "0x0dedc3c5e15bee45166924ea5b02f54a35b1f9c6", "maxTimeoutSeconds": 86400, "asset": "0x779ded0c9e1022225f8e0630b35a9b54be713736", "extra": { "version": "1", "symbol": "USD₮0", "name": "USD₮0", "transferMethod": "eip3009" } } ] } ``` ### Manual Signing script Step 1: Install Node.js Make sure Node.js >= 18 is installed: ```bash node -v # should output v18.x.x or higher ``` If not installed, download from https://nodejs.org/. Step 2: Create Project and Install Dependencies ```bash mkdir x402-demo && cd x402-demo npm init -y npm install --save-dev @types/node npm install viem @okxweb3/x402-fetch @okxweb3/x402-evm dotenv ts-node typescript ``` Step 3: Configure Environment Variables Create a `.env` file in your project root: ``` EVM_PRIVATE_KEY=0xYOUR_PRIVATE_KEY_HERE OKX_ACCESS_KEY=YOUR_OKX_ACCESS_KEY OKX_SECRET_KEY=YOUR_OKX_SECRET_KEY OKX_PASSPHRASE=YOUR_OKX_PASSPHRASE ``` > ⚠️ Never hardcode secrets in your code. Add `.env` to `.gitignore`. Create `tsconfig.json`: ```json { "compilerOptions": { "target": "es2020", "module": "commonjs", "lib": ["es2020"], "types": ["node"], "moduleResolution": "node", "esModuleInterop": true, "skipLibCheck": true, "ignoreDeprecations": "6.0" } } ``` Step 4: Ensure Your Wallet Holds Tokens on X Layer Your wallet must hold USDT or USDG on **X Layer (chainIndex: 196)**. - USDG contract address: `0x4ae46a509f6b1d9056937ba4500cb143933d2dc8` - USDT contract address: `0x779ded0c9e1022225f8e0630b35a9b54be713736` You can use following method to fund your wallet： - Withdraw USDG/USDT from the OKX exchange to the X Layer network - Swap to USDG/USDT on-chain via OKX DEX - Bridge and swap to USDG/USDT on X Layer via OKX Bridge Swap Step 5: Receive x402 Payment Info and Sign When a paid Market API endpoint triggers x402, you will receive the following response: ```json { "x402Version": 2, "resource": { "url": "https://web3.okx.com/api/v6/dex/market/xxx", "mimeType": "application/json" }, "accepts": [ { "scheme": "exact", "network": "eip155:196", "amount": "500", "payTo": "0x0dedc3c5e15bee45166924ea5b02f54a35b1f9c6", "maxTimeoutSeconds": 86400, "asset": "0x4ae46a509f6b1d9056937ba4500cb143933d2dc8", "extra": { "version": "1", "transferMethod": "eip3009", "name": "Global Dollar", "symbol": "USDG" } }, { "scheme": "exact", "network": "eip155:196", "amount": "500", "payTo": "0x0dedc3c5e15bee45166924ea5b02f54a35b1f9c6", "maxTimeoutSeconds": 86400, "asset": "0x779ded0c9e1022225f8e0630b35a9b54be713736", "extra": { "version": "1", "transferMethod": "eip3009", "name": "USD₮0", "symbol": "USD₮0" } } ] } ``` Save the following code as `app.ts`, run `npx ts-node app.ts`, obtain the `PAYMENT-SIGNATURE`, include it in the request header, and retry the API call. ```typescript /** * EIP-3009 TransferWithAuthorization Signing Script * * EIP-3009 allows users to sign an "authorized transfer" off-chain. * After receiving the signature, the server can call the contract method * transferWithAuthorization() to complete the transfer, * so the user does not need to hold ETH or send an on-chain transaction. * * ── Private Key Configuration ──────────────────────────────────────────────── * * This script reads the payer's private key from the environment variable EVM_PRIVATE_KEY. * It supports the following methods: * * Method 1: .env file (recommended for development) * 1. Create a .env file in the same directory: * EVM_PRIVATE_KEY=0xYOUR_PRIVATE_KEY_HERE * 2. Add .env to .gitignore to avoid committing the private key * 3. Run: npx ts-node eip3009_sign_only.ts * * Method 2: Command-line environment variable (temporary use) * EVM_PRIVATE_KEY=0xYOUR_PRIVATE_KEY_HERE npx ts-node eip3009_sign_only.ts * * Method 3: System environment variable (persistent) * Add to ~/.zshrc or ~/.bashrc: * export EVM_PRIVATE_KEY=0xYOUR_PRIVATE_KEY_HERE * Then run source ~/.zshrc * * ⚠️ Security Notice: * - Never hardcode private keys in source code * - Never commit private keys to Git repositories * - Use KMS or HSM in production environments * * ── Dependencies ───────────────────────────────────────────────────────────── * * npm install viem */ import "dotenv/config"; import { privateKeyToAccount, signTypedData } from "viem/accounts"; import { randomBytes } from "crypto"; // ── Input Types ────────────────────────────────────────────────────────────── interface SignParams { privateKey: string; network: string; amount: string; payTo: string; asset: string; maxTimeoutSecs?: number; domainName: string; domainVersion: string; } // ── Output Types ───────────────────────────────────────────────────────────── interface SignResult { signature: string; authorization: { from: string; to: string; value: string; validAfter: string; validBefore: string; nonce: string; }; } // ── EIP-712 Types ──────────────────────────────────────────────────────────── const TRANSFER_WITH_AUTHORIZATION_TYPE = { TransferWithAuthorization: [ { name: "from", type: "address" }, { name: "to", type: "address" }, { name: "value", type: "uint256" }, { name: "validAfter", type: "uint256" }, { name: "validBefore", type: "uint256" }, { name: "nonce", type: "bytes32" }, ], } as const; // ── Utility ────────────────────────────────────────────────────────────────── function parseChainIndex(network: string): number { const match = network.match(/^eip155:(\d+)$/); if (!match) { throw new Error(`Invalid network format: "${network}", expected "eip155:"`); } return parseInt(match[1], 10); } // ── Core Signing ───────────────────────────────────────────────────────────── export async function eip3009Sign(params: SignParams): Promise { const { privateKey, network, amount, payTo, asset, maxTimeoutSecs = 300, domainName, domainVersion, } = params; const pk = (privateKey.startsWith("0x") ? privateKey : `0x${privateKey}`) as `0x${string}`; const account = privateKeyToAccount(pk); const from = account.address; const chainIndex = parseChainIndex(network); const validBefore = BigInt(Math.floor(Date.now() / 1000) + maxTimeoutSecs); const nonce = `0x${randomBytes(32).toString("hex")}` as `0x${string}`; const signature = await signTypedData({ privateKey: pk, domain: { name: domainName, version: domainVersion, chainIndex, verifyingContract: asset as `0x${string}`, }, types: TRANSFER_WITH_AUTHORIZATION_TYPE, primaryType: "TransferWithAuthorization", message: { from, to: payTo as `0x${string}`, value: BigInt(amount), validAfter: 0n, validBefore, nonce, }, }); return { signature, authorization: { from, to: payTo, value: amount, validAfter: "0", validBefore: validBefore.toString(), nonce, }, }; } ``` Sample Output **Success** ``` Wallet address: 0x63294Ef9934d1482Ef5AeF57F225C28ae1B53cc5 Response: { "code": "0", "data": [ { "chainIndex": "501", "price": "133.71500000", "time": "1776761078382", "tokenContractAddress": "So11111111111111111111111111111111111111112" } ], "msg": "" } ``` **Failure** ``` { "x402Version": 2, "error": "invalid signature, nonce_used", "resource": { "url": "https://web3.okx.com/api/v6/dex/market/price-info", "mimeType": "application/json" }, "accepts": [ { "scheme": "exact", "network": "eip155:196", "amount": "500", "payTo": "0x0dedc3c5e15bee45166924ea5b02f54a35b1f9c6", "maxTimeoutSeconds": 86400, "asset": "0x4ae46a509f6b1d9056937ba4500cb143933d2dc8", "extra": { "transferMethod": "eip3009", "name": "Global Dollar", "symbol": "USDG", "version": "1" } }, { "scheme": "exact", "network": "eip155:196", "amount": "500", "payTo": "0x0dedc3c5e15bee45166924ea5b02f54a35b1f9c6", "maxTimeoutSeconds": 86400, "asset": "0x779ded0c9e1022225f8e0630b35a9b54be713736", "extra": { "transferMethod": "eip3009", "name": "USD₮0", "symbol": "USD₮0", "version": "1" } } ] } ``` ## Subscribe Through the Developer Portal We also support subscription-based billing. You can complete your subscription payment directly in the Developer Portal by signing with your wallet. **Step 1:** Make sure your wallet holds **USDG or USDT** on the X Layer network **Step 2:** Open the subscription plan selection dialog ![image](../images/01-entry.png) **Step 3:** Select your desired plan and complete the payment by signing with your wallet ![image](../images/02-landing page.jpeg) - [Payment error handling](https://web3pre.okex.org/onchainos/dev-docs/market/payment-error-handling.md) # Payment error handling | Error Message | Meaning | Troubleshooting Action | |------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | Empty / null response | Request did not include PAYMENT-SIGNATURE or X-PAYMENT header | Include PAYMENT-SIGNATURE or X-PAYMENT in the request after signing | | invalid payment header | PAYMENT-SIGNATURE content is invalid | Check for truncation / encoding issues / multiple base64 nesting | | param_mismatch | Missing required fields or invalid parameters (address / nonce format) | Verify that parameters in the signature match the expected values | | toAddr mismatch | PayTo address does not match or is zero address | Ensure the address matches exactly and is not 0x0000… | | amount mismatch | Signed amount does not match returned amount | Ensure value in EIP-3009 signature equals the returned amount | | unsupported_chain | Parsed chainIndex from network is not supported | Currently only X Layer (eip155:196) is supported | | payer_blocked | authorization.from triggered risk control rules | Contact OKX support / risk team | | risk_address | payer or payTo is flagged (blacklist / sanctioned address) | Use a different address | | resource mismatch | Signed URL does not match request URL | Use the exact request URL when signing; do not reuse payload | | no matching payment option | Payment token does not match required token | Sign using the token specified in the response | | invalid_signature | Invalid signature format (length, r/s range, v value, etc.) | Use OKXEvmSigner; avoid manual EIP-712 construction | | not_yet_valid | validAfter > now | Check system time | | expired | `validBefore <= now` | Check system time | | invalid signature, nonce_used | Nonce already used on-chain | Generate a new 32-byte nonce and sign again | | insufficient_balance | Insufficient balance | Fund the account or reduce concurrent payments | | onchain_error | On-chain RPC / multicall failure | Retry the request | | payment processing | Duplicate request within cache window | Avoid reusing the same signature within cache period | - [API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/market-price-reference.md) # API Reference - [Get supported chains](https://web3pre.okex.org/onchainos/dev-docs/market/market-price-chains.md) {/* api-page */} # Get supported chains Retrieve information on chains supported by Market Price API. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/supported/chain` ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | chainIndex | String | No | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | chainIndex | String | Unique identifier for the chain | | chainName | String | Chain name (e.g.,`Optimism`) | | chainLogoUrl | String | Chain icon | | chainSymbol | String | Chain symbol (e.g., ETH). | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/supported/chain?chainIndex=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code":"0", "data":[ { "chainIndex":"1", "chainName":"Ethereum", "chainSymbol":"ETH" }, ], "msg":"" } ``` - [Get Price](https://web3pre.okex.org/onchainos/dev-docs/market/market-price.md) {/* api-page */} # Get Price Retrieve the latest price of a token. ## Request URL POST `https://web3.okx.com/api/v6/dex/market/price` ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382b...5c50) | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | chainIndex | String| Unique identifier for the chain | | tokenContractAddress | String | Token contract address | | time | String | Timestamp of the price, Unix timestamp format in milliseconds | | price | String | Latest token price | ## Request Example ```shell curl --location --request POST 'https://web3.okx.com/api/v6/dex/market/price' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \ --data-raw '[ { "chainIndex": "66", "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" } ]' ``` ## Response Example ```json { "code":"0", "data":[ { "chainIndex": "1", "tokenContractAddress": "0x382bb369d343125bfb2117af9c149795c6c65c50", "time": "1716892020000", "price": "26.458143090226812" } ], "msg":"" } ``` - [Get Candlesticks](https://web3pre.okex.org/onchainos/dev-docs/market/market-candlesticks.md) {/* api-page */} # Get Candlesticks Retrieve the candlestick charts. This endpoint can retrieve the latest 1,440 data entries. Charts are returned in groups based on the requested bar. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/candles` ## Request Parameters | Parameter | Type | Required | Description | | -------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | chainIndex | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382b...5c50) | | after | String | No | Pagination of data to return records earlier than the requested ts. | | before | String | No | Pagination of data to return records newer than the requested ts. The latest data will be returned when using before individually | | bar | String | No | Bar size, the default is 1m
e.g. [1s/1m/3m/5m/15m/30m/1H/2H/4H]
Hong Kong time opening price k-line：[6H/12H/1D/1W/1M/3M]
UTC time opening price k-line：[/6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc] | | limit | String | No | Number of results per request. The maximum is 299. The default is 100. | ## Response Parameters | Parameter | Type | Description | | --------- | ------ | ---------------------------------------------------------------------------------------------------- | | ts | String | Opening time of the candlestick, Unix timestamp format in milliseconds, e.g. 1597026383085 | | o | String | Open price | | h | String | Highest price | | l | String | Lowest price | | c | String | Close price | | vol | String | Trading volume, with a unit of base currency. | | volUsd | String | Trading volume, with a unit of usd. | | confirm | String | The state of candlesticks.
`0` represents that it is uncompleted, `1` represents that it is completed. | The first candlestick data may be incomplete, and should not be polled repeatedly. The data returned will be arranged in an array like this: [ts,o,h,l,c,vol,volUsd,confirm]. Use the closing price of the last candle as the opening price of the following candle. ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/candles?chainIndex=66&tokenContractAddress=0x382bb369d343125bfb2117af9c149795c6c65c50' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ [ "1597026383085", "3.721", "3.743", "3.677", "3.708", "22698348.04828491", "226348.0482", "0" ], [ "1597026383085", "3.731", "3.799", "3.494", "3.72", "67632347.24399722", "6767.2439", "1" ] ], "msg": "" } ``` - [Get Candlesticks History](https://web3pre.okex.org/onchainos/dev-docs/market/market-candlesticks-history.md) {/* api-page */} # Get Candlesticks History Retrieve historical candlestick charts. Historical candlestick data does not include unfinished candlesticks ## Request URL GET `https://web3.okx.com/api/v6/dex/market/historical-candles` ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | tokenContractAddress | String | Yes | Token contract address ,for EVM please pass all-lowercase addresses(e.g., 0x382b...5c50) | | after | String | No | Pagination of data to return records earlier than the requested ts. | | before | String | No | Pagination of data to return records newer than the requested ts. The latest data will be returned when using before individually | | bar | String | No | Bar size, the default is 1m
e.g. [1s/1m/3m/5m/15m/30m/1H/2H/4H]
Hong Kong time opening price k-line：[6H/12H/1D/1W/1M/3M]
UTC time opening price k-line：[/6Hutc/12Hutc/1Dutc/1Wutc/1Mutc/3Mutc] | | limit | String | No | Number of results per request. The maximum is 299. The default is 100. | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | ts | String | Opening time of the candlestick, Unix timestamp format in milliseconds, e.g. 1597026383085 | | o | String | Open price | | h | String | Highest price | | l | String | Lowest price | | c | String | Close price | | vol | String | Trading volume, with a unit of base currency. | | volUsd | String | Trading volume, with a unit of usd. | | confirm | String | The state of candlesticks.
`0` represents that it is uncompleted, `1` represents that it is completed. | The first candlestick data may be incomplete, and should not be polled repeatedly. The data returned will be arranged in an array like this: [ts,o,h,l,c,vol,volUsd,confirm]. Use the closing price of the last candle as the opening price of the following candle. ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/historical-candles?chainIndex=66&tokenContractAddress=0x382bb369d343125bfb2117af9c149795c6c65c50' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code":"0", "data":[ [ "1597026383085", "3.721", "3.743", "3.677", "3.708", "22698348.04828491", "226348.0482", "0" ], [ "1597026383085", "3.731", "3.799", "3.494", "3.72", "67632347.24399722", "6767.2439", "1" ] ], "msg":"" } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/market-price-error-code.md) # Error Codes ## API error handling | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------------------------------| | 0 | 200 | Succeeded | | 50011 | 429 | Rate limit reached. Please refer to API documentation and throttle requests accordingly | | 50014 | 400 | Parameter \{param0\} cannot be empty | | 50026 | 500 | System error. Try again later | | 50103 | 401 | Request header "OK-ACCESS-KEY" cannot be empty | | 50104 | 401 | Request header "OK-ACCESS-PASSPHRASE" cannot be empty| | 50105 | 401 | Request header "OK-ACCESS-PASSPHRASE" incorrect | | 50106 | 401 | Request header "OK-ACCESS-SIGN" cannot be empty | | 50107 | 401 | Request header "OK-ACCESS-TIMESTAMP" cannot be empty | | 50111 | 401 | Invalid OK-ACCESS-KEY | | 50112 | 401 | Invalid OK-ACCESS-TIMESTAMP | | 50113 | 401 | Invalid signature | | 51000 | 400 | Parameter \{param0\} error | ## Payment error handling | Error Message | Meaning | Troubleshooting Action | |------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | Empty / null response | Request did not include PAYMENT-SIGNATURE or X-PAYMENT header | Include PAYMENT-SIGNATURE or X-PAYMENT in the request after signing | | invalid payment header | PAYMENT-SIGNATURE content is invalid | Check for truncation / encoding issues / multiple base64 nesting | | param_mismatch | Missing required fields or invalid parameters (address / nonce format) | Verify that parameters in the signature match the expected values | | toAddr mismatch | PayTo address does not match or is zero address | Ensure the address matches exactly and is not 0x0000… | | amount mismatch | Signed amount does not match returned amount | Ensure value in EIP-3009 signature equals the returned amount | | unsupported_chain | Parsed chainIndex from network is not supported | Currently only X Layer (eip155:196) is supported | | payer_blocked | authorization.from triggered risk control rules | Contact OKX support / risk team | | risk_address | payer or payTo is flagged (blacklist / sanctioned address) | Use a different address | | resource mismatch | Signed URL does not match request URL | Use the exact request URL when signing; do not reuse payload | | no matching payment option | Payment token does not match required token | Sign using the token specified in the response | | invalid_signature | Invalid signature format (length, r/s range, v value, etc.) | Use OKXEvmSigner; avoid manual EIP-712 construction | | not_yet_valid | validAfter > now | Check system time | | expired | `validBefore <= now` | Check system time | | invalid signature, nonce_used | Nonce already used on-chain | Generate a new 32-byte nonce and sign again | | insufficient_balance | Insufficient balance | Fund the account or reduce concurrent payments | | onchain_error | On-chain RPC / multicall failure | Retry the request | | payment processing | Duplicate request within cache window | Avoid reusing the same signature within cache period | - [Websocket](https://web3pre.okex.org/onchainos/dev-docs/market/websocket.md) # Websocket WebSocket is a new HTML5 protocol that achieves full-duplex data transmission between the client and server, allowing data to be transferred effectively in both directions. A connection between the client and server can be established with just one handshake. The server will then be able to push data to the client according to preset rules. Its advantages include: - The WebSocket request header size for data transmission between client and server is only 2 bytes. - Either the client or server can initiate data transmission. - There's no need to repeatedly create and delete TCP connections, saving resources on bandwidth and server. ## Connect **Connection limit**: 3 requests per second (based on API KEY)
When subscribing to a private channel, use the address of the private service ### Request limit The total number of 'subscribe'/'unsubscribe'/'login' requests per connection is limited to 480 times per hour. If there’s a network problem, the system will automatically disable the connection. The connection will break automatically if the subscription is not established or data has not been pushed for more than 30 seconds. To keep the connection stable: 1. Set a timer of N seconds whenever a response message is received, where N is less than 30. 2. If the timer is triggered, which means that no new message is received within N seconds, send the String 'ping'. 3. Expect a 'pong' as a response. If the response message is not received within N seconds, please raise an error or reconnect. ## Notification WebSocket has introduced a new message type (event = notice). Client will receive the information in the following scenarios: - Websocket disconnect for service upgrade 30 seconds prior to the upgrade of the WebSocket service, the notification 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. Response Example ```json { "event": "notice", "code": "64008", "msg": "The connection will soon be closed for a service upgrade. Please reconnect.", "connId": "a4d3ae55" } ``` - [Login](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-login.md) {/* api-page */} # Login ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | op | String | Yes | Operation, `login` | | args | Array | Yes | List of subscribed channels | | > apiKey | String | Yes | API Key | | > passphrase | String | Yes | API Key password | | > timestamp | String | Yes | Unix Epoch time, the unit is seconds | | > sign | String | Yes | Signature string | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | event | String | Operation.`login` or `error` | | code | String | Error code | | msg | String | Error message | | connId | String | WebSocket connection ID |

**apiKey**: Unique identification for invoking API. Requires users to apply one manually in the [developer portal](https://web3.okx.com/zh-hans/build/dev-portal).
**passphrase**: API Key password
**timestamp**: the Unix Epoch time, the unit is seconds, e.g. 1704876947
**sign**: signature string, the signature algorithm is as follows: First concatenate timestamp, method, requestPath, strings, then use HMAC SHA256 method to encrypt the concatenated string with SecretKey, and then perform Base64 encoding.
**secretKey**: The security key generated when the user applies for API Key, e.g. : 22582BD0CFF14C41EDBF1AB98506286D
**Example of timestamp**: const timestamp = '' + Date.now() / 1,000
**Among sign example**: sign=CryptoJS.enc.Base64.stringify(CryptoJS.HmacSHA256(timestamp +'GET'+'/users/self/verify', secretKey))
**method**: always 'GET'.
**requestPath**: always '/users/self/verify'

The request will expire 30 seconds after the timestamp. If your server time differs from the API server time, we recommend using the REST API to query the API server time and then set the timestamp. ## Request Example ```json { "op": "login", "args": [{ "apiKey": "985d5b66-57ce-40fb-b714-afc0b9787083", "passphrase": "123456", "timestamp": "1538054050", "sign": "7L+zFQ+CEgGu5rzCj4+BdV2/uUHGqddA9pI6ztsRRPs=" }] } ``` ## Response Example Successful Response Example ```json { "event": "login", "code": "0", "msg": "", "connId": "a4d3ae55" } ``` Failure Response Example ```json { "event": "error", "code": "60009", "msg": "Login failed.", "connId": "a4d3ae55" } ``` - [Subscribe](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-subscribe.md) {/* api-page */} # Subscribe

Users can choose to subscribe to one or more channels, with the total length of all channels not exceeding 64 KB. Price channels and trading channels require authentication before subscription. K-line (candlestick) channels do not require authentication. Below is an example of request parameters. Each channel has different parameter requirements, so please subscribe according to the specific requirements of each channel.

## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | op | String | Yes | Operation, `subscribe` | | args | Array | Yes | List of subscribed channels | | > channel | String | Yes | Channel name | | > chainIndex | String | Yes | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | > timestamp | String | Yes | Unix Epoch time, the unit is seconds | | > tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | event | String | Operation.`subscribe` or `error` | | arg | String | Subscribed channel | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | > tokenContractAddress | String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | code | String | Error code | | msg | String | Error message | | connId | String | WebSocket connection ID | Request format description ```json {"op": "subscribe","args": ["SubscriptionTopic"]} ``` ## Request Example ```json { "op": "subscribe", "args": [{ "channel": "price", "chainIndex": "1", "tokenContractAddress": "0x382bb369d343125bfb2117af9c149795c6c65c50" }] } ``` ## Response Example ```json { "event": "subscribe", "arg": { "channel": "price", "chainIndex": "1" "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" }, "connId": "accb8e21" } ``` - [Unsubscribe](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-unsubscribe.md) {/* api-page */} # Unsubscribe Unsubscribe from one or more channels. ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | op | String | Yes | Operation, `unsubscribe` | | args | Array | Yes | List of subscribed channels | | > channel | String | Yes | Channel name | | > chainIndex | String | Yes | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | > timestamp | String | Yes | Unix Epoch time, the unit is seconds | | > tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | event | String | Operation.`unsubscribe` or `error` | | arg | String | Subscribed channel | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | > tokenContractAddress | String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | code | String | Error code | | msg | String | Error message | | connId | String | WebSocket connection ID | Request format description ```json { "op": "unsubscribe", "args": ["SubscriptionTopic"] } ``` ## Request Example ```json { "op": "unsubscribe", "args": [{ "channel": "price", "chainIndex": "1", "tokenContractAddress": "0x382bb369d343125bfb2117af9c149795c6c65c50" }] } ``` ## Response Example ```json { "event": "unsubscribe", "arg": { "channel": "price", "chainIndex": "1", "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" }, "connId": "d0b44253" } ``` - [Websocket Channels](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-channels.md) # Websocket Channels - [Price Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-price-channel.md) {/* api-page */} # Price Channel Retrieve the latest price data of a token. The fastest push frequency updates in real time. A push will only occur if there is a trade and the price is not filtered out by the candlestick (K-line) price filter.
## Request URL wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | op | String | Yes | Operation, `subscribe` `unsubscribe` | | args | Array | Yes | List of subscribed channels | | channel | String | Yes | Channel name,`price` | | chainIndex | String | Yes | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | event | String | Event, `subscribe` `unsubscribe` `error` | | arg | Object | Token contract address | | channel | String | Channel name | | chainIndex| String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress| String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | code | String | Error code | | msg | String | Error message | ## Push Data Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | arg | Object | Successfully subscribed channel | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | > tokenContractAddress| String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | data | Array | Subscribed data | | > time | String | Timestamp of the price, Unix timestamp format in milliseconds | | > price | String | Latest token price | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "price", "chainIndex": "1", "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "price", "chainIndex": "1" "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"price\", \"chainIndex\" : \"1\", \"tokenContractAddress\" : \"0x382bb369d343125bfb2117af9c149795c6c65c50\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "price", "chainIndex": "1" "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" }, "data": [ { "time": "1716892020000", "price": "26.458143090226812", } ] } ``` - [Advanced price channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-price-info-channel.md) {/* api-page */} # Advanced price channel Returns token liquidity-related data with a maximum push frequency of once per second. ## Request URL wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | op | String | Yes | Operation, `subscribe` `unsubscribe` | | args | Array | Yes | List of subscribed channels | | channel | String | Yes | Channel name,`price-info` | | chainIndex | String | Yes | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | event | String | Event, `subscribe` `unsubscribe` `error` | | arg | Object | Token contract address | | channel | String | Channel name | | chainIndex| String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress| String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | code | String | Error code | | msg | String | Error message | ## Push Data Parameters | Parameter | Type | Description | |------------------------ |-------- |--------------------------------------------------------------------------- | | arg | Object | Successfully subscribed channel | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See ChainIndex) | | > tokenContractAddress | String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | data | Array | Subscribed data | | > time | String | Timestamp of the price, Unix timestamp format in milliseconds | | > price | String | Latest token price | | > marketCap | String | Token marketcap | | > priceChange5M | String | 5 min price change | | > priceChange1H | String | 1 hour price change | | > priceChange4H | String | 4 hour price change | | > priceChange24H | String | 24 hour price change | | > volume5M | String | 5 min volume | | > volume1H | String | 1 hour volume | | > volume4H | String | 4 hour volume | | > volume24H | String | 24 hour volume | | > txs5M | String | 代币 5 分钟内交易笔数 | | >txs1H | String | 代币 1 小时内交易笔数 | | >txs4H | String | 代币 4 小时内交易笔数 | | >txs24H | String | 代币 24 小时内交易笔数 | | >maxPrice | String | 代币 24h 最高价格 | | >tradeNum | String | 24h 代币交易数量 | | >minPrice | String | 代币 24h 最低价格 | | >circSupply | String | 代币流通供应量 | | >liquidity | String | 代币资金池中的流动性 | | >holders | String | 代币持仓地址数 | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "price-info", "chainIndex": "1", "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "price-info", "chainIndex": "501" "tokenContractAddress":"eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"price-info\", \"chainIndex\" : \"501\", \"tokenContractAddress\" : \"eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "price-info", "chainIndex": "501" "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" }, "data": [ { "chainIndex": "501", "circSupply": "999973312.2632950000", "holders": "37241", "liquidity": "3923952.461979153265333544895656917", "marketCap": "19960307.19257757296691203", "maxPrice": "0.1656024888921609", "minPrice": "0.02292722724150618", "price": "0.019960839902217294", "priceChange1H": "9.12", "priceChange24H": "374.25", "priceChange4H": "68.26", "priceChange5M": "6.91", "time": "1758702741738", "tokenContractAddress": "eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump", "tradeNum": "2460429287.120492", "txs1H": "15142", "txs24H": "276164", "txs4H": "38998", "txs5M": "1196", "volume1H": "12864939.572057", "volume24H": "169512096.311189", "volume4H": "29069166.04389", "volume5M": "893224.505265" } ] } ``` - [Candlesticks Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-candlesticks-channel.md) {/* api-page */} # Candlesticks Channel Retrieve the candlesticks data of a token. The fastest push frequency is 1 push per second.
## Request URL wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | op | String | Yes | Operation, `subscribe` `unsubscribe` | | args | Array | Yes | List of subscribed channels | | channel | String | Yes | Channel name. `dex-token-candle1s` `dex-token-candle1m` `dex-token-candle3m` `dex-token-candle5m` `dex-token-candle15m` `dex-token-candle30m` `dex-token-candle1H` `dex-token-candle2H` `dex-token-candle4H` `dex-token-candle6H` `dex-token-candle12H` `dex-token-candle1M` `dex-token-candle3M` `dex-token-candle1W` `dex-token-candle1D` `dex-token-candle2D` `dex-token-candle3D` `dex-token-candle5D` `dex-token-candle6Hutc` `dex-token-candle12Hutc` `dex-token-candle1Dutc` `dex-token-candle2Dutc` `dex-token-candle3Dutc` `dex-token-candle5Dutc` `dex-token-candle1Wutc` `dex-token-candle1Mutc` `dex-token-candle3Mutc` | | chainIndex | String | Yes | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | event | String | Event, `subscribe` `unsubscribe` `error` | | arg | Object | Token contract address | | channel | String | Channel name | | chainIndex| String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress| String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | code | String | Error code | | msg | String | Error message | ## Push Data Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | arg | Object | Successfully subscribed channel | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | > tokenContractAddress| String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | data | Array | Subscribed data | | > ts | String | Opening time of the candlestick, Unix timestamp format in milliseconds, e.g. 1597026383085 | | > o | String | Open price | | > h | String | highest price | | > l | String | Lowest price | | > c | String | Close price | | > vol | String | Trading volume, with a unit of base currency | | > volUsd | String | Trading volume, with a unit of usd. | | > confirm | String | The state of candlesticks.
`0`: represents that it is uncompleted `1`: represents that it is completed. | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "dex-token-candle1s", "chainIndex": "1", "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "dex-token-candle1s", "chainIndex": "1" "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"dex-token-candle1s\", \"chainIndex\" : \"1\", \"tokenContractAddress\" : \"0x382bb369d343125bfb2117af9c149795c6c65c50\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "dex-token-candle1s", "chainIndex": "1" "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50" }, "data": [ [ "1597026383085", "8533.02", "8553.74", "8527.17", "8548.26", "529.5858061", "226348.0482", "0" ] ] } ``` - [Token Update Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-token-channel.md) {/* api-page */} # Token Update Channel Real-time push of incremental market metric updates for Meme tokens. Data is pushed whenever metrics change.
**URL Path**
wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |--------------------------|--------|----------|-------------------------------------------------------------------------------------------------| | op | String | Yes | Operation: `subscribe` `unsubscribe` | | args | Array | Yes | List of channels to subscribe | | channel | String | Yes | Channel name: `dex-market-memepump-update-metrics-openapi` | | chainIndex | String | Yes | Unique identifier for the chain. Pass the chain ID (e.g., 501 for Solana). Single-chain only. | ## Response Parameters | Parameter | Type | Description | |-----------|--------|-----------------------------------------------------------| | event | String | Event type: `subscribe` `unsubscribe` `error` | | arg | Object | Subscribed channel | | channel | String | Channel name | | code | String | Error code (only returned when event=error) | | msg | String | Error message (only returned when event=error) | | connId | String | WebSocket connection ID | ## Push Data Parameters | Parameter | Type | Description | |------------------------------------|---------|---------------------------------------------------------------------------------------| | arg | Object | Successfully subscribed channel info | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain | | data | Array | Batched real-time token metric updates (each batch contains multiple token objects) | | > chainIndex | String | Chain ID (e.g., 501=Solana) | | > protocolId | String | Protocol source ID (e.g., 1=PUMP_FUN) | | > quoteTokenAddress | String | Quote token contract address | | > tokenContractAddress | String | Token contract address | | > symbol | String | Token symbol | | > name | String | Token name | | > logoUrl | String | Token logo URL | | > createdTimestamp | String | Token creation time (Unix timestamp in milliseconds) | | > market | Object | Market data (incremental update) | | >> marketCapUsd | String | Market cap (USD) | | >> volumeUsd1h | String | 1-hour trading volume (USD) | | >> txCount1h | String | 1-hour total transaction count | | >> buyTxCount1h | String | 1-hour buy transaction count | | >> sellTxCount1h | String | 1-hour sell transaction count | | > bondingPercent | String | Bonding curve progress (%) | | > mayhemModeTimeRemaining | String | Remaining time for Pump.fun Mayhem Mode; empty if token is not in this mode | | > tags | Object | Tag / audit data | | >> top10HoldingsPercent | String | Top 10 holders percentage (%) | | >> devHoldingsPercent | String | Dev holdings percentage (%) | | >> insidersPercent | String | Insiders percentage (%) | | >> bundlersPercent | String | Bundlers percentage (%) | | >> snipersPercent | String | Snipers percentage (%) | | >> freshWalletsPercent | String | Fresh wallets percentage (%) | | >> suspectedPhishingWalletPercent | String | Suspected phishing wallet percentage (%) | | >> totalHolders | String | Total number of token holder addresses | | > social | Object | Social media information | | >> x | String | X (Twitter) link | | >> telegram | String | Telegram link | | >> website | String | Website link | | >> dexScreenerPaid | Boolean | DEX Screener paid | | >> communityTakeover | Boolean | Community takeover (CTO) | | >> liveOnPumpFun | Boolean | Live on Pump.fun | | > bagsFeeClaimed | Boolean | Whether bags fee has been claimed | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "dex-market-memepump-update-metrics-openapi", "chainIndex": "501" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "dex-market-memepump-update-metrics-openapi", "chainIndex": "501" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\": \"dex-market-memepump-update-metrics-openapi\", \"chainIndex\": \"501\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "dex-market-memepump-update-metrics-openapi", "chainIndex": "501" }, "data": [ [ { "bagsFeeClaimed": false, "bondingPercent": "0.02", "chainIndex": "501", "createdTimestamp": "1773129702000", "creatorAddress": "5DZ1ghesLRDzioYoDoyFejgxRwFBxgs9P85kv6d8Zd7X", "logoUrl": "https://static.coinall.ltd/cdn/web3/currency/token/default-logo/token_custom_logo_default_P/type=default_350_0", "market": { "buyTxCount1h": "1", "marketCapUsd": "2457.472431547000000000", "sellTxCount1h": "0", "txCount1h": "1", "volumeUsd1h": "4.011085498679725011505911" }, "name": "$PRISM", "protocolId": "136137", "quoteTokenAddress": "So11111111111111111111111111111111111111112", "social": { "communityTakeover": false, "dexScreenerPaid": false, "liveOnPumpFun": false }, "symbol": "PSM", "tags": { "bundlersPercent": "0", "devHoldingsPercent": "0.0458", "freshWalletsPercent": "0", "insidersPercent": "0", "snipersPercent": "0.0458", "suspectedPhishingWalletPercent": "0", "top10HoldingsPercent": "0.16320", "totalHolders": "1" }, "tokenAddress": "SXEdooR2e1RHpYdarMqFPrkhTBARn6NhT88nXjVrD2X" } ] ] } ``` - [Trades Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-trades-channel.md) {/* api-page */} # Trades Channel Retrieve the recent trades data. Data will be pushed whenever there is a trades.
## Request URL wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | | -------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------ | | op | String | Yes | Operation, `subscribe` `unsubscribe` | | args | Array | Yes | List of subscribed channels | | channel | String | Yes | Channel name,`trades` | | chainIndex | String | Yes | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Parameter | Type | Description | | -------------------- | ------ | ------------------------------------------------------------------------------------------------ | | event | String | Event, `subscribe` `unsubscribe` `error` | | arg | Object | Token contract address | | channel | String | Channel name | | chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress | String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | code | String | Error code | | msg | String | Error message | ## Push Data Parameters | Parameter | Type | Description | | ----------------------- | ------ | ------------------------------------------------------------------------------------------------ | | arg | Object | Successfully subscribed channel | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | > tokenContractAddress | String | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | data | Array | Subscribed data | | > id | String | Unique trade id | | > txHashUrl | String | On-chain txhash of the transaction | | > userAddress | String | Authorizer of the transaction | | > dexName | String | Name of the dex where the trade occured | | > poolLogoUrl | String | Pool logo url | | > type | String | Trade Type buy sell | | > amountExchanged | String | Amount exchanged in this pair | | >> amount | String | Token exchanged amount in this trade | | >> tokenSymbol | String | Token symbol | | >> tokenContractAddress | String | Token contract address | | > price | String | Latest token price | | > volume | String | USD value of this trade | | > time | String | Timestamp of the trade, Unix timestamp format in milliseconds | | > isFiltered | String | If the trade is filtered for price and k-line calculation.
`0`: not filtered `1`: filtered | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "trades", "chainIndex": "501", "tokenContractAddress": "HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "trades", "chainIndex": "501", "tokenContractAddress": "HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"trades\", \"chainIndex\" : \"501\", \"tokenContractAddress\" : \"HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "trades", "chainIndex": "501" "tokenContractAddress":"HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC" }, "data":[ { "id":"1739439633000!@#120!@#14731892839", "chainIndex": "501", "tokenContractAddress": "HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC", "txHashUrl": "https://solscan.io/tx/zgDzoiVG4XuDgQcoEg9vhpRyfyk5thNUQuTeTCeF289Qec5iraeCrUzPLyiE2UCviox2ebbTcsagGvzYF7M5uqs", "userAddress": "2kCm1RHGJjeCKL4SA3ZJCLyXqUD7nEJ7GMtVaP7c6jQ8", "dexName": "Orca Whirlpools", "poolLogoUrl": "https://static.okx.com/cdn/wallet/logo/dex_orcaswap.png", "type": "sell", "changedTokenInfo": [ { "amount":"100.396595878", "tokenSymbol":"ai16z", "tokenContractAddress": "HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC" }, { "amount":"2.482831", "tokenSymbol":"SOL", "tokenContractAddress": "So11111111111111111111111111111111111111112" } ] "price": "26.458143090226812", "volume": "519.788163", "time": "1739439633000", "isFiltered": "0" } ] } ``` - [Signal Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-signal-channel.md) {/* api-page */} # Signal Channel Real-time push of on-chain trading signals from Smart Money / KOL / Whale wallets. Subscribe after login; data is pushed whenever a new signal is triggered.
**URL Path**
wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |-------------|--------|----------|----------------------------------------------------------------------------------------------------------| | op | String | Yes | Operation: `subscribe` `unsubscribe` | | args | Array | Yes | List of channels to subscribe | | channel | String | Yes | Channel name `dex-market-new-signal-openapi` | | chainIndex | String | Yes | Unique identifier for the chain. Pass the chain ID (e.g., 1 for Ethereum). Single-chain only. | ## Response Parameters | Parameter | Type | Description | |------------------------------|--------|---------------------------------------------------------------------------------------------------------------------| | event | String | Event type: `subscribe` `unsubscribe` `error` | | arg | Object | Subscribed channel | | channel | String | Channel name | | signal | Object | Signal list | | > timestamp | String | Timestamp when the signal was triggered | | > chainIndex | String | Unique identifier for the chain | | > token | Object | Token information | | >> tokenAddress | String | Token contract address | | >> symbol | String | Token symbol | | >> name | String | Token name | | >> logo | String | Token logo URL | | >> marketCapUsd | String | Market cap (USD) | | >> holders | String | Number of holder addresses | | >> top10HolderPercent | String | Top 10 holder percentage | | > price | String | Token price (USD) at signal trigger time | | > walletType | String | Wallet type code. Enum: `1` = Smart Money, `2` = KOL / Influencer, `3` = Whales. Multiple values separated by commas | | > triggerWalletCount | String | Number of wallet addresses that triggered the signal | | > triggerWalletAddress | String | List of wallet addresses, comma-separated | | > amountUsd | String | Trade amount (USD) | | > soldRatioPercent | String | Sell-off ratio percentage | | code | String | Error code (only returned when event=error) | | msg | String | Error message (only returned when event=error) | ## Push Data Parameters | Parameter | Type | Description | |------------------------------|--------|---------------------------------------------------------------------------------------------------------------------| | arg | Object | Successfully subscribed channel info | | > channel | String | Channel name | | > timestamp | String | Timestamp when the signal was triggered | | > chainIndex | String | Unique identifier for the chain | | > token | Object | Token information | | >> tokenAddress | String | Token contract address | | >> symbol | String | Token symbol | | >> name | String | Token name | | >> logo | String | Token logo URL | | >> marketCapUsd | String | Market cap (USD) | | >> holders | String | Number of holder addresses | | >> top10HolderPercentage | String | Top 10 holder percentage | | > price | String | Token price (USD) at signal trigger time | | > walletType | String | Wallet type code. Enum: `1` = Smart Money, `2` = KOL / Influencer, `3` = Whales. Multiple values separated by commas | | > triggerWalletCount | String | Number of wallet addresses that triggered the signal | | > triggerWalletAddress | String | List of wallet addresses, comma-separated | | > amountUsd | String | Trade amount (USD) | | > soldRatioPercentage | String | Sell-off ratio percentage | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "dex-market-new-signal-openapi", "chainIndex": "1" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "dex-market-new-signal-openapi", "chainIndex": "1" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" , \"chainIndex\" : \"1\", \"tokenContractAddress\" : \"0x382bb369d343125bfb2117af9c149795c6c65c50\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "dex-market-new-signal-openapi", "chainIndex": "1", "timestamp": "1739439633000", "token": { "tokenAddress": "0x382bb369d343125bfb2117af9c149795c6c65c50", "symbol": "ORBS", "name": "Orbs", "logo": "https://static.okx.com/cdn/wallet/logo/ORBS.png", "marketCapUsd": "89234567.12", "holders": "23456", "top10HolderPercentage": "35.6" }, "price": "0.0421", "walletType": "1,2", "triggerWalletCount": "5", "triggerWalletAddress": "0xabc...111,0xdef...222", "amountUsd": "128000.00", "soldRatioPercentage": "0" } } ``` - [Memepump Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-memepump-channel.md) {/* api-page */} # Memepump Channel Real-time push of newly launched Meme token data. Data is pushed whenever a new token is released.
**URL Path**
wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |--------------------------|--------|----------|-------------------------------------------------------------------------------------------------| | op | String | Yes | Operation: `subscribe` `unsubscribe` | | args | Array | Yes | List of channels to subscribe | | channel | String | Yes | Channel name: `dex-market-memepump-new-token-openapi` | | chainIndex | String | Yes | Unique identifier for the chain. Pass the chain ID (e.g., 501 for Solana). Single-chain only. | ## Response Parameters | Parameter | Type | Description | |-----------|--------|-----------------------------------------------------------| | event | String | Event type: `subscribe` `unsubscribe` `error` | | arg | Object | Subscribed channel | | channel | String | Channel name | | code | String | Error code (only returned when event=error) | | msg | String | Error message (only returned when event=error) | | connId | String | WebSocket connection ID | ## Push Data Parameters | Parameter | Type | Description | |------------------------------------|---------|--------------------------------------------------------------------------| | arg | Object | Successfully subscribed channel info | | > channel | String | Channel name | | > chainIndex | String | Unique identifier for the chain | | data | Array | List of newly launched tokens | | > chainIndex | String | Chain ID (e.g., 501=Solana) | | > protocolId | String | Protocol source ID (e.g., 1=PUMP_FUN) | | > quoteTokenAddress | String | Quote token contract address | | > tokenContractAddress | String | Token contract address | | > symbol | String | Token symbol | | > name | String | Token name | | > logoUrl | String | Token logo URL | | > createdTimestamp | String | Token creation time (Unix timestamp in milliseconds) | | > market | Object | Market data | | >> marketCapUsd | String | Market cap (USD) | | >> volumeUsd1h | String | 1-hour trading volume (USD) | | >> txCount1h | String | 1-hour total transaction count | | >> buyTxCount1h | String | 1-hour buy transaction count | | >> sellTxCount1h | String | 1-hour sell transaction count | | > bondingPercent | String | Bonding curve progress (%) | | > tags | Object | Tag / audit data | | >> top10HoldingsPercent | String | Top 10 holders percentage (%) | | >> devHoldingsPercent | String | Dev holdings percentage (%) | | >> insidersPercent | String | Insiders percentage (%) | | >> bundlersPercent | String | Bundlers percentage (%) | | >> snipersPercent | String | Snipers percentage (%) | | >> freshWalletsPercent | String | Fresh wallets percentage (%) | | >> suspectedPhishingWalletPercent | String | Suspected phishing wallet percentage (%) | | >> totalHolders | String | Total number of token holder addresses | | > social | Object | Social media information | | >> x | String | X (Twitter) link | | >> telegram | String | Telegram link | | >> website | String | Website link | | >> dexScreenerPaid | Boolean | DEX Screener paid | | >> communityTakeover | Boolean | Community takeover (CTO) | | >> liveOnPumpFun | Boolean | Live on Pump.fun | | > bagsFeeClaimed | Boolean | Whether bags fee has been claimed | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "dex-market-memepump-new-token-openapi", "chainIndex": "501" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "dex-market-memepump-new-token-openapi", "chainIndex": "501" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\": \"dex-market-memepump-new-token-openapi\", \"chainIndex\": \"501\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "dex-market-memepump-new-token-openapi", "chainIndex": "501" }, "data": [ { "bagsFeeClaimed": false, "bondingPercent": "0", "chainIndex": "501", "createdTimestamp": "1773111278502", "creatorAddress": "CfCpn9LFW6HDsUcNUbX65HfxNmouhTNCb6RD9FmF8sy9", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/default-logo/token_custom_logo_default_S/type=default_350_0", "market": {}, "name": "Siberian Husky Scarlett", "protocolId": "136460", "social": { "communityTakeover": false, "dexScreenerPaid": false, "liveOnPumpFun": false }, "symbol": "Scarlett", "tags": {}, "tokenAddress": "5E2yC3KVFhm2kvUXFMWJCKP7pLtkScBP8CnZ9rtjpump" } ] } ``` - [Address Tracker Trades Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-address-activity-channel.md) {/* api-page */} # Address Tracker Trades Channel Real-time push of on-chain transaction activity from tracked wallet addresses. Subscribe after login; data is pushed whenever a new transaction occurs.
**URL Path**
wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |-------------|--------|----------|---------------------------------------------------------------| | op | String | Yes | Operation: `subscribe` `unsubscribe` | | args | Array | Yes | List of subscription parameters | | > channel | String | Yes | Channel name: `address-tracker-activity` | | > walletAddress | String | Yes | The wallet addresses you want to track, One connection can support up to 200 addresses; for 1,000 addresses, simply establish 5 connections. | ## Response Parameters | Parameter | Type | Description | |-------------|--------|--------------------------------------------------------------------| | event | String | Event type: `subscribe` `unsubscribe` `error` | | arg | Object | Successfully subscribed channel parameters | | > channel | String | Channel name | | code | String | Error code (only returned when event=error) | | msg | String | Error message (only returned when event=error) | | connId | String | WebSocket connection ID | ## Push Data Parameters | Parameter | Type | Description | |------------------------|--------|-------------------------------------------------------------------------------------------------| | arg | Object | Channel info that triggered the push | | > channel | String | Channel name | | data | Array | List of pushed trade activity | | > txHash | String | Transaction hash | | > walletAddress | String | Trading wallet address | | > quoteTokenSymbol | String | Quote token symbol (native chain token) | | > quoteTokenAmount | String | Quote token trade amount | | > tokenSymbol | String | Traded token symbol | | > tokenContractAddress | String | Traded token contract address | | > chainIndex | String | Chain identifier of the traded token | | > tokenPrice | String | Trade price of the token (USD) | | > marketCap | String | Market cap of the token at the trade price (USD) | | > realizedPnlUsd | String | Realized PnL for the token (USD) | | > tradeType | String | Trade type: `1` buy `2` sell | | > tradeTime | String | Trade time (Unix timestamp in milliseconds) | | > trackerType | Array | Tracker wallet type: `1` Smart Money `2` KOL | ## Request Example ```json { "channel": "address-tracker-activity", "walletAddress": "DHfshpzoC9Q7rz32j5juq2do3Bo8bA1KLmkNiRYaA8tf" }, { "channel": "address-tracker-activity", "walletAddress": "0x1234567890abcdef1234567890abcdef12345678" }, { "channel": "address-tracker-activity", "walletAddress": "0x1234567890abcdef1234567890abcdef12345678" } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "address-tracker-activity" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" , \"chainIndex\" : \"1\", \"tokenContractAddress\" : \"0x382bb369d343125bfb2117af9c149795c6c65c50\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "address-tracker-activity" }, "data": [ { "baseTokenChainIndex": "501", "baseTokenContractAddress": "FmxDdxpFmmuN4DeXoHFzuEyrH8RfRsej6oxg4MaUpump", "baseTokenSymbol": "XAIC", "marketCap": "3229.75150297000000000000000000000000000", "quoteTokenAmount": "1.576294", "quoteTokenSymbol": "SOLANA", "realizedPnlUsd": "-0.481221442431056693018746", "trackerType": [1], "tradePrice": "0.00000322975150297", "tradeTime": 1773628806000, "tradeType": "2", "walletAddress": "DHfshpzoC9Q7rz32j5juq2do3Bo8bA1KLmkNiRYaA8tf" } ] } ``` - [KOL & Smart Money Tracker Trades Channel](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-kol-smartmoney-activity-channel.md) {/* api-page */} # KOL & Smart Money Tracker Trades Channel Real-time push of on-chain transaction activity from tracked KOL / Smart Money addresses. Subscribe after login; data is pushed whenever a new transaction occurs.
**URL Path**
wss://wsdex.okx.com/ws/v6/dex ## Request Parameters | Parameter | Type | Required | Description | |-------------|--------|----------|---------------------------------------------------------------| | op | String | Yes | Operation: `subscribe` `unsubscribe` | | args | Array | Yes | List of subscription parameters | | > channel | String | Yes | Channel name: `kol_smartmoney-tracker-activity` | ## Response Parameters | Parameter | Type | Description | |-------------|--------|--------------------------------------------------------------------| | event | String | Event type: `subscribe` `unsubscribe` `error` | | arg | Object | Successfully subscribed channel parameters | | > channel | String | Channel name | | code | String | Error code (only returned when event=error) | | msg | String | Error message (only returned when event=error) | | connId | String | WebSocket connection ID | ## Push Data Parameters | Parameter | Type | Description | |------------------------|--------|-------------------------------------------------------------------------------------------------| | arg | Object | Channel info that triggered the push | | > channel | String | Channel name | | data | Array | List of pushed trade activity | | > txHash | String | Transaction hash | | > walletAddress | String | Trading wallet address | | > quoteTokenSymbol | String | Quote token symbol (native chain token) | | > quoteTokenAmount | String | Quote token trade amount | | > tokenSymbol | String | Traded token symbol | | > tokenContractAddress | String | Traded token contract address | | > chainIndex | String | Chain identifier of the traded token | | > tokenPrice | String | Trade price of the token (USD) | | > marketCap | String | Market cap of the token at the trade price (USD) | | > realizedPnlUsd | String | Realized PnL for the token (USD) | | > tradeType | String | Trade type: `1` buy `2` sell | | > tradeTime | String | Trade time (Unix timestamp in milliseconds) | | > trackerType | Array | Tracker wallet type: `1` Smart Money `2` KOL | ## Request Example ```json { "op": "subscribe", "args": [ { "channel": "kol_smartmoney-tracker-activity" } ] } ``` ## Response Example Successful response example ```json { "event": "subscribe", "arg": { "channel": "kol_smartmoney-tracker-activity" }, "connId": "a4d3ae55" } ``` Failure response example ```json { "event": "error", "code": "60012", "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" , \"chainIndex\" : \"1\", \"tokenContractAddress\" : \"0x382bb369d343125bfb2117af9c149795c6c65c50\"}]}", "connId": "a4d3ae55" } ``` Push data example ```json { "arg": { "channel": "kol_smartmoney-tracker-activity" }, "data": [ { "baseTokenChainIndex": "501", "baseTokenContractAddress": "FmxDdxpFmmuN4DeXoHFzuEyrH8RfRsej6oxg4MaUpump", "baseTokenSymbol": "XAIC", "marketCap": "3229.75150297000000000000000000000000000", "quoteTokenAmount": "1.576294", "quoteTokenSymbol": "SOLANA", "realizedPnlUsd": "-0.481221442431056693018746", "trackerType": [1], "tradePrice": "0.00000322975150297", "tradeTime": 1773628806000, "tradeType": "2", "walletAddress": "DHfshpzoC9Q7rz32j5juq2do3Bo8bA1KLmkNiRYaA8tf" } ] } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/websocket-error-code.md) # Error Codes | Code | Message | |-------|------------------------------------------------------------------------------------------------------------| | 60004 | Invalid timestamp | | 60005 | Invalid apiKey | | 60006 | Timestamp request expired | | 60007 | Invalid sign | | 60008 | The current WebSocket endpoint does not support subscribing to {0} channels. Please check the WebSocket URL | | 60009 | Login failure | | 60011 | Please log in | | 60012 | Invalid request | | 60013 | Invalid args | | 60014 | Requests too frequent | | 60018 | Wrong URL or {0} doesn't exist. Please use the correct URL, channel and parameters referring to API document. | | 60019 | Invalid op: \{op\} | | 60020 | APIKey subscription amount exceeds the limit {0}. | | 60021 | This operation does not support multiple accounts login. | | 60022 | Bulk login partially succeeded | | 60023 | Bulk login requests too frequent | | 60024 | Wrong passphrase | | 60025 | token subscription amount exceeds the limit {0} | | 60026 | Batch login by APIKey and token simultaneously is not supported. | | 60027 | Parameter {0} can not be empty. | | 60028 | The current operation is not supported by this URL. Please use the correct WebSocket URL for the operation. | | 60029 | Only users who are in the whitelist are allowed to subscribe to this channel. | | 60030 | The WebSocket endpoint does not allow multiple or repeated logins. | | 60031 | API key doesn't exist. | | 63999 | Login failed due to internal error. Please try again later. | - [API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/index-price-reference.md) # API Reference - [Get Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/index-price-chains.md) {/* api-page */} # Get Supported Chains Retrieve information on chains supported by Index price API ## Request URL GET `https://web3.okx.com/api/v6/dex/balance/supported/chain` ## Request Parameters None ## Response Parameters | Parameter | Type | Description | |-----------|--------|-------------------| | name | String | Chain name | | logoUrl | String | Chain logo URL | | shortName | String | Chain short name | | chainIndex| String | Chain unique identifier | ## Request Example ``` shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/balance/supported/chain' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "name": "Ethereum", "logoUrl": "http://www.eth.org/eth.png", "shortName": "ETH", "chainIndex": "1" } ], "msg": "" } ``` - [Get Token Index Price](https://web3pre.okex.org/onchainos/dev-docs/market/index-price.md) {/* api-page */} # Get Token Index Price The index price refers to a currency price calculated from the prices of multiple third-party data sources. Batch query for index token prices, maximum 100 token prices can be queried per request.
Request Parameters should be passed in the form of an array. ## Request URL POST `https://web3.okx.com/api/v6/dex/index/current-price` ## Request Parameters | Parameter | Type | Required | Description | |--------------|--------|----------|-------------| | chainIndex | String | Yes | Unique identifier of the blockchain | | tokenContractAddress | String | Yes | Token address.
`1`: Pass an empty string `""` to query the native token of the corresponding chain.
`2`: Pass the specific token contract address to query the corresponding token. | ## Response Parameters | Parameter | Type | Description | |--------------|--------|-------------------------------| | price | String | Token price | | time | String | Timestamp of the price, Unix timestamp in milliseconds | | chainIndex | String | Unique identifier of the blockchain | | tokenContractAddress | String | Token address.| ## Request Example ``` shell curl --location --request POST 'https://web3.okx.com/api/v6/dex/index/current-price' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \ --data-raw '[ { "chainIndex": "1", "tokenContractAddress":"0xc18360217d8f7ab5e7c516566761ea12ce7f9d72" }, ]' ``` ## Response Example ``` json { "code": 0, "msg": "success", "data": [ { "chainIndex": "1", "tokenContractAddress": "0xc18360217d8f7ab5e7c516566761ea12ce7f9d72" "time": "1716892020000", "price": "26.458143090226812", } ] } ``` - [Get Historical Index Price](https://web3pre.okex.org/onchainos/dev-docs/market/historical-index-price.md) {/* api-page */} # Get Historical Index Price Query historical prices for a specific token. ## Request URL GET `https://web3.okx.com/api/v6/dex/index/historical-price` ## Request Parameters | Parameter | Type | Required | Description | |--------------|--------|----------|----------------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier of the blockchain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | tokenContractAddress | String | No | Token address.
`1`: Pass an empty string `""` to query the native token of the corresponding chain.
`2`: Pass the specific token contract address to query the corresponding token. | | limit | String | No | Number of entries per query, default is 50, maximum is 200 | | cursor | String | No | Cursor position, defaults to the first entry | | begin | String | No | Start time to query historical prices after. Unix timestamp in milliseconds | | end | String | No | End time to query historical prices before. If neither begin nor end is provided, query historical prices before the current time. Unix timestamp in milliseconds | | period | String | No | Time interval unit:
`1m`: 1 minute
`5m`: 5 minutes
`30m`: 30 minutes
`1h`: 1 hour
`1d`: 1 day (default) | ## Response Parameters | Parameter | Type | Description | |-----------|--------|----------------------| | prices | Array | List of historical prices | | >time | String | Timestamp of the minute (whole minute) | | >price | String | Cryptocurrency price (precision 18 decimal places) | ## Request Example ``` shell curl --location --request GET 'https://web3.okx.com/api/v5/wallet/token/historical-price?chainIndex=1&limit=5&begin=1700040600000&period=5m' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "success", "data": [ { "cursor": "31", "prices": [ { "time": "1700040600000", "price": "1994.430000000000000000" }, { "time": "1700040300000", "price": "1994.190000000000000000" }, { "time": "1700040000000", "price": "1992.090000000000000000" }, { "time": "1700039700000", "price": "1992.190000000000000000" }, { "time": "1700039400000", "price": "1990.190000000000000000" } ] } ] } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/index-price-error-code.md) # Error Codes | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------------------------------| | 81001 | 200 | Incorrect parameter | - [API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-reference.md) # API Reference - [Get RWA Token List](https://web3pre.okex.org/onchainos/dev-docs/market/market-rwa-token.md) {/* api-page */} # Get RWA Token List Retrieve a list of RWA (Real World Asset) stock tokens. Supports filtering by issuer, category, and chain, with cursor-based pagination. Results are sorted by 24h trading volume in descending order. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/rwa/tokens` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | issuer | String | No | Filter by RWA issuer. Returns all if omitted or empty.
`36` = `xstocks`, `37` = `ondo`. | | category | String | No | Filter by token category.
`47` = `All`
`60` = `AI Chips`
`61` = `Crypto Equities`
`62` = `Space & Defense`
`63` = `China Tech`
`64` = `Consumer Tech`
`65` = `Biotech & Pharma`
`66` = `Energy`
`67` = `Commodities`
`68` = `Indices` | | chainIndex | String | No | Filter by chain index. Example: `1` (Ethereum) | | limit | Integer | No | Number of results per page. Maximum `100`. Automatically capped at 100 if exceeded. | | cursor | String | No | Pagination cursor returned from the previous response. | ## Response Parameters | Field | Type | Description | |---|---|---| | cursor | String | Cursor for the next page. Empty string if no more data | | list | Array | List of RWA token objects | | > tokenSymbol | String | Token symbol, e.g. `QQQx` | | > stockCode | String | Underlying stock/ETF ticker, e.g. `QQQ` | | > tokenName | String | Full token name, e.g. `xStocks NASDAQ 100` | | > tokenContractAddress | String | On-chain contract address | | > chainIndex | String | Chain index the token is deployed on | | > issuer | String | RWA issuer identifier, e.g. `xstocks`, `ondo` | | > logoUrl | String | URL of the token logo image | | > price | String | Token on-chain DEX price in USD. Up to 8 decimal places, e.g. `"695.98000000"`. Empty string if unavailable | | > priceChange24H | String | Token 24h price change percentage, e.g. `"-1.30"` | | > marketCap | String | Token market cap in USD (integer string), e.g. `"458170000000"` | | > volume24h | String | Token 24h on-chain DEX trading volume in USD (integer string) | | > stockPrice | String | Underlying asset price on the securities exchange in USD, updated every 15s. Returns the most recent closing price during non-trading hours | | > stockPriceChange24H | String | Underlying asset 24h price change percentage | | > stockMarketCap | String | Underlying company/ETF total market cap on traditional markets in USD (integer string) | | > stockVolume24h | String | Underlying asset 24h trading volume on the securities exchange in USD (integer string). Returns `"0"` on non-trading days | | > peRatioTTM | String | Price-to-Earnings ratio (Trailing Twelve Months). Empty string if not applicable (e.g. leveraged ETFs) | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/rwa/tokens?chainIndex=1&issuer=36&category=47' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2026-06-10T12:00:00.000Z' ``` ## Response Example ```json { "code": "0", "data": { "cursor": "Mg==", "list": [ { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x1aad217b8f78dba5e6693460e8470f8b1a3977f3-999/type=webp_90_0?v=1781068702740", "marketCap": "9036305.5653875194969075", "peRatioTTM": "0.34", "price": "87.575125", "priceChange24H": "-2.15", "stockCode": "STRCx", "stockMarketCap": "9036305.5653875194969075", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "2465258.568", "tokenContractAddress": "0x1aad217b8f78dba5e6693460e8470f8b1a3977f3", "tokenName": "STRCx", "tokenSymbol": "STRCx", "tokenToAssetRatio": "1.05182", "volume24h": "288983.047681" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x68fa48b1c2fe52b3d776e1953e0e782b5044ce28-900/type=webp_90_0?v=1781680643677", "marketCap": "344346290", "peRatioTTM": "38.75", "price": "148.425125", "priceChange24H": "-16.55", "stockCode": "SPCXx", "stockMarketCap": "344346290", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "549176262.162", "tokenContractAddress": "0x68fa48b1c2fe52b3d776e1953e0e782b5044ce28", "tokenName": "SPCXx", "tokenSymbol": "SPCXx", "tokenToAssetRatio": "1", "volume24h": "53876.53328343472" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xae2f842ef90c0d5213259ab82639d5bbf649b08e-900/type=webp_90_0?v=1781680669173", "marketCap": "1057251.875", "peRatioTTM": "7.52", "price": "105.7251875", "priceChange24H": "-6.61", "stockCode": "MSTRx", "stockMarketCap": "1057251.875", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "41828930.832", "tokenContractAddress": "0xae2f842ef90c0d5213259ab82639d5bbf649b08e", "tokenName": "MSTRx", "tokenSymbol": "MSTRx", "tokenToAssetRatio": "1", "volume24h": "28083.7568702753707684" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xc845b2894dbddd03858fd2d643b4ef725fe0849d-900/type=webp_90_0?v=1781680661478", "marketCap": "2022934.24447707694161883", "peRatioTTM": "31.97", "price": "202.28011", "priceChange24H": "-3.43", "stockCode": "NVDAx", "stockMarketCap": "2022934.24447707694161883", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "271379755", "tokenContractAddress": "0xc845b2894dbddd03858fd2d643b4ef725fe0849d", "tokenName": "NVDAx", "tokenSymbol": "NVDAx", "tokenToAssetRatio": "1.000918", "volume24h": "13303.71408255378" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x8ad3c73f833d3f9a523ab01476625f269aeb7cf0-900/type=webp_90_0?v=1781680655950", "marketCap": "3924801.3", "peRatioTTM": "389.47", "price": "392.48013", "priceChange24H": "-0.36", "stockCode": "TSLAx", "stockMarketCap": "3924801.3", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "176020427.04", "tokenContractAddress": "0x8ad3c73f833d3f9a523ab01476625f269aeb7cf0", "tokenName": "TSLAx", "tokenSymbol": "TSLAx", "tokenToAssetRatio": "1", "volume24h": "6195.3086437643" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xa753a7395cae905cd615da0b82a53e0560f250af-900/type=webp_90_0?v=1781680648008", "marketCap": "7205240.97017330535660899", "peRatioTTM": "", "price": "718.325045", "priceChange24H": "-2.84", "stockCode": "QQQx", "stockMarketCap": "7205240.97017330535660899", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "492846090.765", "tokenContractAddress": "0xa753a7395cae905cd615da0b82a53e0560f250af", "tokenName": "QQQx", "tokenSymbol": "QQQx", "tokenToAssetRatio": "1.002725", "volume24h": "3244.19372263876" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xfdddb57878ef9d6f681ec4381dcb626b9e69ac86-999/type=webp_90_0?v=1780976145982", "marketCap": "760358.92794771285518", "peRatioTTM": "", "price": "75.99001", "priceChange24H": "-8.5", "stockCode": "TQQQx", "stockMarketCap": "760358.92794771285518", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "260233502.994", "tokenContractAddress": "0xfdddb57878ef9d6f681ec4381dcb626b9e69ac86", "tokenName": "TQQQx", "tokenSymbol": "TQQQx", "tokenToAssetRatio": "2.005746", "volume24h": "2000" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x90a2a4c76b5d8c0bc892a69ea28aa775a8f2dd48-900/type=webp_90_0?v=1781680665697", "marketCap": "7373898.035491222782891535", "peRatioTTM": "", "price": "733.785035", "priceChange24H": "-1.61", "stockCode": "SPYx", "stockMarketCap": "7373898.035491222782891535", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "193143705.156", "tokenContractAddress": "0x90a2a4c76b5d8c0bc892a69ea28aa775a8f2dd48", "tokenName": "SPYx", "tokenSymbol": "SPYx", "tokenToAssetRatio": "1.005714", "volume24h": "812.714293" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xeaad46f4146ded5a47b55aa7f6c48c191deaec88-900/type=webp_90_0?v=1781680627266", "marketCap": "2830541.8166455498617325", "peRatioTTM": "107.53", "price": "282.9056075", "priceChange24H": "-9.95", "stockCode": "MRVLx", "stockMarketCap": "2830541.8166455498617325", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "258208505.574", "tokenContractAddress": "0xeaad46f4146ded5a47b55aa7f6c48c191deaec88", "tokenName": "MRVLx", "tokenSymbol": "MRVLx", "tokenToAssetRatio": "1.001492", "volume24h": "515.2316" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xe92f673ca36c5e2efd2de7628f815f84807e803f-900/type=webp_90_0?v=1781680631310", "marketCap": "3397396.45819780301552739", "peRatioTTM": "28.03", "price": "339.395085", "priceChange24H": "-6.27", "stockCode": "GOOGLx", "stockMarketCap": "3397396.45819780301552739", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "155897412.87", "tokenContractAddress": "0xe92f673ca36c5e2efd2de7628f815f84807e803f", "tokenName": "GOOGLx", "tokenSymbol": "GOOGLx", "tokenToAssetRatio": "1.001926", "volume24h": "223.966858" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x9d275685dc284c8eb1c79f6aba7a63dc75ec890a-900/type=webp_90_0?v=1781680642154", "marketCap": "2953756.147341836271855", "peRatioTTM": "35.71", "price": "295.195205", "priceChange24H": "-0.49", "stockCode": "AAPLx", "stockMarketCap": "2953756.147341836271855", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "59998189.9", "tokenContractAddress": "0x9d275685dc284c8eb1c79f6aba7a63dc75ec890a", "tokenName": "AAPLx", "tokenSymbol": "AAPLx", "tokenToAssetRatio": "1.002664", "volume24h": "137.158167" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x17d8186ed8f68059124190d147174d0f6697dc40-900/type=webp_90_0?v=1781680624758", "marketCap": "1187707.929404849315051402", "peRatioTTM": "31.48", "price": "116.0857275", "priceChange24H": "2.64", "stockCode": "MRKx", "stockMarketCap": "1187707.929404849315051402", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "491047.56", "tokenContractAddress": "0x17d8186ed8f68059124190d147174d0f6697dc40", "tokenName": "MRKx", "tokenSymbol": "MRKx", "tokenToAssetRatio": "1.021662", "volume24h": "44.914862" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x5d642505fe1a28897eb3baba665f454755d8daa2-900/type=webp_90_0?v=1781680631171", "marketCap": "1792462.76096783000485", "peRatioTTM": "186.97", "price": "178.5550675", "priceChange24H": "2.17", "stockCode": "AZNx", "stockMarketCap": "1792462.76096783000485", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "448263.798", "tokenContractAddress": "0x5d642505fe1a28897eb3baba665f454755d8daa2", "tokenName": "AZNx", "tokenSymbol": "AZNx", "tokenToAssetRatio": "0.507794", "volume24h": "39.851623" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xe5f6d3b2405abdfe6f660e63202b25d23763160d-900/type=webp_90_0?v=1781680661600", "marketCap": "211014.8466230269228", "peRatioTTM": "12.65", "price": "20.990045", "priceChange24H": "-2.25", "stockCode": "GMEx", "stockMarketCap": "211014.8466230269228", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "565786.845", "tokenContractAddress": "0xe5f6d3b2405abdfe6f660e63202b25d23763160d", "tokenName": "GMEx", "tokenSymbol": "GMEx", "tokenToAssetRatio": "1.005309", "volume24h": "35.658899" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x6d482cec5f9dd1f05ccee9fd3ff79b246170f8e2-900/type=webp_90_0?v=1781680646049", "marketCap": "1189201.2", "peRatioTTM": "134.99", "price": "118.92012", "priceChange24H": "-6.57", "stockCode": "PLTRx", "stockMarketCap": "1189201.2", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "60542972.1", "tokenContractAddress": "0x6d482cec5f9dd1f05ccee9fd3ff79b246170f8e2", "tokenName": "PLTRx", "tokenSymbol": "PLTRx", "tokenToAssetRatio": "1", "volume24h": "31.370976" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xf8a80d1cb9cfd70d03d655d9df42339846f3b3c8-900/type=webp_90_0?v=1781680672020", "marketCap": "1297401.8", "peRatioTTM": "-957.6", "price": "129.74018", "priceChange24H": "-6.81", "stockCode": "INTCx", "stockMarketCap": "1297401.8", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "328701898.232", "tokenContractAddress": "0xf8a80d1cb9cfd70d03d655d9df42339846f3b3c8", "tokenName": "INTCx", "tokenSymbol": "INTCx", "tokenToAssetRatio": "1", "volume24h": "17.196211" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x5621737f42dae558b81269fcb9e9e70c19aa6b35-900/type=webp_90_0?v=1781680659312", "marketCap": "3711990.6367674173017023", "peRatioTTM": "22.51", "price": "370.4001", "priceChange24H": "-2.55", "stockCode": "MSFTx", "stockMarketCap": "3711990.6367674173017023", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "109826352.009", "tokenContractAddress": "0x5621737f42dae558b81269fcb9e9e70c19aa6b35", "tokenName": "MSFTx", "tokenSymbol": "MSFTx", "tokenToAssetRatio": "1.004582", "volume24h": "17.194167" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0xa6a65ac27e76cd53cb790473e4345c46e5ebf961-900/type=webp_90_0?v=1781680627143", "marketCap": "7360015", "peRatioTTM": "24.36", "price": "73.60015", "priceChange24H": "-4.99", "stockCode": "NFLXx", "stockMarketCap": "7360015", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "19539905.56", "tokenContractAddress": "0xa6a65ac27e76cd53cb790473e4345c46e5ebf961", "tokenName": "NFLXx", "tokenSymbol": "NFLXx", "tokenToAssetRatio": "10", "volume24h": "5.470252" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x80a77a372c1e12accda84299492f404902e2da67-900/type=webp_90_0?v=1781680677423", "marketCap": "2753429.5785673945098264", "peRatioTTM": "22.81", "price": "273.30045", "priceChange24H": "-1.99", "stockCode": "MCDx", "stockMarketCap": "2753429.5785673945098264", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "3523159.25", "tokenContractAddress": "0x80a77a372c1e12accda84299492f404902e2da67", "tokenName": "MCDx", "tokenSymbol": "MCDx", "tokenToAssetRatio": "1.01616", "volume24h": "5.205817" }, { "chainIndex": "1", "issuer": "xStock", "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/pre/large/1-0x3557ba345b01efa20a1bddc61f573bfd87195081-900/type=webp_90_0?v=1781680680486", "marketCap": "2306503.5", "peRatioTTM": "28.95", "price": "230.65035", "priceChange24H": "-4.76", "stockCode": "AMZNx", "stockMarketCap": "2306503.5", "stockPrice": "", "stockPriceChange24H": "", "stockVolume24h": "57435551.83", "tokenContractAddress": "0x3557ba345b01efa20a1bddc61f573bfd87195081", "tokenName": "AMZNx", "tokenSymbol": "AMZNx", "tokenToAssetRatio": "1", "volume24h": "5.059902" } ] }, "msg": "" } ``` - [Token Search](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-search.md) {/* api-page */} # Token Search Search tokens by token name, symbol or token contract address. For token name or symbol search, return maximum 100 results by relevance.For token contract address, return the exact match result. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/token/search` ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | chains | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | search | String | Yes | Search for token keywords, token address or token symbol | | cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request | | limit | String | No | Number of records per page, max 100 | ## Response Parameters | Parameter | Type | Description | |---------------------- |--------- |--------------------------------------------------------------------------------------------- | | chainIndex | String | Unique identifier of the chain. (Such as 1: Ethereum, for more see the list of [chainIndex](../home/supported-chain) ) | | cursor | String | Pagination cursor | | tokenName | String | Token name | | tokenSymbol | String | Token identification | | tokenLogoUrl | String | Token icon url | | tokenContractAddress | String | Token contract address | | decimal | String | Token precision | | explorerUrl | String | Token Browser link | | change | String | 24H price change ratio | | holders | String | Number of holders | | liquidity | String | Token liquidity (24h) | | marketCap | String | Token market cap | | price | String | Price | | tagList | Object | Label | | >communityRecognized | Boolean | True means it's listed in the Top 10 CEX or is community verifed | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/search?chains=1,10&search=weth' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "chainIndex": "501", "change": "6.59", "decimal": "8", "explorerUrl": "https://web3.okx.com/explorer/solana/token/XsDoVfqeBukxuZHWhdvWHBhgEHjGNst4MLodqsJHzoB", "holders": "22447", "liquidity": "3492546.00711048141155477039737838", "marketCap": "51095303.595316825571569398", "price": "381.228119807066217995", "tagList": { "communityRecognized": true }, "tokenContractAddress": "XsDoVfqeBukxuZHWhdvWHBhgEHjGNst4MLodqsJHzoB", "tokenLogoUrl": "https://static.oklink.com/cdn/web3/currency/token/large/501-XsDoVfqeBukxuZHWhdvWHBhgEHjGNst4MLodqsJHzoB-900/type=default_90_0?v=1771926275192", "tokenName": "Tesla xStock", "tokenSymbol": "TSLAx", "cursor": "0" }, { "chainIndex": "501", "change": "6.19", "decimal": "9", "explorerUrl": "https://web3.okx.com/explorer/solana/token/KeGv7bsfR4MheC1CkmnAVceoApjrkvBhHYjWb67ondo", "holders": "133", "liquidity": "", "marketCap": "7747.288131154003818", "price": "380.833333", "tagList": { "communityRecognized": true }, "tokenContractAddress": "KeGv7bsfR4MheC1CkmnAVceoApjrkvBhHYjWb67ondo", "tokenLogoUrl": "https://static.oklink.com/cdn/web3/currency/token/large/501-KeGv7bsfR4MheC1CkmnAVceoApjrkvBhHYjWb67ondo-900/type=default_90_0?v=1774296033373", "tokenName": "Tesla (Ondo Tokenized)", "tokenSymbol": "TSLAon", "cursor": "1" } ], "msg": "" } ``` - [Token Basic Information](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-basic-info.md) {/* api-page */} # Token Basic Information Retrieve the basic token information of the specified token contract address ## Request URL POST `https://web3.okx.com/api/v6/dex/market/token/basic-info` ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | tokenContractAddress | String | Yes | Token contract address (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Parameter | Type | Description | |---------------------- |--------- |-------------------------------------------------------------------------------------------- | | chainIndex | String | Unique identifier of the chain. (Such as 1: Ethereum, for more see the list of [chainIndex](../home/supported-chain) ) | | tokenName | String | Token name | | tokenSymbol | String | Token identification | | tokenLogoUrl | String | Token icon url | | decimal | String | Token precision | | tagList | Object | Label | | >communityRecognized | Boolean | True means it's listed in the Top 10 CEX or is community verifed | ## Request Example ```shell curl --location --request POST 'https://web3.okx.com/api/v6/dex/market/token/basic-info' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \ --data-raw '[ { "chainIndex": "501", "tokenContractAddress": "5mbK36SZ7J19An8jFochhQS4of8g6BwUjbeCSxBSoWdp" }, { "chainIndex": "501", "tokenContractAddress": "eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump" } ]' ``` ## Response Example ```json { "code": "0", "data": [ { "chainIndex": "501", "decimal": "6", "tagList": { "communityRecognized": true }, "tokenContractAddress": "5mbK36SZ7J19An8jFochhQS4of8g6BwUjbeCSxBSoWdp", "tokenLogoUrl": "https://static.oklink.com/cdn/web3/currency/token/small/501-5mbK36SZ7J19An8jFochhQS4of8g6BwUjbeCSxBSoWdp-106?v=1749146943562", "tokenName": "michi", "tokenSymbol": "$michi" }, { "chainIndex": "501", "decimal": "6", "tagList": { "communityRecognized": true }, "tokenContractAddress": "eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump", "tokenLogoUrl": "https://static.oklink.com/cdn/web3/currency/token/large/501-eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump-108/type=default_90_0?v=1755815305433", "tokenName": "Unicorn Fart Dust", "tokenSymbol": "UFD" } ], "msg": "" } ``` - [Token Advanced Information](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-advanced-info.md) {/* api-page */} # Token Advanced Information Obtain advanced information about the specified token contract address ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/advanced-info` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain. For example: `1`: Ethereum. | | tokenContractAddress | String | Yes | Token contract address (e.g. 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Field | Type | Description | |---|---|---| | totalFee | String | Total fees include priority fees and tip fees | | lpBurnedPercent | String | Liquidity pool burned percentage | | isInternal | Boolean | Whether it is an internal token | | protocolId | String | Protocol ID | | progress | String | Internal token launch progress | | stockProfile | Object | Underlying stock company profile. Only present for stock-type RWA tokens| | >stockCode | String | Stock ticker symbol, e.g. `"MU"`, `"QQQ"` | | >companyName | String | Company or fund name | | >industry | String | Industry classification | | >stockType | String | Type of security, e.g. `"Common Stock"`, `"ETF"` | | >listingDate | String | Listing date in `YYYY-MM-DD` format | | >exchange | String | Listing exchange, e.g. `"Nasdaq"` | | tokenTags | Array | Token tags: can be empty, or return one or more of the following | | >rwaXstock| String | xstocks rwa token | | >rwaOndo| String | ondo rwa token | | >rwaOndoStatusPreMarket | String | Ondo RWA market status: Pre-Market. Trading takes place before the market opens, typically with lower trading volume and higher volatility. | | >rwaOndoStatusRegular | String | Ondo RWA market status: Market Hours. The primary trading session with the highest trading volume and liquidity, where prices most closely reflect real-time market conditions. | | >rwaOndoStatusPostmarket | String | Ondo RWA market status: After Hours. After-hours trading allows investors to react to earnings reports, mergers, and other news, but liquidity is lower and volatility is higher. | | >rwaOndoStatusOvernight | String | Ondo RWA market status: Overnight. Overnight trading provides near 24/5 trading opportunities, but with lower liquidity, higher volatility, and greater sensitivity to global events. | | >rwaOndoStatusClosed | String | Ondo RWA market status: Market Closed. The underlying stock is not tradable during certain periods (such as weekends), and token prices may experience significant fluctuations. | | >rwaOndoStatusPaused | String | Ondo RWA market status: Trading Halted. Trading of the underlying stock has been temporarily suspended, and token prices may experience significant fluctuations. | | >honeypot | String | Honeypot | | >dexBoost | String | Boost activity | | >lowLiquidity | String | Low liquidity | | >communityRecognized | String | Community recognized | | >devHoldingStatusSell | String | Developers sold | | >devHoldingStatusSellAll | String | Developers sold all | | >devHoldingStatusBuy | String | Developers buy more | | >initialHighLiquidity | String | High initial liquidity | | >smartMoneyBuy | String | Smart money buy | | >devAddLiquidity | String | Developers add liquidity | | >devBurnToken | String | Developers burn tokens | | >volumeChangeRateHoldersPlunge | String | Trading volume plummeted | | >holdersChangeRateHoldersSurge | String | The number of holding addresses has increased sharply | | >dexScreenerTokenCommunityTakeOver | String | Community takeover | | >dexScreenerPaid | String | Paid on DEX Screener | | createTime | String | Token creation time | | creatorAddress | String | Creator address | | devRugPullTokenCount | String | The number of Rug Pull tokens created by the developer | | devCreateTokenCount | String | Total number of tokens created by developers | | devLaunchedTokenCount | String | Developer created tokens in the number of migrated | | riskControlLevel | String | Risk control level: `0`=undefined, `1`=low, `2`=medium, `3`=medium high, `4`=high, `5`=high (manual configuration) | | top10HoldPercent | String | Position percent of Top 10 Holders | | devHoldingPercent | String | Developer position percent | | bundleHoldingPercent | String | Bundle position percent | | suspiciousHoldingPercent | String | Suspicious address position percent | | sniperHoldingPercent | String | Sniper position percent | | snipersClearAddressCount | String | Number of Sniper Clearance Addresses | | snipersTotal | String | Total number of snipers | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/advanced-info?chainIndex=501&tokenContractAddress=EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ### RWA Token ```json { "code": "0", "data": { "bundleHoldingPercent": "", "chainIndex": "1", "createTime": "", "creatorAddress": "", "devCreateTokenCount": "", "devHoldingPercent": "", "devLaunchedTokenCount": "0", "devRugPullTokenCount": "", "isInternal": false, "lpBurnedPercent": "", "progress": "", "protocolId": "", "riskControlLevel": "1", "sniperHoldingPercent": "", "snipersClearAddressCount": "", "snipersTotal": "", "stockProfile": { "companyName": "Micron Technology, Inc.", "exchange": "Nasdaq", "industry": "Technology", "listingDate": "1984-05-31", "stockCode": "MU", "stockType": "普通股" }, "suspiciousHoldingPercent": "", "tokenContractAddress": "0x050362ab1072cb2ce74d74770e22a3203ad04ee5", "tokenTags": [ "dexBoost", "rwaOndoStatusOvernight", "rwaOndo" ], "top10HoldPercent": "92.3947", "totalFee": "" }, "msg": "" } ``` ### General Token ```json { "code": "0", "data": { "bundleHoldingPercent": "", "chainIndex": "501", "createTime": "1729231507000", "creatorAddress": "HyYNVYmnFmi87NsQqWzLJhUTPBKQUfgfhdbBa554nMFF", "devCreateTokenCount": "480", "devHoldingPercent": "", "devLaunchedTokenCount": "", "devRugPullTokenCount": "26", "isInternal": false, "lpBurnedPercent": "74.3609957824270349103361582217", "progress": "", "protocolId": "120596", "riskControlLevel": "1", "sniperHoldingPercent": "", "snipersClearAddressCount": "", "snipersTotal": "", "suspiciousHoldingPercent": "", "tokenContractAddress": "9BB6NFEcjBCtnNLFko2FqVQBq8HHM13kCyYcdQbgpump", "tokenTags": [ "dexBoost", "communityRecognized", "devHoldingStatusSellAll", "smartMoneyBuy" ], "top10HoldPercent": "13.6832", "totalFee": "2180.105145301" }, "msg": "" } ``` - [Token Liquidity Pool Information](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-top-liquidity.md) {/* api-page */} # Token Liquidity Pool Information Support viewing pool information of the top 5 liquidity ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/top-liquidity` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain. For example: `1`: Ethereum. | | tokenContractAddress | String | Yes | Token contract address (e.g. 0x382bb369d343125bfb2117af9c149795c6c65c50) | ## Response Parameters | Field | Type | Description | |---|---|---| | pool | String | Funding pool, e.g. Punch/SOL | | protocolName | String | Agreement name | | liquidityUsd | String | Liquidity value | | liquidityAmount | Array | Quantity of liquidity | | >tokenAmount | String | Token amount in liquidity pool | | >tokenSymbol | String | Token name in liquidity pool | | liquidityProviderFeePercent | String | Liquidity provider fee percentage | | poolAddress | String | Pool address | | poolCreator | String | Pool creator | ## Request Example ```shell curl --location 'https://web3pre.okex.org/api/v6/dex/market/token/liquidity?chainIndex=8453&tokenContractAddress=0x1f16e03c1a5908818f47f6ee7bb16690b40d0671' \ --header 'Cookie: locale=en-US' ``` ## Response Example ```json { "code": "0", "data": [ { "liquidityAmount": [ { "tokenAmount": "4347613.0508917095", "tokenSymbol": "RECALL" }, { "tokenAmount": "142351.302373", "tokenSymbol": "USDC" } ], "liquidityProviderFeePercent": "0.06%", "liquidityUsd": "344879.7538226645330963352547001735", "pool": "RECALL/USDC", "poolAddress": "0x5e3791f68ebceac82788f3becab154c15141a2f4", "poolCreator": "0xee4bbf067ce361b75e8f31fd2fe726caba757a67", "protocolName": "Aerodrome" }, { "liquidityAmount": [ { "tokenAmount": "1627239.5672854523", "tokenSymbol": "RECALL" }, { "tokenAmount": "25.183845099309004", "tokenSymbol": "WETH" } ], "liquidityProviderFeePercent": "0.30%", "liquidityUsd": "126390.2349541208658853815306505521", "pool": "RECALL/WETH", "poolAddress": "0x6ee714d6d8df7662bca805f58cc1d5a8886d78eb", "poolCreator": "0xee4bbf067ce361b75e8f31fd2fe726caba757a67", "protocolName": "Aerodrome" } ], "msg": "" } ``` - [Token Trading Information](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-price-info.md) {/* api-page */} # Token Trading Information Return token trading information including price, volume, trading info, supply, holders, liquidity etc at specific timestamp, support max 100 multiple tokens query. ## Request URL POST `https://web3.okx.com/api/v6/dex/market/price-info` ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382b...5c50) | ## Response Parameters | Parameter | Type | Description | |---------------------- |-------- |-------------------------------------------------------------------------------------------- | | chainIndex | String | Unique identifier of the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain) | | tokenContractAddress | String | Token contract address | | time | String | Price timestamp, using Unix Millisecond timestamp format | | price | String | Latest token price | | marketCap | String | Token market cap | | priceChange5M | String | Price changes within 5 minutes, in percentage increase or decrease | | priceChange1H | String | Price changes within one hour, expressed as a percentage increase or decrease | | priceChange4H | String | Price changes within 4 hours, expressed as a percentage increase or decrease | | priceChange24H | String | Price changes within 24 hours, expressed as a percentage increase or decrease | | volume5M | String | Trading volume within 5 minutes | | volume1H | String | Trading volume within 1 hour | | volume4H | String | Trading volume within 4 hours | | volume24H | String | Trading volume within 24 hours | | txs5M | String | Token transactions within 5 minutes | | txs1H | String | Token transactions within 1 hour | | txs4H | String | Token transactions within 4 hours | | txs24H | String | Number of token transactions within 24 hours | | maxPrice | String | Token 24h highest price | | tradeNum | String | 24H token trading quantity | | minPrice | String | Token 24h lowest price | | circSupply | String | Token circulation supply | | liquidity | String | Liquidity in the token pool | | holders | String | Number of token holding addresses | ## Request Example ```shell curl --location --request POST 'https://web3.okx.com/api/v6/dex/market/price-info' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \ --data-raw '[ { "chainIndex": "501", "tokenContractAddress": "5mbK36SZ7J19An8jFochhQS4of8g6BwUjbeCSxBSoWdp" }, { "chainIndex": "501", "tokenContractAddress": "eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump" } ]' ``` ## Response Example ```json { "code": "0", "data": [ { "chainIndex": "501", "circSupply": "555761678.7348550000", "holders": "46998", "liquidity": "2909733.283759244562509712218832656", "marketCap": "12252728.212049527112081409", "maxPrice": "0.023000175796511334", "minPrice": "0.021290716539724027", "price": "0.022046730965585534", "priceChange1H": "-1.24", "priceChange24H": "-1.8", "priceChange4H": "-2.64", "priceChange5M": "0.22", "time": "1756816961600", "tokenContractAddress": "5mbK36SZ7J19An8jFochhQS4of8g6BwUjbeCSxBSoWdp", "tradeNum": "9577269.994247", "txs1H": "27664", "txs24H": "127879", "txs4H": "108489", "txs5M": "2265", "volume1H": "7376.6139697593500223", "volume24H": "213047.96235814982022456", "volume4H": "33943.03136454470008366", "volume5M": "544.69701090069000181" }, { "chainIndex": "501", "circSupply": "999973538.9201610000", "holders": "37302", "liquidity": "2946946.965800864848335614721052390", "marketCap": "25792746.281014184438384254", "maxPrice": "0.026539875867707924", "minPrice": "0.02427728431412691", "price": "0.025793428802993062", "priceChange1H": "-1.13", "priceChange24H": "3.4", "priceChange4H": "-2.07", "priceChange5M": "0.52", "time": "1756816961600", "tokenContractAddress": "eL5fUxj2J4CiQsmW85k5FG9DvuQjjUoBHoQBi2Kpump", "tradeNum": "10046562.105494", "txs1H": "166", "txs24H": "2888", "txs4H": "322", "txs5M": "29", "volume1H": "10343.0564689259900202", "volume24H": "253496.67765782958052983", "volume4H": "21530.5160926891601342", "volume5M": "3278.85450250897" } ], "msg": "" } ``` - [Get Tokens Trades Activity](https://web3pre.okex.org/onchainos/dev-docs/market/market-trades.md) {/* api-page */} # Get Tokens Trades Activity Retrieve the recent transactions of a token. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/trades` ## Request Parameters | Parameter | Type | Required | Description | |------------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | tokenContractAddress | String | Yes | Token contract address,for EVM please pass all-lowercase addresses (e.g., 0x382bb369d343125bfb2117af9c149795c6c65c50) | | after | String | No | Pagination of data to return records earlier than the requested id. | | limit | String | No | Number of results per request. The maximum is 500 and default is 100. | | tagFilter | String | No | Default: do not enter
Enter 1: Return the holding address labeled KOL.
Enter 2: Return the token address labeled Developer
Enter 3: Return the holding address labeled Smart Money
Enter 4: Return the holding address labeled as Whale
Enter 5: Return the holding address labeled New Wallet
Enter 6: Return the holding address labeled Suspicious
Enter 7: Return the holding address labeled Sniper
Enter 8: Return the holding address labeled as Suspected phishing.
Enter 9: Return the holding address labeled Bundle | | walletAddressFilter | String | No | Query history for multiple addresses. Enter multiple addresses, separated by commas, up to 10 | ## Response Parameters | Parameter | Type | Description | |-----------------|--------|-----------------------------------------------------------------------------------------------------------------------| | id | String | Unique trade id | | chainIndex | String | Unique identifier for the chain. (e.g., 1 for Ethereum. See [ChainIndex](../home/supported-chain)) | | tokenContractAddress | String | Token contract address | | txHashUrl | String | On-chain txhash of the transactions | | userAddress | String | Authorizer of the transaction | | dexName | String | Name of the dex where the trade occured | | poolLogoUrl | String | Pool logo url | | type | String | trade Type. `buy` `sell` | | changedTokenInfo | String | exchanged info | | > amount | String | token exchanged amount in this trade | | > tokenSymbol | String | Token symbol | | > tokenContractAddress | String | Token contract address | | price | String | Latest token price | | volume | String | USD value of this trade | | time | String | Timestamp of the price, Unix timestamp format in milliseconds | | isFiltered | String | If the trade is filtered for price and k-line calculation.
`0`: not filtered `1`: filtered" | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/trades?chainIndex=501&tokenContractAddress=HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code":"0", "data":[ { "id":"1739439633000!@#120!@#14731892839", "chainIndex": "501", "tokenContractAddress": "HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC", "txHashUrl": "https://solscan.io/tx/zgDzoiVG4XuDgQcoEg9vhpRyfyk5thNUQuTeTCeF289Qec5iraeCrUzPLyiE2UCviox2ebbTcsagGvzYF7M5uqs", "userAddress": "2kCm1RHGJjeCKL4SA3ZJCLyXqUD7nEJ7GMtVaP7c6jQ8", "dexName": "Orca Whirlpools", "poolLogoUrl": "https://static.okx.com/cdn/wallet/logo/dex_orcaswap.png", "type": "sell", "changedTokenInfo": [ { "amount":"100.396595878", "tokenSymbol":"ai16z", "tokenContractAddress": "HeLp6NuQkmYB4pYWo2zYs22mESHXPQYzXbB8n4V98jwC" }, { "amount":"2.482831", "tokenSymbol":"SOL", "tokenContractAddress": "So11111111111111111111111111111111111111112" } ] "price": "26.458143090226812", "volume": "519.788163", "time": "1739439633000", "isFiltered": "0" } ], "msg":"", } ``` - [Hot Tokens](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-hot-token.md) {/* api-page */} # Hot Tokens Returns a list of tokens ranked by token score and social media mentions based on different time ranges. It can be sorted in descending order according to the specified data, and can also be filtered based on the specified data. Up to 100 results are returned. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/hot-token` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | rankingType | String | Yes | Default use trending, does not support multiple selection
4: Trending, sorting by token score
5: Xmentioned, sorting by number of mentions on Twitter
Note: Only 4 and 5, no 1, 2, 3. | | chainIndex | String | No | Default is all networks, it does not support multiple selection chain. Example: 1, Filter out the tokens of the Ethereum chain | | rankBy | String | No | Trending lists are sorted backwards by "12" by default; The Xmentioned list is sorted by default in reverse order according to "11". Sort in reverse order according to more parameters, single choice
Enter 1: token price \| Enter 2: price changes percent \| Enter 3: transactions \| Enter 4: unique traders \| Enter 5: volume(in USD) \| Enter 6: marketcap \| Enter 7: liquidity value \| Enter 8: token creation time \| Enter 9: OKX in-app search frequency \| Enter 10: number of holder \| Enter 11: mentions on social media \| Enter 12: social media scores \| Enter 14: net inflow \| Enter 15: token score | | rankingTimeFrame | String | No | Default is 1h, single choice
1: 5 minutes \| 2: 1 hour \| 3: 4 hours \| 4: 24 hours | | riskFilter | Boolean | No | Hide risk tokens, default is true. Example: true, false | | protocolId | String | No | Filter tokens by protocol ID. No protocol is selected by default, multiple options can be selected, separated by commas (For example, 120596 can filter out tokens Pump.fun protocols) | | priceChangePercentMin | String | No | Minimum price change percent | | priceChangePercentMax | String | No | Maximum price change percent | | tradeAmountMin | String | No | Minimum volume | | tradeAmountMax | String | No | Maximum volume | | volumeMin | String | No | Minimum turnover | | volumeMax | String | No | Maximum turnover | | txsMin | String | No | Minimum number of transactions | | txsMax | String | No | Maximum number of transactions | | uniqueTraderMin | String | No | Minimum number of unique trader | | uniqueTraderMax | String | No | Maximum number of unique trader | | marketCapMin | String | No | Minimum Marketcap | | marketCapMax | String | No | Maximum Marketcap | | liquidityMin | String | No | Minimum liquidity | | liquidityMax | String | No | Maximum liquidity | | stableTokenFilter | Boolean | No | Whether to filter stablecoins, the default is true. Example: true, false | | holdersMin | String | No | Minimum number of holders | | holdersMax | String | No | Maximum number of holders | | top10HoldPercentMin | String | No | Top 10 minimum holding percent | | top10HoldPercentMax | String | No | Top 10 maximum holding percent | | devHoldPercentMin | String | No | Minimum developer holding percent | | devHoldPercentMax | String | No | Maximum developer holding percent | | suspiciousHoldPercentMin | String | No | Minimum suspicious holding percent | | suspiciousHoldPercentMax | String | No | Maximum suspicious holding percent | | bundleHoldPercentMin | String | No | Minimum binding holding percent | | bundleHoldPercentMax | String | No | Maximum binding holding percent | | mentionedCountMin | String | No | Minimum number of mentions | | mentionedCountMax | String | No | Maximum number of mentions | | socialScoreMin | String | No | Minimum social score | | socialScoreMax | String | No | Maximum social score | | isLpBurnt | Boolean | No | Whether LP is burned, the default is true. Example: true, false | | isMint | Boolean | No | Whether it can be mint, the default is true. Example: true, false | | isFreeze | Boolean | No | Whether to freeze, default is true. Example: true, false | | inflowUsdMin | String | No | Minimum inflow | | inflowUsdMax | String | No | Maximum inflow | | fdvMin | String | No | FDV minimum | | fdvMax | String | No | Maximum FDV | | cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request | | limit | String | No | Number of records per page, max 100 | ## Response Parameters | Field | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain (e.g. 1: Ethereum) | | cursor | String | Pagination cursor | | tokenSymbol | String | Token symbol | | tokenLogoUrl | String | Token Icon URL | | tokenContractAddress | String | Token contract address | | marketCap | String | Marketcap (token price × circulating supply) | | volume | String | Token trading volume (in USD) | | firstTradeTime | String | Token first transaction time | | change | String | Token price change ratio | | liquidity | String | Liquidity value (in USD) | | price | String | Token price | | holders | String | Number of holder | | uniqueTraders | String | The number of unique trader | | txsBuy | String | The number of buy transactions within the specified time | | txsSell | String | Number of sell transactions within a specified time | | txs | String | Total number of transactions within a specified time | | inflowUsd | String | Net inflow | | riskLevelControl | String | Risk control level: `0`=undefined, `1`=low, `2`=medium, `3`=medium high, `4`=high, `5`=high (manual configuration) | | devHoldPercent | String | Developer position percent | | top10HoldPercent | String | Position ratio of top 10 holding addresses | | insiderHoldPercent | String | Internal trader position percent | | bundleHoldPercent | String | Bundled trader position percent | | vibeScore | String | Social media score | | mentionsCount | String | Number of mentions | ## Request Example ```shell curl --location 'https://web3pre.okex.org/api/v6/dex/market/token/hot-token?rankingType=4&category=' \ --header 'Cookie: locale=en-US' ``` ## Response Example ```json -- param limit=10&cursor=20 -- This is not deep pagination. It is in-memory pagination, with a maximum of only 100 records. The maximum cursor value is 100. { "code": "0", "data": [ { "bundleHoldPercent": "0.055471", "chainIndex": "501", "change": "124.46", "devHoldPercent": "", "firstTradeTime": "1774376729000", "holders": "3518", "inflowUsd": "48877.03736178689", "insiderHoldPercent": "", "liquidity": "656584.515776979964291925", "marketCap": "7120200.171337115253774998", "mentionsCount": "", "price": "0.007120235922518026", "riskLevelControl": "1", "tokenContractAddress": "FtSRgyCEhKTc1PPgEAXvuHN3NyiP6LS9uyB28KCN3CAP", "tokenLogoUrl": "https://static.oklink.com/cdn/web3/currency/token/large/501-FtSRgyCEhKTc1PPgEAXvuHN3NyiP6LS9uyB28KCN3CAP-109/type=default_90_0?v=1774381887925", "tokenSymbol": "CAPTCHA", "top10HoldPercent": "20.6599", "txs": "13616", "txsBuy": "6699", "txsSell": "6917", "uniqueTraders": "3508", "vibeScore": "", "volume": "2733012.43208665053", "cursor": 21 }, { "bundleHoldPercent": "0.055471", "chainIndex": "501", "change": "124.46", "devHoldPercent": "", "firstTradeTime": "1774376729000", "holders": "3518", "inflowUsd": "48877.03736178689", "insiderHoldPercent": "", "liquidity": "656584.515776979964291925", "marketCap": "7120200.171337115253774998", "mentionsCount": "", "price": "0.007120235922518026", "riskLevelControl": "1", "tokenContractAddress": "FtSRgyCEhKTc1PPgEAXvuHN3NyiP6LS9uyB28KCN3CAP", "tokenLogoUrl": "https://static.oklink.com/cdn/web3/currency/token/large/501-FtSRgyCEhKTc1PPgEAXvuHN3NyiP6LS9uyB28KCN3CAP-109/type=default_90_0?v=1774381887925", "tokenSymbol": "CAPTCHA", "top10HoldPercent": "20.6599", "txs": "13616", "txsBuy": "6699", "txsSell": "6917", "uniqueTraders": "3508", "vibeScore": "", "volume": "2733012.43208665053", "cursor": 22 } ], "msg": "" } ``` - [Token Holder Information](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-holder.md) {/* api-page */} # Token Holder Information Support viewing the addresses and corresponding position information of the top 100 holders ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/holder` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain. For example: `1`: Ethereum. | | tokenContractAddress | String | Yes | Token contract address (e.g. 0x382bb369d343125bfb2117af9c149795c6c65c50) | | tagFilter | String | No | Default: No input, return the address data of the first 100 holding coin addresses, arranged in reverse order according to the total income.
Enter 1: Return the address labeled KOL
Enter 2: Return the token address labeled Developer
Enter 3: Return the address labeled Smart Money
Enter 4: Return the holding address labeled as Whale
Enter 5: Return the address labeled New Wallet
Enter 6: Return the holding address labeled Suspicious
Enter 7: Return the holding address labeled Sniper
Enter 8: Return the address labeled as suspected phishing
Enter 9: Return the address labeled as Bundle | | cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request | | limit | String | No | Number of records per page, max 100 | ## Response Parameters | Field | Type | Description | |---|---|---| | holdPercent | String | Percentage of holdings | | cursor | String | Pagination cursor | | nativeTokenBalance | String | Mainnet currency balance | | boughtAmount | String | Total Buy Quantity | | avgBuyPrice | String | Average buying price | | totalSellAmount | String | Total sold quantity | | avgSellPrice | String | Average selling price | | totalPnlUsd | String | Total profit and loss | | realizedPnlUsd | String | Realized profit and loss | | unrealizedPnlUsd | String | Unrealized profit and loss | | fundingSource | String | Sources of funding | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/holder?chainIndex=501&tokenContractAddress=EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v&tagFilter=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json -- Not deep pagination; only supports pagination within up to 100 records returned in memory. { "code": "0", "data": [ { "avgBuyPrice": "0", "avgSellPrice": "0", "boughtAmount": "0", "fundingSource": "9k8jWWqfmTTXrc8gmZqYVxSFJhygURvyVRztivJXFTYP", "holdAmount": "767501192.534284", "holdPercent": "76.750184380179418200", "holderWalletAddress": "2RH6rUTPBJ9rUDPpuV9b8z1YL56k1tYU6Uk5ZoaEFFSK", "nativeTokenBalance": "6.091849989", "realizedPnlUsd": "0", "totalPnlUsd": "0.000000000000000000", "totalSellAmount": "0", "unrealizedPnlUsd": "0.000000000000000000", "cursor": "0" }, { "avgBuyPrice": "0", "avgSellPrice": "0", "boughtAmount": "0", "fundingSource": "5tzFkiKscXHK5ZXCGbXZxdw7gTjjD1mBwuoFbhUvuAi9", "holdAmount": "36715842.016", "holdPercent": "3.671587317143695100", "holderWalletAddress": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM", "nativeTokenBalance": "13908916.377375046", "realizedPnlUsd": "0", "totalPnlUsd": "0.000000000000000000", "totalSellAmount": "0", "unrealizedPnlUsd": "0.000000000000000000", "cursor": "1" } ], "msg": "" } ``` - [Get Cluster Supported Chain](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-cluster-supported-chain.md) {/* api-page */} # Get Cluster Supported Chain Get the supported chains ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/cluster/supported/chain` ## Request Parameters None ## Response Parameters | Field | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain | | chainName | String | Chain name | | chainLogo | String | Chain logo | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/cluster/supported/chain' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "chainIndex": "1", "chainName": "Ethereum", "chainLogo": "https://static.okx.com/cdn/wallet/logo/ETH-20220328.png" }, { "chainIndex": "501", "chainName": "Solana", "chainLogo": "https://static.okx.com/cdn/wallet/logo/SOL.png" } ], "msg": "" } ``` - [Get Token Holding Cluster Overview](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-cluster-overview.md) {/* api-page */} # Get Token Holding Cluster Overview Get the holding cluster overview data for a specified token. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/cluster/overview` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique chain identifier. Pass in the chain ID (e.g., 501 for Solana). Only supports single-chain queries | | tokenContractAddress | String | Yes | Token contract address | ## Response Parameters | Field | Type | Description | |---|---|---| | ClusterConcentration | String | Cluster concentration level: Low / Medium / High | | top100HoldingsPercent | String | Top 100 address holding percentage (%) | | rugPullPercent | String | Rug pull probability percentage (%) | | holderNewAddressPercent | String | Percentage of new addresses created within the past 3 days among the top 1000 holders (%) | | holderSameFundSourcePercent | String | Percentage of addresses among the top 1000 holders that have mutual mainstream token transactions with each other | | holderSameCreationTimePercent | String | Percentage of addresses created at the same time (%) | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/cluster/overview?chainIndex=8453&tokenContractAddress=0xfde4c96c8593536e31f229ea8f37b2ada2699bb2' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": 0, "msg": "success", "error_code": "0", "error_message": "", "detailMsg": "", "data": { "clusterConcentration": "Low", "top100HoldingsPercent": "0.68776", "rugPullPercent": "1.00000", "holderNewAddressPercent": "--", "holderSameFundSourcePercent": "0.47800", "holderSameCreationTimePercent": "0.09000" } } ``` - [Get Token Cluster List](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-cluster-list.md) {/* api-page */} # Get Token Cluster List Get the list of holding clusters for a specified token. Only includes address clusters within the top 300 holders. Limit: Returns only the top 100 clusters by holding amount ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/cluster/list` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | string | Yes | Unique chain identifier. Pass in the chain ID (e.g., 501 for Solana). Only supports single-chain queries | | tokenContractAddress | string | Yes | Token contract address | ## Response Parameters | Field | Type | Description | |---|---|---| | clustList | array | Cluster list | | > holdingAmount | string | Total token holdings of cluster addresses (excluding black holes and liquidity pool addresses) | | > holdingValueUsd | string | Total USD value of token holdings of cluster addresses (excluding black holes and liquidity pool addresses) | | > holdingPercent | string | Percentage of token supply held by cluster addresses | | > trendType | Array | Buy/Sell/Neutral/Transfer dominant. The overall direction of cluster traders' holdings over time — increasing (buying), decreasing (selling), flat (neutral), or primarily accumulated through transfers (transfer dominant) | | > averageHoldingPeriod | string | Weighted average holding period of cluster holders | | > pnlUsd | string | Total token PnL of cluster holders | | > pnlPercent | string | Total token PnL percentage of cluster holders | | > buyVolume | string | Value of tokens bought by cluster holders | | > averageBuyPriceUsd | string | Average cost price of cluster holders | | > sellVolume | string | Value of tokens sold by cluster holders | | > averageSellPriceUsd | string | Weighted average selling price of cluster holders | | > lastActiveTimestamp | string | Last active time | | > clusterAddressList | array | List of addresses in the cluster | | >> address | string | Address | | >> holdingAmount | string | Total token holdings of cluster addresses (excluding black holes and liquidity pool addresses) | | >> holdingValueUsd | string | Total USD value of token holdings of cluster addresses (excluding black holes and liquidity pool addresses) | | >> holdingPercent | string | Percentage of token supply held by cluster addresses | | >> averageHoldingPeriod | string | Average holding period of the address | | >> lastActiveTimestamp | string | Last active time | | >> isContract | boolean | Whether it is a contract address | | >> isExchange | boolean | Whether it is an exchange address | | >> isKol | boolean | Whether it is a KOL address | | >> addressRank | string | Address holding rank | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/cluster/list?chainIndex=501&tokenContractAddress=H5b4iYiZYycr7fmQ1dMj7hdfLGAEPcDH261K4hugpump' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": 0, "msg": "success", "error_code": "0", "error_message": "", "detailMsg": "", "data": { "clusterList": [ { "holdingAmount": "161022025.9", "holdingValueUsd": "9340.1", "holdingPercent": "0.16103", "trendType": null, "averageHoldingPeriod": "1762472580", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "B6NR5XYLroBdAnKjcF2o1raKqgSdi68yGZm4jtPMmQbQ", "holdingAmount": "1.61022025886108E8", "holdingValueUsd": "9340.1", "holdingPercent": "0.16103", "averageHoldingPeriod": "1762472580", "lastActiveTimestamp": "0", "addressRank": "1", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "68259624.6", "holdingValueUsd": "3959.4", "holdingPercent": "0.06826", "trendType": [ "buy" ], "averageHoldingPeriod": "1762581923", "pnlUsd": "-9754.781914434808854181240150", "pnlPercent": "-0.23747", "buyVolume": "41078.157302747647241897599595", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "27574.107143773950192358673755", "averageSellPriceUsd": "0.0065974779", "lastActiveTimestamp": "1776700318", "clusterAddressList": [ { "address": "HXHUoSUJqdGsnaoMnPyNhMosZ87MRpy1rH1DNQoCwthD", "holdingAmount": "2.8918392154588E7", "holdingValueUsd": "1677.4", "holdingPercent": "0.02892", "averageHoldingPeriod": "1762473151", "lastActiveTimestamp": "1775809488", "addressRank": "3", "isContract": false, "isExchange": false, "isKol": false }, { "address": "AJwncKTAe6Ru3BM4ghQyqkitmC8WmyvdUHBqJNkebTdc", "holdingAmount": "1.6084821225592E7", "holdingValueUsd": "933.0", "holdingPercent": "0.01609", "averageHoldingPeriod": "1762496392", "lastActiveTimestamp": "1776700318", "addressRank": "12", "isContract": false, "isExchange": false, "isKol": false }, { "address": "3gx7exebeKchwDB23K5dqRnrnRnJy4MmpqsrpxrJJ3K1", "holdingAmount": "1.0E7", "holdingValueUsd": "580.1", "holdingPercent": "0.01000", "averageHoldingPeriod": "1762472366", "lastActiveTimestamp": "1764617616", "addressRank": "22", "isContract": false, "isExchange": false, "isKol": false }, { "address": "EeGzrqXHefjq5ykrgmXF9ja7f2cyquXzNsphe8My1K4x", "holdingAmount": "9500000.0", "holdingValueUsd": "551.1", "holdingPercent": "0.00950", "averageHoldingPeriod": "1762472464", "lastActiveTimestamp": "1768174935", "addressRank": "26", "isContract": false, "isExchange": false, "isKol": false }, { "address": "57H4zyjrKtNQKV6EujH82tyUReUJG88Czfg14cCQDxXH", "holdingAmount": "3756411.220411", "holdingValueUsd": "217.9", "holdingPercent": "0.00376", "averageHoldingPeriod": "1764354003", "lastActiveTimestamp": "1771971223", "addressRank": "50", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "46307111.7", "holdingValueUsd": "2686.1", "holdingPercent": "0.04631", "trendType": [ "buy" ], "averageHoldingPeriod": "1763969031", "pnlUsd": "-2266.017169335024681091746953", "pnlPercent": "-0.70400", "buyVolume": "3218.795471954811483730108784", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1764189988", "clusterAddressList": [ { "address": "7U6xXAHgTGykwrmXRVJg8gWViZeY3SjRsLKDMqif2t2o", "holdingAmount": "1.0E7", "holdingValueUsd": "580.1", "holdingPercent": "0.01000", "averageHoldingPeriod": "1764189988", "lastActiveTimestamp": "1764189988", "addressRank": "20", "isContract": false, "isExchange": false, "isKol": false }, { "address": "FNYzHSNM9dsv7Unhaemb9oUqc3zmqv6KBzG65EesJuo", "holdingAmount": "1.0E7", "holdingValueUsd": "580.1", "holdingPercent": "0.01000", "averageHoldingPeriod": "1763498512", "lastActiveTimestamp": "1764140515", "addressRank": "21", "isContract": false, "isExchange": false, "isKol": false }, { "address": "ExojZacYQ2UGFtMkicBRVF7QZZJ4kGxWLoF6V1CMKrxs", "holdingAmount": "9099999.999999", "holdingValueUsd": "527.8", "holdingPercent": "0.00910", "averageHoldingPeriod": "1764140625", "lastActiveTimestamp": "0", "addressRank": "28", "isContract": false, "isExchange": false, "isKol": false }, { "address": "2vmwuuYBjS3w6vPpxSVzUgsfpzD5PNkxXJxLuS1S4JDT", "holdingAmount": "9000000.0", "holdingValueUsd": "522.0", "holdingPercent": "0.00900", "averageHoldingPeriod": "1764138413", "lastActiveTimestamp": "1764140625", "addressRank": "29", "isContract": false, "isExchange": false, "isKol": false }, { "address": "2S6r6vobWWotffdDR3eg351hRu8mFXrj5Ttis9qexQcH", "holdingAmount": "7000000.0", "holdingValueUsd": "406.0", "holdingPercent": "0.00700", "averageHoldingPeriod": "1764140516", "lastActiveTimestamp": "1764140793", "addressRank": "32", "isContract": false, "isExchange": false, "isKol": false }, { "address": "uDbRjDEmrtJ99zgVPtzVfYPkbpHcNpP9VCTihFGbNN6", "holdingAmount": "1207111.654714", "holdingValueUsd": "70.0", "holdingPercent": "0.00121", "averageHoldingPeriod": "1762485575", "lastActiveTimestamp": "1762850347", "addressRank": "110", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "34112804.2", "holdingValueUsd": "1978.7", "holdingPercent": "0.03411", "trendType": [ "buy" ], "averageHoldingPeriod": "1771052259", "pnlUsd": "-11977.870843430757364018067576", "pnlPercent": "-0.17379", "buyVolume": "68922.772685790725453511547586", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "38982.124296520050313490134045", "averageSellPriceUsd": "0.0031056518", "lastActiveTimestamp": "1775745602", "clusterAddressList": [ { "address": "Hw2EHHXCYQw3QUzXXxUS9R7eYrHwGtdNv7sqzdtELyUd", "holdingAmount": "1.5669572093239E7", "holdingValueUsd": "908.9", "holdingPercent": "0.01567", "averageHoldingPeriod": "1768576893", "lastActiveTimestamp": "1773984585", "addressRank": "13", "isContract": false, "isExchange": false, "isKol": false }, { "address": "ChzzPd5bgyC1u5x7SMyFcf8ZBXa6B7TMqt16qaB5YYPy", "holdingAmount": "1.2072522701824E7", "holdingValueUsd": "700.3", "holdingPercent": "0.01207", "averageHoldingPeriod": "1775657349", "lastActiveTimestamp": "1775745602", "addressRank": "14", "isContract": false, "isExchange": false, "isKol": false }, { "address": "BEkreD7cfjEwHZyUHjWfkCPcgWodwNCYEC21DL7PsfEM", "holdingAmount": "6370709.3912", "holdingValueUsd": "369.5", "holdingPercent": "0.00637", "averageHoldingPeriod": "1768414072", "lastActiveTimestamp": "1769278533", "addressRank": "35", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "29530368.1", "holdingValueUsd": "1712.9", "holdingPercent": "0.02953", "trendType": [ "buy" ], "averageHoldingPeriod": "1767181230", "pnlUsd": "-26942.345507049061792164978726", "pnlPercent": "-0.91348", "buyVolume": "29494.172842778379889648131525", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "601.211785748540027793555277", "averageSellPriceUsd": "0.0006269555", "lastActiveTimestamp": "1776534873", "clusterAddressList": [ { "address": "HZrd9c6ag9hBtJhHQZvHeJHeZG8jYQQPVqq21U39GvyP", "holdingAmount": "2.9530368069244E7", "holdingValueUsd": "1712.9", "holdingPercent": "0.02953", "averageHoldingPeriod": "1767181230", "lastActiveTimestamp": "1776534873", "addressRank": "2", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "27855089.7", "holdingValueUsd": "1615.7", "holdingPercent": "0.02786", "trendType": [ "buy" ], "averageHoldingPeriod": "1768387385", "pnlUsd": "-5500.824306479151834885740168", "pnlPercent": "-0.10959", "buyVolume": "50194.652342598473586817845014", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "23129.926357774805414632842472", "averageSellPriceUsd": "0.0009821055", "lastActiveTimestamp": "1776829168", "clusterAddressList": [ { "address": "G2vhbPCG5jAbBjFCJnLBbGJco93r3iw1WuvmL8csvJMD", "holdingAmount": "2.5E7", "holdingValueUsd": "1450.1", "holdingPercent": "0.02500", "averageHoldingPeriod": "1768126522", "lastActiveTimestamp": "1776829168", "addressRank": "5", "isContract": false, "isExchange": false, "isKol": false }, { "address": "3uQrUFNKJGW599wys4WUjUusCHizrY7ooYfdUwNwZuBR", "holdingAmount": "2855089.685188", "holdingValueUsd": "165.6", "holdingPercent": "0.00286", "averageHoldingPeriod": "1770671576", "lastActiveTimestamp": "1776375241", "addressRank": "62", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "27214981.0", "holdingValueUsd": "1578.6", "holdingPercent": "0.02722", "trendType": [ "buy" ], "averageHoldingPeriod": "1767752932", "pnlUsd": "-39629.406299065384894050188123", "pnlPercent": "-0.84898", "buyVolume": "46678.860120953624778445159452", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "5470.837790479179981542263082", "averageSellPriceUsd": "0.0017888167", "lastActiveTimestamp": "1771975683", "clusterAddressList": [ { "address": "EzkPYJ9fDs2oFAgZBPMqKVKd6nU8KGDozW6dhFs31xzp", "holdingAmount": "2.7214981009401E7", "holdingValueUsd": "1578.6", "holdingPercent": "0.02722", "averageHoldingPeriod": "1767752932", "lastActiveTimestamp": "1771975683", "addressRank": "4", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "20560145.4", "holdingValueUsd": "1192.6", "holdingPercent": "0.02056", "trendType": [ "buy" ], "averageHoldingPeriod": "1765174149", "pnlUsd": "-25501.538558196199970551272920", "pnlPercent": "-0.95532", "buyVolume": "26694.138148706981527275860638", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1765297554", "clusterAddressList": [ { "address": "64U9MukooWV5ziNXx2PCmZNmktBzQoKXnKsDBLvgCQ5g", "holdingAmount": "2.0560145444995E7", "holdingValueUsd": "1192.6", "holdingPercent": "0.02056", "averageHoldingPeriod": "1765174149", "lastActiveTimestamp": "1765297554", "addressRank": "6", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "19900000.0", "holdingValueUsd": "1154.3", "holdingPercent": "0.01990", "trendType": null, "averageHoldingPeriod": "1775098563", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "DMQd4cD82JqEMA7ByDz6D3bXmP6cHJCpSsdGmCj8KziM", "holdingAmount": "1.99E7", "holdingValueUsd": "1154.3", "holdingPercent": "0.01990", "averageHoldingPeriod": "1775098563", "lastActiveTimestamp": "0", "addressRank": "7", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "19458422.8", "holdingValueUsd": "1128.7", "holdingPercent": "0.01946", "trendType": [ "buy" ], "averageHoldingPeriod": "1767100461", "pnlUsd": "-19853.931303421473952009643208", "pnlPercent": "-0.63859", "buyVolume": "31090.264241244580387610927152", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "3978.286036612460925859972517", "averageSellPriceUsd": "0.0005632785", "lastActiveTimestamp": "1776325201", "clusterAddressList": [ { "address": "6caQasnFLDWRHZv15Nr6wjrQyfBFq2XuzCVfYEzVbvVw", "holdingAmount": "1.9458422842677E7", "holdingValueUsd": "1128.7", "holdingPercent": "0.01946", "averageHoldingPeriod": "1767100461", "lastActiveTimestamp": "1776325201", "addressRank": "8", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "17110813.6", "holdingValueUsd": "992.5", "holdingPercent": "0.01711", "trendType": [ "buy" ], "averageHoldingPeriod": "1764636498", "pnlUsd": "-12182.042481212627106611896402", "pnlPercent": "-0.90116", "buyVolume": "13518.229472450978384660939101", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "865.715954879429971865148077", "averageSellPriceUsd": "0.0034266988", "lastActiveTimestamp": "1772125324", "clusterAddressList": [ { "address": "B8oq6JM6PU22UrnFnzdRcLNfWXUUbWCsyJBAZ9CyPcur", "holdingAmount": "1.7110813564051E7", "holdingValueUsd": "992.5", "holdingPercent": "0.01711", "averageHoldingPeriod": "1764636498", "lastActiveTimestamp": "1772125324", "addressRank": "9", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "16190455.5", "holdingValueUsd": "939.1", "holdingPercent": "0.01619", "trendType": [ "buy" ], "averageHoldingPeriod": "1766269960", "pnlUsd": "-31267.413493061516541468439944", "pnlPercent": "-0.97084", "buyVolume": "32206.547444913861985290837556", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1772237179", "clusterAddressList": [ { "address": "5zbQtt1q8zq1SZY4Doc6ct6PP3DhW8cx5S5z2eTcBaMj", "holdingAmount": "1.6190455530232E7", "holdingValueUsd": "939.1", "holdingPercent": "0.01619", "averageHoldingPeriod": "1766269960", "lastActiveTimestamp": "1772237179", "addressRank": "10", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "16127645.6", "holdingValueUsd": "935.5", "holdingPercent": "0.01613", "trendType": [ "buy" ], "averageHoldingPeriod": "1775380759", "pnlUsd": "-2311.649706382180394823736924", "pnlPercent": "-0.71190", "buyVolume": "3247.140345201303927270949436", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1776604018", "clusterAddressList": [ { "address": "5sMtMauZm4EyDdBzEHDA6FSdwrU4nFYeHU2q2r7D76HD", "holdingAmount": "1.6127645648708E7", "holdingValueUsd": "935.5", "holdingPercent": "0.01613", "averageHoldingPeriod": "1775380759", "lastActiveTimestamp": "1776604018", "addressRank": "11", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "11350526.5", "holdingValueUsd": "658.4", "holdingPercent": "0.01135", "trendType": [ "buy" ], "averageHoldingPeriod": "1766254669", "pnlUsd": "-37796.918024297830026119791996", "pnlPercent": "-0.43099", "buyVolume": "87697.793519040622999241064195", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "49197.736480651092202212605127", "averageSellPriceUsd": "0.0028270160", "lastActiveTimestamp": "1767478085", "clusterAddressList": [ { "address": "13VnNpb1DdLyGrVddye1W2WGgNe4iGpr7JqubdSQa4ZU", "holdingAmount": "1.1350526521627E7", "holdingValueUsd": "658.4", "holdingPercent": "0.01135", "averageHoldingPeriod": "1766254669", "lastActiveTimestamp": "1767478085", "addressRank": "15", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "10745247.8", "holdingValueUsd": "623.3", "holdingPercent": "0.01075", "trendType": [ "buy" ], "averageHoldingPeriod": "1769781262", "pnlUsd": "-2481.556046348062954422954630", "pnlPercent": "-0.86354", "buyVolume": "2873.695316611260295405191447", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1775607349", "clusterAddressList": [ { "address": "H7PKyDYaESrpuZEMcPv7wjCnSjYA5R3n4i11bRKZFB2E", "holdingAmount": "1.0745247826261E7", "holdingValueUsd": "623.3", "holdingPercent": "0.01075", "averageHoldingPeriod": "1769781262", "lastActiveTimestamp": "1775607349", "addressRank": "16", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "10361333.4", "holdingValueUsd": "601.0", "holdingPercent": "0.01036", "trendType": [ "buy" ], "averageHoldingPeriod": "1762472847", "pnlUsd": "-227.106698195180512863546624", "pnlPercent": "-0.74201", "buyVolume": "306.071394707520664203022848", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1762491316", "clusterAddressList": [ { "address": "FnkqxP5a9KQHNTD9ZB2RaaJ9HguhEgeC7E29ALrm1N9x", "holdingAmount": "1.0361333391552E7", "holdingValueUsd": "601.0", "holdingPercent": "0.01036", "averageHoldingPeriod": "1762472847", "lastActiveTimestamp": "1762491316", "addressRank": "17", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "10350348.7", "holdingValueUsd": "600.4", "holdingPercent": "0.01035", "trendType": [ "buy" ], "averageHoldingPeriod": "1769019833", "pnlUsd": "-11172.520565343336254815321373", "pnlPercent": "-0.95609", "buyVolume": "11685.640874512179860839801108", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1774621002", "clusterAddressList": [ { "address": "wyaFH4tK5CvLQjD4speAwEKaxuq29Ykttps7FzRx4Vw", "holdingAmount": "1.0350348740697E7", "holdingValueUsd": "600.4", "holdingPercent": "0.01035", "averageHoldingPeriod": "1769019833", "lastActiveTimestamp": "1774621002", "addressRank": "18", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "10224956.6", "holdingValueUsd": "593.1", "holdingPercent": "0.01023", "trendType": [ "buy" ], "averageHoldingPeriod": "1767085893", "pnlUsd": "-5009.358578749539013113930036", "pnlPercent": "-0.89414", "buyVolume": "5602.461343219809841498727893", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1776588360", "clusterAddressList": [ { "address": "86DSnpwyQybXRxBJ2iB7D6Qdf8Yvc6VAcKcQrZ7gA7JM", "holdingAmount": "1.0224956639566E7", "holdingValueUsd": "593.1", "holdingPercent": "0.01023", "averageHoldingPeriod": "1767085893", "lastActiveTimestamp": "1776588360", "addressRank": "19", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "9500000.0", "holdingValueUsd": "551.1", "holdingPercent": "0.00950", "trendType": null, "averageHoldingPeriod": "1764137262", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "2HvdqYXdNTMrc3VSN67LdwNwtbmkGAYBTqhSxdwTgpxK", "holdingAmount": "9500000.0", "holdingValueUsd": "551.1", "holdingPercent": "0.00950", "averageHoldingPeriod": "1764137262", "lastActiveTimestamp": "0", "addressRank": "23", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "9500000.0", "holdingValueUsd": "551.1", "holdingPercent": "0.00950", "trendType": null, "averageHoldingPeriod": "1762891458", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "LX5sJ7zFoc1bgLhsubth6GAGCBFB6ZXZSKgsEYZfqaE", "holdingAmount": "9500000.0", "holdingValueUsd": "551.1", "holdingPercent": "0.00950", "averageHoldingPeriod": "1762891458", "lastActiveTimestamp": "0", "addressRank": "24", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "9500000.0", "holdingValueUsd": "551.1", "holdingPercent": "0.00950", "trendType": null, "averageHoldingPeriod": "1762890942", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "93xdAAE4oD1EfTW8eSSx21tULrfobCmYbUuW5LddXVS2", "holdingAmount": "9500000.0", "holdingValueUsd": "551.1", "holdingPercent": "0.00950", "averageHoldingPeriod": "1762890942", "lastActiveTimestamp": "0", "addressRank": "25", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "9391032.7", "holdingValueUsd": "544.7", "holdingPercent": "0.00939", "trendType": [ "buy" ], "averageHoldingPeriod": "1767623802", "pnlUsd": "-11753.089152109802899125715283", "pnlPercent": "-0.33812", "buyVolume": "34760.452144587630564832241958", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "22651.588769743710306611432227", "averageSellPriceUsd": "0.0009181163", "lastActiveTimestamp": "1776807988", "clusterAddressList": [ { "address": "DEbs84PMaGotbLmTrvCsthJAy9kuVtdZ75C6H6bi77fr", "holdingAmount": "9391032.672832", "holdingValueUsd": "544.7", "holdingPercent": "0.00939", "averageHoldingPeriod": "1767623802", "lastActiveTimestamp": "1776807988", "addressRank": "27", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "8420223.1", "holdingValueUsd": "488.4", "holdingPercent": "0.00842", "trendType": [ "buy" ], "averageHoldingPeriod": "1768867554", "pnlUsd": "-10425.787200643079489887549656", "pnlPercent": "-0.95525", "buyVolume": "10914.205662395039508832787558", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1771431776", "clusterAddressList": [ { "address": "72Be2WLYnQn78Br32AQkLVJzQFYxkmFiufTveDH3Np18", "holdingAmount": "8420223.092094", "holdingValueUsd": "488.4", "holdingPercent": "0.00842", "averageHoldingPeriod": "1768867554", "lastActiveTimestamp": "1771431776", "addressRank": "30", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "7197334.3", "holdingValueUsd": "417.5", "holdingPercent": "0.00720", "trendType": [ "buy" ], "averageHoldingPeriod": "1773073177", "pnlUsd": "-3530.291863811553416418960254", "pnlPercent": "-0.89425", "buyVolume": "3947.776164138240047724727176", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1773073176", "clusterAddressList": [ { "address": "Bncwt7FrRYPfZ28ormc8ShmpRgM1nFq5eaj4U3sT5MLF", "holdingAmount": "7197334.297291", "holdingValueUsd": "417.5", "holdingPercent": "0.00720", "averageHoldingPeriod": "1773073177", "lastActiveTimestamp": "1773073176", "addressRank": "31", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "6808094.5", "holdingValueUsd": "394.9", "holdingPercent": "0.00681", "trendType": [ "buy" ], "averageHoldingPeriod": "1768287757", "pnlUsd": "-5003.032067352204965490542954", "pnlPercent": "-0.71545", "buyVolume": "6992.810715802021179857394033", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "2035.888058061769883782585196", "averageSellPriceUsd": "0.0012346389", "lastActiveTimestamp": "1772163932", "clusterAddressList": [ { "address": "36HGRif1QFQyw9qGxVA4isTgnNLnHzDvgNJifwc3DKZy", "holdingAmount": "3680263.104951", "holdingValueUsd": "213.5", "holdingPercent": "0.00368", "averageHoldingPeriod": "1767744466", "lastActiveTimestamp": "1772163932", "addressRank": "51", "isContract": false, "isExchange": false, "isKol": false }, { "address": "kzRpGND827MhPqBhQLby3UyGSeAYpTkKLyiDL8ddDQp", "holdingAmount": "3127831.429859", "holdingValueUsd": "181.4", "holdingPercent": "0.00313", "averageHoldingPeriod": "1768927003", "lastActiveTimestamp": "1770065579", "addressRank": "55", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "6561878.9", "holdingValueUsd": "380.6", "holdingPercent": "0.00656", "trendType": [ "buy" ], "averageHoldingPeriod": "1770302072", "pnlUsd": "-4487.205791717644543526137745", "pnlPercent": "-0.92181", "buyVolume": "4867.830244692020526627247756", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1774362511", "clusterAddressList": [ { "address": "Gg1SxudNLJXbkPVBmrJxezwKxcRjxUgm9i7sYYBzypuv", "holdingAmount": "6561878.920085", "holdingValueUsd": "380.6", "holdingPercent": "0.00656", "averageHoldingPeriod": "1770302072", "lastActiveTimestamp": "1774362511", "addressRank": "33", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "6474431.5", "holdingValueUsd": "375.6", "holdingPercent": "0.00647", "trendType": null, "averageHoldingPeriod": "1764140794", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "3go1eVHr7FnhkZByAnEwoxgDAo2WC2Rh9R57YUmLD2Ns", "holdingAmount": "6474431.517292", "holdingValueUsd": "375.6", "holdingPercent": "0.00647", "averageHoldingPeriod": "1764140794", "lastActiveTimestamp": "0", "addressRank": "34", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "6042070.2", "holdingValueUsd": "350.5", "holdingPercent": "0.00604", "trendType": [ "buy" ], "averageHoldingPeriod": "1767467705", "pnlUsd": "-10176.393084847104659813827005", "pnlPercent": "-0.96633", "buyVolume": "10530.944424887199548347562238", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1770603286", "clusterAddressList": [ { "address": "BfNXbMo29q2hScnkTgWEqbQu3vpNqinv7Q1yNYtJ6kaP", "holdingAmount": "5285941.573543", "holdingValueUsd": "306.6", "holdingPercent": "0.00529", "averageHoldingPeriod": "1767050141", "lastActiveTimestamp": "1770340079", "addressRank": "42", "isContract": false, "isExchange": false, "isKol": false }, { "address": "EWoyX9VbSFnPsCAJ9q84amArRJeg2EkkhudtFgxUKr8i", "holdingAmount": "756128.651238", "holdingValueUsd": "43.9", "holdingPercent": "0.00076", "averageHoldingPeriod": "1770386813", "lastActiveTimestamp": "1770603286", "addressRank": "184", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "5590281.9", "holdingValueUsd": "324.3", "holdingPercent": "0.00559", "trendType": null, "averageHoldingPeriod": "1771365174", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "9CLbrLzUfE5rjAjPvf3Due7jXyJ6ifrSq9nkVdUe9sWm", "holdingAmount": "5590281.947515", "holdingValueUsd": "324.3", "holdingPercent": "0.00559", "averageHoldingPeriod": "1771365174", "lastActiveTimestamp": "0", "addressRank": "36", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "5558648.2", "holdingValueUsd": "322.4", "holdingPercent": "0.00556", "trendType": null, "averageHoldingPeriod": "1772715898", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "4oGmweXgyEn8YTzbYe9aUwsR7RFJyGwp3R3rjonCf7Kf", "holdingAmount": "5558648.247789", "holdingValueUsd": "322.4", "holdingPercent": "0.00556", "averageHoldingPeriod": "1772715898", "lastActiveTimestamp": "0", "addressRank": "37", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "5474779.0", "holdingValueUsd": "317.6", "holdingPercent": "0.00548", "trendType": [ "buy" ], "averageHoldingPeriod": "1768836148", "pnlUsd": "-9603.073833401854419597587968", "pnlPercent": "-0.86100", "buyVolume": "11153.39089178665933610367918", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1769188203", "clusterAddressList": [ { "address": "2S4s9QysFmPFuvnSSFGhHREticURm2SEhgtXhJHyDmni", "holdingAmount": "5474779.005241", "holdingValueUsd": "317.6", "holdingPercent": "0.00548", "averageHoldingPeriod": "1768836148", "lastActiveTimestamp": "1769188203", "addressRank": "38", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "5414956.7", "holdingValueUsd": "314.1", "holdingPercent": "0.00542", "trendType": [ "buy" ], "averageHoldingPeriod": "1762638447", "pnlUsd": "-30013.470710597698399439931504", "pnlPercent": "-0.98964", "buyVolume": "30327.56747700674999223161325", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1762888479", "clusterAddressList": [ { "address": "FHHYUSmwmemGAwZvjGDZ7oh4npXbjhePbxcGZQ47aiFB", "holdingAmount": "5414956.748733", "holdingValueUsd": "314.1", "holdingPercent": "0.00542", "averageHoldingPeriod": "1762638447", "lastActiveTimestamp": "1762888479", "addressRank": "40", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "5221610.9", "holdingValueUsd": "302.9", "holdingPercent": "0.00522", "trendType": [ "buy" ], "averageHoldingPeriod": "1763334588", "pnlUsd": "-12942.318827573128183089242347", "pnlPercent": "-0.54999", "buyVolume": "23531.960044195530225796176505", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "6701.251256908549937547062394", "averageSellPriceUsd": "0.0023588322", "lastActiveTimestamp": "1772383157", "clusterAddressList": [ { "address": "9VmvmwNxHXFCj3zWE3bpiQgxy6HUpn6Qs1bpPh8xcf1g", "holdingAmount": "5221610.942069", "holdingValueUsd": "302.9", "holdingPercent": "0.00522", "averageHoldingPeriod": "1763334588", "lastActiveTimestamp": "1772383157", "addressRank": "44", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "5204618.8", "holdingValueUsd": "301.9", "holdingPercent": "0.00520", "trendType": [ "buy" ], "averageHoldingPeriod": "1762986010", "pnlUsd": "-4955.828967849365050161988914", "pnlPercent": "-0.27181", "buyVolume": "18232.616526541050352306342453", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "12974.891531020469582265317151", "averageSellPriceUsd": "0.0040896278", "lastActiveTimestamp": "1771436574", "clusterAddressList": [ { "address": "F8ShPQG92oaWm8xRD2t72a74EBcSa2BS9u4QrkhGaqXa", "holdingAmount": "3210428.834334", "holdingValueUsd": "186.2", "holdingPercent": "0.00321", "averageHoldingPeriod": "1763304131", "lastActiveTimestamp": "1769464854", "addressRank": "54", "isContract": false, "isExchange": false, "isKol": false }, { "address": "EcLkWvSRc3WWq7Qc7DYKBHzYh5UJWD4hf6UfXGaNJdHD", "holdingAmount": "1994189.956058", "holdingValueUsd": "115.7", "holdingPercent": "0.00199", "averageHoldingPeriod": "1762473870", "lastActiveTimestamp": "1771436574", "addressRank": "82", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "5171910.5", "holdingValueUsd": "300.0", "holdingPercent": "0.00517", "trendType": [ "buy" ], "averageHoldingPeriod": "1767303965", "pnlUsd": "-3152.235761591915028074393676", "pnlPercent": "-0.93673", "buyVolume": "3365.147762409169874605909091", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1771667528", "clusterAddressList": [ { "address": "3YcsfC7j7UAQkqDTdLS4bRDqXpyJS3VscExNHVH31Zgv", "holdingAmount": "5171910.521487", "holdingValueUsd": "300.0", "holdingPercent": "0.00517", "averageHoldingPeriod": "1767303965", "lastActiveTimestamp": "1771667528", "addressRank": "45", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "4928548.5", "holdingValueUsd": "285.9", "holdingPercent": "0.00493", "trendType": [ "buy" ], "averageHoldingPeriod": "1776835633", "pnlUsd": "-849.684437828459454332482627", "pnlPercent": "-0.22062", "buyVolume": "3851.293902746191657739263712", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "2715.727009228840097268092644", "averageSellPriceUsd": "0.0015868809", "lastActiveTimestamp": "1776835673", "clusterAddressList": [ { "address": "GJnb6imeA5Ha3dL9EyjSUpTrYyKkYRLxX5jDJ2coyDjQ", "holdingAmount": "2997960.701326", "holdingValueUsd": "173.9", "holdingPercent": "0.00300", "averageHoldingPeriod": "1776835633", "lastActiveTimestamp": "1776835673", "addressRank": "58", "isContract": false, "isExchange": false, "isKol": false }, { "address": "EabRRynCK47kjGEkhMTT2ysH1nMe9GVTh4R4c9k1iRHq", "holdingAmount": "1930587.753582", "holdingValueUsd": "112.0", "holdingPercent": "0.00193", "averageHoldingPeriod": "1776835633", "lastActiveTimestamp": "1776835633", "addressRank": "84", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "4331245.5", "holdingValueUsd": "251.2", "holdingPercent": "0.00433", "trendType": [ "buy" ], "averageHoldingPeriod": "1763965313", "pnlUsd": "18307.399174031206280104329252", "pnlPercent": "0.32935", "buyVolume": "55586.64158274933166844078019", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "73642.80510349586161432", "averageSellPriceUsd": "0.0016816805", "lastActiveTimestamp": "1776360199", "clusterAddressList": [ { "address": "H2JyXCF451PnHa7ct6b5BbyRxSHswnMniTF96hLbLxbR", "holdingAmount": "4331245.468807", "holdingValueUsd": "251.2", "holdingPercent": "0.00433", "averageHoldingPeriod": "1763965313", "lastActiveTimestamp": "1776360199", "addressRank": "46", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "3890000.0", "holdingValueUsd": "225.6", "holdingPercent": "0.00389", "trendType": null, "averageHoldingPeriod": "1764137322", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "6Lizkhy9Ewtjd9MPdhRJFGunc34BMLvGyDwxoPo4SU2T", "holdingAmount": "3890000.0", "holdingValueUsd": "225.6", "holdingPercent": "0.00389", "averageHoldingPeriod": "1764137322", "lastActiveTimestamp": "0", "addressRank": "47", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "3800000.0", "holdingValueUsd": "220.4", "holdingPercent": "0.00380", "trendType": null, "averageHoldingPeriod": "1764137231", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "FmeCRNVBrtBjBcQVQ94VW8S5Z7N51bEGSv8jcG7Fe9mC", "holdingAmount": "3800000.0", "holdingValueUsd": "220.4", "holdingPercent": "0.00380", "averageHoldingPeriod": "1764137231", "lastActiveTimestamp": "0", "addressRank": "48", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "3800000.0", "holdingValueUsd": "220.4", "holdingPercent": "0.00380", "trendType": null, "averageHoldingPeriod": "1764137136", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "4NiJTDVc9HVRL4U9XMVV61sQhViTrTHuQabvXkN1WjeU", "holdingAmount": "3800000.0", "holdingValueUsd": "220.4", "holdingPercent": "0.00380", "averageHoldingPeriod": "1764137136", "lastActiveTimestamp": "0", "addressRank": "49", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "3570493.2", "holdingValueUsd": "207.1", "holdingPercent": "0.00357", "trendType": null, "averageHoldingPeriod": "1762473417", "pnlUsd": "-168.869874092211974923140290", "pnlPercent": "-0.71556", "buyVolume": "235.996609230159946910104316", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1770497191", "clusterAddressList": [ { "address": "8vEEjnpcrFd9fDcW7T8EXNQHX9upjXKnHmBEvMwafVGZ", "holdingAmount": "3570493.184231", "holdingValueUsd": "207.1", "holdingPercent": "0.00357", "averageHoldingPeriod": "1762473417", "lastActiveTimestamp": "1770497191", "addressRank": "52", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "3524363.5", "holdingValueUsd": "204.4", "holdingPercent": "0.00352", "trendType": [ "buy" ], "averageHoldingPeriod": "1762841281", "pnlUsd": "-3362.374444326923437097575847", "pnlPercent": "-0.55437", "buyVolume": "6065.203481854270487919699139", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "2490.661343832350174855386774", "averageSellPriceUsd": "0.0019498276", "lastActiveTimestamp": "1773100956", "clusterAddressList": [ { "address": "3j6K4eBuXqSZGCm1cwKyJFQ8tvX3auQuYBV6hMsdFusn", "holdingAmount": "3524363.548701", "holdingValueUsd": "204.4", "holdingPercent": "0.00352", "averageHoldingPeriod": "1762841281", "lastActiveTimestamp": "1773100956", "addressRank": "53", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "3086408.4", "holdingValueUsd": "179.0", "holdingPercent": "0.00309", "trendType": [ "buy" ], "averageHoldingPeriod": "1776504300", "pnlUsd": "-511.547035675804900344091800", "pnlPercent": "-0.44535", "buyVolume": "1148.650090717470176782006142", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "458.074682717119331920467729", "averageSellPriceUsd": "0.0002043691", "lastActiveTimestamp": "1776830173", "clusterAddressList": [ { "address": "DLR1FsZNHTYkmtwBPj28BLzJ2wuTUXKMSJrHGVDSWMuf", "holdingAmount": "3086408.383049", "holdingValueUsd": "179.0", "holdingPercent": "0.00309", "averageHoldingPeriod": "1776504300", "lastActiveTimestamp": "1776830173", "addressRank": "56", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "3010000.0", "holdingValueUsd": "174.6", "holdingPercent": "0.00301", "trendType": null, "averageHoldingPeriod": "1763181790", "pnlUsd": "0E-18", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1763181877", "clusterAddressList": [ { "address": "7yCSUJ1HqKJ26qEYxbizAu1P5C9gPDcHcPm89cKuyqjU", "holdingAmount": "3010000.0", "holdingValueUsd": "174.6", "holdingPercent": "0.00301", "averageHoldingPeriod": "1763181790", "lastActiveTimestamp": "1763181877", "addressRank": "57", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2954303.8", "holdingValueUsd": "171.4", "holdingPercent": "0.00295", "trendType": [ "buy" ], "averageHoldingPeriod": "1776255405", "pnlUsd": "-2402.714436326247850718243677", "pnlPercent": "-0.07139", "buyVolume": "33657.253069427590181867261884", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "31083.173041612575518302006722", "averageSellPriceUsd": "0.0013761808", "lastActiveTimestamp": "1776255405", "clusterAddressList": [ { "address": "82ZHw4R1Ve5puN7RwdwGf2NfRQ7d1SDtnQzmETydnHQ5", "holdingAmount": "2954303.785873", "holdingValueUsd": "171.4", "holdingPercent": "0.00295", "averageHoldingPeriod": "1776255405", "lastActiveTimestamp": "1776255405", "addressRank": "59", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2927785.6", "holdingValueUsd": "169.8", "holdingPercent": "0.00293", "trendType": [ "buy" ], "averageHoldingPeriod": "1775578939", "pnlUsd": "-411.673252612369199522541464", "pnlPercent": "-0.70795", "buyVolume": "581.500648501869384501414008", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1775578938", "clusterAddressList": [ { "address": "9WLaxNjtHd8BzkJdNaK1ik7NTT788uVCowV7TvcajYo9", "holdingAmount": "2927785.643912", "holdingValueUsd": "169.8", "holdingPercent": "0.00293", "averageHoldingPeriod": "1775578939", "lastActiveTimestamp": "1775578938", "addressRank": "60", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2882021.1", "holdingValueUsd": "167.2", "holdingPercent": "0.00288", "trendType": null, "averageHoldingPeriod": "1770769559", "pnlUsd": "-9843.683213636456708215035708", "pnlPercent": "-0.97768", "buyVolume": "10068.446204210760180253771466", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1768699358", "clusterAddressList": [ { "address": "9QRcofKBpkDPXAPHdrNUQaccu55QbKqmRoTvpnKJxeMw", "holdingAmount": "2882021.062169", "holdingValueUsd": "167.2", "holdingPercent": "0.00288", "averageHoldingPeriod": "1770769559", "lastActiveTimestamp": "1768699358", "addressRank": "61", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2720821.6", "holdingValueUsd": "157.8", "holdingPercent": "0.00272", "trendType": [ "buy" ], "averageHoldingPeriod": "1769742612", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "J2zeeBBKzcDWLghz86itf2Z9H66aiSF3vS5Hki25Ex52", "holdingAmount": "2720821.649351", "holdingValueUsd": "157.8", "holdingPercent": "0.00272", "averageHoldingPeriod": "1769742612", "lastActiveTimestamp": "0", "addressRank": "63", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2603899.5", "holdingValueUsd": "151.0", "holdingPercent": "0.00260", "trendType": [ "buy" ], "averageHoldingPeriod": "1762717059", "pnlUsd": "-3580.461872716347387023794182", "pnlPercent": "-0.89344", "buyVolume": "4007.509815027399745428682068", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1773701792", "clusterAddressList": [ { "address": "hZ9qoEqnn9Adf427UqUVT8YKYkAeYfNvz2fvfx9a52w", "holdingAmount": "2603899.497126", "holdingValueUsd": "151.0", "holdingPercent": "0.00260", "averageHoldingPeriod": "1762717059", "lastActiveTimestamp": "1773701792", "addressRank": "64", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2553086.4", "holdingValueUsd": "148.1", "holdingPercent": "0.00255", "trendType": null, "averageHoldingPeriod": "1772513462", "pnlUsd": "-1332.167564921279856934753820", "pnlPercent": "-0.89995", "buyVolume": "1480.260378418160035789598336", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1772513461", "clusterAddressList": [ { "address": "J3vDSuxeK4sQAVQBUcU8H5mg7Bb5VjtXRdQJADNBENqk", "holdingAmount": "2553086.391343", "holdingValueUsd": "148.1", "holdingPercent": "0.00255", "averageHoldingPeriod": "1772513462", "lastActiveTimestamp": "1772513461", "addressRank": "65", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2449937.8", "holdingValueUsd": "142.1", "holdingPercent": "0.00245", "trendType": [ "buy" ], "averageHoldingPeriod": "1762729694", "pnlUsd": "-9965.763966453734420209239248", "pnlPercent": "-0.98594", "buyVolume": "10107.873602340060081064713256", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1768865097", "clusterAddressList": [ { "address": "A2B76kth3LZB7GK6dSzRcZBYNWsn2K6fCWyKVXBFqKx4", "holdingAmount": "2449937.771408", "holdingValueUsd": "142.1", "holdingPercent": "0.00245", "averageHoldingPeriod": "1762729694", "lastActiveTimestamp": "1768865097", "addressRank": "66", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2404721.3", "holdingValueUsd": "139.5", "holdingPercent": "0.00240", "trendType": [ "buy" ], "averageHoldingPeriod": "1769164643", "pnlUsd": "-2963.296330744894695735800548", "pnlPercent": "-0.46051", "buyVolume": "6434.843751572390144952460558", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "3332.06058410604994427210983", "averageSellPriceUsd": "0.0021123261", "lastActiveTimestamp": "1769860240", "clusterAddressList": [ { "address": "A4iTqzgqdn6BgxkEkdNcYrf3wiKgchLVDGv9d3mU6gcB", "holdingAmount": "2404721.310886", "holdingValueUsd": "139.5", "holdingPercent": "0.00240", "averageHoldingPeriod": "1769164643", "lastActiveTimestamp": "1769860240", "addressRank": "67", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2388031.2", "holdingValueUsd": "138.5", "holdingPercent": "0.00239", "trendType": [ "buy" ], "averageHoldingPeriod": "1771405196", "pnlUsd": "-1393.576191431505817529421359", "pnlPercent": "-0.90959", "buyVolume": "1532.094913533440344225958051", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1773955558", "clusterAddressList": [ { "address": "7Tue6SJMtp1soVq1hKyahstJuHxwFL9XsstH7QSCZBjA", "holdingAmount": "2388031.235237", "holdingValueUsd": "138.5", "holdingPercent": "0.00239", "averageHoldingPeriod": "1771405196", "lastActiveTimestamp": "1773955558", "addressRank": "68", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2371348.0", "holdingValueUsd": "137.6", "holdingPercent": "0.00237", "trendType": [ "buy" ], "averageHoldingPeriod": "1767392566", "pnlUsd": "-6608.589488811319023659711716", "pnlPercent": "-0.97961", "buyVolume": "6746.140490671110392607643261", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1768586079", "clusterAddressList": [ { "address": "43mmPCXp9UFffuLS6XUdhRLPNXdxxuU8cQ661KyU2ba3", "holdingAmount": "2371347.958564", "holdingValueUsd": "137.6", "holdingPercent": "0.00237", "averageHoldingPeriod": "1767392566", "lastActiveTimestamp": "1768586079", "addressRank": "69", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2275834.8", "holdingValueUsd": "132.0", "holdingPercent": "0.00228", "trendType": [ "buy" ], "averageHoldingPeriod": "1767403637", "pnlUsd": "-7375.924161963698906129026168", "pnlPercent": "-0.98242", "buyVolume": "7507.934884219939734598372405", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1767655123", "clusterAddressList": [ { "address": "FEwfUVfrEZFa2bUt4jVgm9yXnJRZ5iaaB1Jf5cdaMREA", "holdingAmount": "2275834.799444", "holdingValueUsd": "132.0", "holdingPercent": "0.00228", "averageHoldingPeriod": "1767403637", "lastActiveTimestamp": "1767655123", "addressRank": "71", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2211553.6", "holdingValueUsd": "128.3", "holdingPercent": "0.00221", "trendType": [ "buy" ], "averageHoldingPeriod": "1775645066", "pnlUsd": "-248.60666711711897890729304", "pnlPercent": "-0.24224", "buyVolume": "1026.29461728001864165420876", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "649.405884470639288111", "averageSellPriceUsd": "0.0002507390", "lastActiveTimestamp": "1776835631", "clusterAddressList": [ { "address": "5uez2R1fXyJ6YW1wVPqFoEq91WJufuWceVQy647qVYHF", "holdingAmount": "2211553.60911", "holdingValueUsd": "128.3", "holdingPercent": "0.00221", "averageHoldingPeriod": "1775645066", "lastActiveTimestamp": "1776835631", "addressRank": "72", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2194068.3", "holdingValueUsd": "127.3", "holdingPercent": "0.00219", "trendType": [ "buy" ], "averageHoldingPeriod": "1776795197", "pnlUsd": "-294.978841874298672116637576", "pnlPercent": "-0.69859", "buyVolume": "422.246663324749660424420064", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1776795197", "clusterAddressList": [ { "address": "EUj2jTi1dM41v3fTA33Y6D1D824JjTmSokqJ3xEMnjrt", "holdingAmount": "2194068.269274", "holdingValueUsd": "127.3", "holdingPercent": "0.00219", "averageHoldingPeriod": "1776795197", "lastActiveTimestamp": "1776795197", "addressRank": "74", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2120896.9", "holdingValueUsd": "123.0", "holdingPercent": "0.00212", "trendType": null, "averageHoldingPeriod": "1762680937", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "7Xj8NPLsAWVk2gxrwUsNtFeUDCnsyGN73L5eYz3bAouZ", "holdingAmount": "2120896.899373", "holdingValueUsd": "123.0", "holdingPercent": "0.00212", "averageHoldingPeriod": "1762680937", "lastActiveTimestamp": "0", "addressRank": "75", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2102010.0", "holdingValueUsd": "121.9", "holdingPercent": "0.00210", "trendType": [ "buy" ], "averageHoldingPeriod": "1768640113", "pnlUsd": "-2648.551887873040496699672421", "pnlPercent": "-0.42195", "buyVolume": "6276.937844621970107343769167", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "532.682206009730036186496548", "averageSellPriceUsd": "0.0013479293", "lastActiveTimestamp": "1773760684", "clusterAddressList": [ { "address": "HkZxby1M2f84Ee5iEpo2XTeYGLSVGEqm4ANvzvArHuK3", "holdingAmount": "2102009.962143", "holdingValueUsd": "121.9", "holdingPercent": "0.00210", "averageHoldingPeriod": "1768640113", "lastActiveTimestamp": "1773760684", "addressRank": "76", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2100000.0", "holdingValueUsd": "121.8", "holdingPercent": "0.00210", "trendType": [ "buy" ], "averageHoldingPeriod": "1768340892", "pnlUsd": "2975.410358065738932996416485", "pnlPercent": "0.06180", "buyVolume": "48147.606830665229831670106643", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "50998.673753105030303791351516", "averageSellPriceUsd": "0.0061191142", "lastActiveTimestamp": "1770424010", "clusterAddressList": [ { "address": "NyygU7ZuweGEgH89Cx4jYGeEcxursjKf22dHhcL8RB6", "holdingAmount": "2100000.0", "holdingValueUsd": "121.8", "holdingPercent": "0.00210", "averageHoldingPeriod": "1768340892", "lastActiveTimestamp": "1770424010", "addressRank": "77", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2094692.0", "holdingValueUsd": "121.5", "holdingPercent": "0.00209", "trendType": null, "averageHoldingPeriod": "1776832300", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "E85j59XKjakbREAwFFMgMNVS73pHGcYrp1Hp3dXpFdSd", "holdingAmount": "2094692.040433", "holdingValueUsd": "121.5", "holdingPercent": "0.00209", "averageHoldingPeriod": "1776832300", "lastActiveTimestamp": "0", "addressRank": "78", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2082629.6", "holdingValueUsd": "120.8", "holdingPercent": "0.00208", "trendType": null, "averageHoldingPeriod": "1764131922", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "ECj38eNN8WgStbM1TvKsYvT4KMkNgGTuDNqp2HPLXG5r", "holdingAmount": "2082629.620612", "holdingValueUsd": "120.8", "holdingPercent": "0.00208", "averageHoldingPeriod": "1764131922", "lastActiveTimestamp": "0", "addressRank": "79", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2011840.6", "holdingValueUsd": "116.7", "holdingPercent": "0.00201", "trendType": [ "buy" ], "averageHoldingPeriod": "1762728566", "pnlUsd": "-20744.402973080584230956266143", "pnlPercent": "-0.99441", "buyVolume": "20861.100602297260789996765621", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1762728566", "clusterAddressList": [ { "address": "6g7NphUCPN8965YrbZDTQyaMoEnKe817Q8DmKE7516rX", "holdingAmount": "2011840.561469", "holdingValueUsd": "116.7", "holdingPercent": "0.00201", "averageHoldingPeriod": "1762728566", "lastActiveTimestamp": "1762728566", "addressRank": "80", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "2000000.0", "holdingValueUsd": "116.0", "holdingPercent": "0.00200", "trendType": null, "averageHoldingPeriod": "1762491262", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "FNiM1XEQA4UBUV584xxDWhchyXMauFQBqiZ9fgtBjkC", "holdingAmount": "2000000.0", "holdingValueUsd": "116.0", "holdingPercent": "0.00200", "averageHoldingPeriod": "1762491262", "lastActiveTimestamp": "0", "addressRank": "81", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1991415.9", "holdingValueUsd": "115.5", "holdingPercent": "0.00199", "trendType": [ "buy" ], "averageHoldingPeriod": "1762516042", "pnlUsd": "-2742.134935500742219409573030", "pnlPercent": "-0.03744", "buyVolume": "73244.502978098280806421538567", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "70385.6421492400180026705378", "averageSellPriceUsd": "0.0014517392", "lastActiveTimestamp": "1776592195", "clusterAddressList": [ { "address": "1w9xj7ySLQGNrUgrGYdFvCPZJANeHyoexnRfVYoCBAZ", "holdingAmount": "1991415.909245", "holdingValueUsd": "115.5", "holdingPercent": "0.00199", "averageHoldingPeriod": "1762516042", "lastActiveTimestamp": "1776592195", "addressRank": "83", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1927711.4", "holdingValueUsd": "111.8", "holdingPercent": "0.00193", "trendType": [ "buy" ], "averageHoldingPeriod": "1765154503", "pnlUsd": "-2271.610053512183034604904984", "pnlPercent": "-0.91229", "buyVolume": "2490.006457744280506740725085", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "106.1929567491599988", "averageSellPriceUsd": "0.0017787765", "lastActiveTimestamp": "1769911296", "clusterAddressList": [ { "address": "E8Lpv46jpTyvgGcLUqCsXjcPnMfrSnQS3nXT4ytyALn5", "holdingAmount": "1927711.382146", "holdingValueUsd": "111.8", "holdingPercent": "0.00193", "averageHoldingPeriod": "1765154503", "lastActiveTimestamp": "1769911296", "addressRank": "85", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "trendType": null, "averageHoldingPeriod": "1764137064", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "3hF9oXn3zzBhgFodKAiiMZ45SfoPb78MEndMyELgn751", "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "averageHoldingPeriod": "1764137064", "lastActiveTimestamp": "0", "addressRank": "91", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "trendType": null, "averageHoldingPeriod": "1764139275", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "FHKERxuAq7A32K9uc3XZPFTQeWi6LeoxG2eHvA88XmZ6", "holdingAmount": "1900000.000001", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "averageHoldingPeriod": "1764139275", "lastActiveTimestamp": "0", "addressRank": "86", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "trendType": null, "averageHoldingPeriod": "1764138275", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "HWZewxz9k5wbFVgAdSfxMRuTjmKG3knMw7CDcetrhQP7", "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "averageHoldingPeriod": "1764138275", "lastActiveTimestamp": "0", "addressRank": "87", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "trendType": null, "averageHoldingPeriod": "1764137165", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "DDhTg5SnvU9eWZ3fsM9kj1gosLeCedWcUCfT3vcb2142", "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "averageHoldingPeriod": "1764137165", "lastActiveTimestamp": "0", "addressRank": "90", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "trendType": null, "averageHoldingPeriod": "1764137861", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "Ac4vk4J1izHhuLmYNpWyns8ZwrUUP5WwdagWYWZ3eFFy", "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "averageHoldingPeriod": "1764137861", "lastActiveTimestamp": "0", "addressRank": "88", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "trendType": null, "averageHoldingPeriod": "1764137908", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "6ZmkFwtpVurVXHnyYmbKpGX7vS6sWUdYwyWmjSoACazd", "holdingAmount": "1900000.0", "holdingValueUsd": "110.2", "holdingPercent": "0.00190", "averageHoldingPeriod": "1764137908", "lastActiveTimestamp": "0", "addressRank": "89", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1860222.5", "holdingValueUsd": "107.9", "holdingPercent": "0.00186", "trendType": [ "buy" ], "averageHoldingPeriod": "1771428134", "pnlUsd": "-2511.143880368452104926267515", "pnlPercent": "-0.28186", "buyVolume": "8909.219271250829919800528238", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "6290.172427403260247874271361", "averageSellPriceUsd": "0.0029513149", "lastActiveTimestamp": "1773931130", "clusterAddressList": [ { "address": "4pqdvUQZBn5cqHLbwiUiFZZmSNnMnyy8etVabZZ2KfyX", "holdingAmount": "1860222.52626", "holdingValueUsd": "107.9", "holdingPercent": "0.00186", "averageHoldingPeriod": "1771428134", "lastActiveTimestamp": "1773931130", "addressRank": "92", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1835868.4", "holdingValueUsd": "106.5", "holdingPercent": "0.00184", "trendType": [ "buy" ], "averageHoldingPeriod": "1764253378", "pnlUsd": "-922.044789123306152333248057", "pnlPercent": "-0.01988", "buyVolume": "46376.90826165755916300127182", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "45348.37318214673286986031425", "averageSellPriceUsd": "0.0031620037", "lastActiveTimestamp": "1776132461", "clusterAddressList": [ { "address": "5tqipFdGt7CLMcMkhUsG69PG8h6E5gxNkBrD3GKMx21E", "holdingAmount": "1835868.363756", "holdingValueUsd": "106.5", "holdingPercent": "0.00184", "averageHoldingPeriod": "1764253378", "lastActiveTimestamp": "1776132461", "addressRank": "93", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1833181.8", "holdingValueUsd": "106.3", "holdingPercent": "0.00183", "trendType": [ "buy" ], "averageHoldingPeriod": "1765302714", "pnlUsd": "-2866.96122922597740990482856", "pnlPercent": "-0.96424", "buyVolume": "2973.29568440456980937975532", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1765302713", "clusterAddressList": [ { "address": "DA3t2vuJvCJGRdfJjMSeZ4T3HSiANroPKCsEYGHdirKe", "holdingAmount": "1833181.80023", "holdingValueUsd": "106.3", "holdingPercent": "0.00183", "averageHoldingPeriod": "1765302714", "lastActiveTimestamp": "1765302713", "addressRank": "94", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1784624.3", "holdingValueUsd": "103.5", "holdingPercent": "0.00178", "trendType": [ "buy" ], "averageHoldingPeriod": "1762719704", "pnlUsd": "-13830.815979564585025259029376", "pnlPercent": "-0.99257", "buyVolume": "13934.3338374367598202425156", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1762730640", "clusterAddressList": [ { "address": "BkQzimdKRSTAWrLaJWxquqBqqaKgHqTa7oJqz4MFBxJ8", "holdingAmount": "1784624.303866", "holdingValueUsd": "103.5", "holdingPercent": "0.00178", "averageHoldingPeriod": "1762719704", "lastActiveTimestamp": "1762730640", "addressRank": "95", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1768257.5", "holdingValueUsd": "102.6", "holdingPercent": "0.00177", "trendType": null, "averageHoldingPeriod": "1770364199", "pnlUsd": "-1339.83058147966391882295336", "pnlPercent": "-0.92889", "buyVolume": "1442.399073971959665402349916", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1771611973", "clusterAddressList": [ { "address": "X23Rqg7JW2GfzADBk8gQFmsGcRzA2x5y53sHH8yGzbG", "holdingAmount": "1768257.46084", "holdingValueUsd": "102.6", "holdingPercent": "0.00177", "averageHoldingPeriod": "1770364199", "lastActiveTimestamp": "1771611973", "addressRank": "96", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1755770.9", "holdingValueUsd": "101.8", "holdingPercent": "0.00176", "trendType": [ "buy" ], "averageHoldingPeriod": "1766232422", "pnlUsd": "-588.814226707529940226620404", "pnlPercent": "-0.18233", "buyVolume": "3229.468859585000289007531713", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "2538.810428754510291089391101", "averageSellPriceUsd": "0.0022172646", "lastActiveTimestamp": "1774845693", "clusterAddressList": [ { "address": "9dPgUMPoriKjzT8zMfdLsox716P5CEJXbRgfvSmEYGJ9", "holdingAmount": "1755770.894237", "holdingValueUsd": "101.8", "holdingPercent": "0.00176", "averageHoldingPeriod": "1766232422", "lastActiveTimestamp": "1774845693", "addressRank": "97", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1709098.1", "holdingValueUsd": "99.1", "holdingPercent": "0.00171", "trendType": [ "buy" ], "averageHoldingPeriod": "1769090026", "pnlUsd": "-4227.699066376909450687147659", "pnlPercent": "-0.24629", "buyVolume": "17165.597869972719831120496388", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "12838.761874065561408728309389", "averageSellPriceUsd": "0.0019583741", "lastActiveTimestamp": "1769161903", "clusterAddressList": [ { "address": "Abpftkwr7ij45nvaadYDpWTBQZG2xJPd8YPANkuCiWQ3", "holdingAmount": "1709098.09657", "holdingValueUsd": "99.1", "holdingPercent": "0.00171", "averageHoldingPeriod": "1769090026", "lastActiveTimestamp": "1769161903", "addressRank": "98", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1668745.7", "holdingValueUsd": "96.8", "holdingPercent": "0.00167", "trendType": [ "buy" ], "averageHoldingPeriod": "1766892502", "pnlUsd": "-3287.281237511312543942269500", "pnlPercent": "-0.97140", "buyVolume": "3384.077507178080148379779656", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1769867868", "clusterAddressList": [ { "address": "897ftnuBPD7gLKEBxeqtqpyE5MR72c7otFTfoMzxEZTi", "holdingAmount": "1668745.653375", "holdingValueUsd": "96.8", "holdingPercent": "0.00167", "averageHoldingPeriod": "1766892502", "lastActiveTimestamp": "1769867868", "addressRank": "99", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1645909.1", "holdingValueUsd": "95.5", "holdingPercent": "0.00165", "trendType": [ "buy" ], "averageHoldingPeriod": "1776835634", "pnlUsd": "-209.469077470216706002131865", "pnlPercent": "-0.68692", "buyVolume": "304.940705547960341420217085", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1776835633", "clusterAddressList": [ { "address": "DEgxE5W358HGCmnv2kM1gMe7FcwK8Q35ohzRdyt5g82p", "holdingAmount": "1645909.133935", "holdingValueUsd": "95.5", "holdingPercent": "0.00165", "averageHoldingPeriod": "1776835634", "lastActiveTimestamp": "1776835633", "addressRank": "100", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1621235.7", "holdingValueUsd": "94.0", "holdingPercent": "0.00162", "trendType": null, "averageHoldingPeriod": "1768358985", "pnlUsd": "-1761.090747551612085000410326", "pnlPercent": "-0.94931", "buyVolume": "1855.131180583840253777134804", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1771280995", "clusterAddressList": [ { "address": "6wcHxKXGwWZzNCe89dXnZDsQZ7HRT18mQZpEJyPcj1hp", "holdingAmount": "1621235.657162", "holdingValueUsd": "94.0", "holdingPercent": "0.00162", "averageHoldingPeriod": "1768358985", "lastActiveTimestamp": "1771280995", "addressRank": "101", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1510293.8", "holdingValueUsd": "87.6", "holdingPercent": "0.00151", "trendType": [ "buy" ], "averageHoldingPeriod": "1764135844", "pnlUsd": "-2507.828690148115722289385707", "pnlPercent": "-0.09087", "buyVolume": "27598.1699797871499108097891", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "24998.86478450723965122192491", "averageSellPriceUsd": "0.0046870111", "lastActiveTimestamp": "1767042098", "clusterAddressList": [ { "address": "75oa96F3FXmS7ZMj1EmyhR6qmBLMyxNJPd55kRYwX72c", "holdingAmount": "1510293.765799", "holdingValueUsd": "87.6", "holdingPercent": "0.00151", "averageHoldingPeriod": "1764135844", "lastActiveTimestamp": "1767042098", "addressRank": "102", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1403903.5", "holdingValueUsd": "81.4", "holdingPercent": "0.00140", "trendType": [ "buy" ], "averageHoldingPeriod": "1766206838", "pnlUsd": "-15628.147546945992415886321196", "pnlPercent": "-0.28863", "buyVolume": "54145.159377640819651576341076", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "38435.577836009750468797241500", "averageSellPriceUsd": "0.0027028247", "lastActiveTimestamp": "1768507627", "clusterAddressList": [ { "address": "GVogczfdaDrLokuNFMmUkdggqZcQmQvL5hTL6YLrgswf", "holdingAmount": "821008.468729", "holdingValueUsd": "47.6", "holdingPercent": "0.00082", "averageHoldingPeriod": "1764573336", "lastActiveTimestamp": "1764573335", "addressRank": "180", "isContract": false, "isExchange": false, "isKol": false }, { "address": "FYKvzT9MrnEF3ad6uggLaUVQhgJg7LdH7QRnZ3DSWUmW", "holdingAmount": "582895.061185", "holdingValueUsd": "33.8", "holdingPercent": "0.00058", "averageHoldingPeriod": "1768507628", "lastActiveTimestamp": "1768507627", "addressRank": "198", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1353902.7", "holdingValueUsd": "78.5", "holdingPercent": "0.00135", "trendType": [ "buy" ], "averageHoldingPeriod": "1768866380", "pnlUsd": "-3129.447843972319726509021594", "pnlPercent": "-0.97552", "buyVolume": "3207.981522670550367053258626", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1768866511", "clusterAddressList": [ { "address": "5D2PQUxLUY8JTL1FkpkmoV2EbntJVn5J6YiDpNqwN6Du", "holdingAmount": "1353902.742558", "holdingValueUsd": "78.5", "holdingPercent": "0.00135", "averageHoldingPeriod": "1768866380", "lastActiveTimestamp": "1768866511", "addressRank": "104", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1284449.7", "holdingValueUsd": "74.5", "holdingPercent": "0.00128", "trendType": null, "averageHoldingPeriod": "1762811792", "pnlUsd": "-2947.713230328978632631004314", "pnlPercent": "-0.64423", "buyVolume": "4575.578607175430178655459745", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1771340329", "clusterAddressList": [ { "address": "9QuTv7KA3T1DwYsGwWX5k7hLE8BgAxp4heiRtrZtrAhD", "holdingAmount": "1284449.671631", "holdingValueUsd": "74.5", "holdingPercent": "0.00128", "averageHoldingPeriod": "1762811792", "lastActiveTimestamp": "1771340329", "addressRank": "107", "isContract": true, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1282082.5", "holdingValueUsd": "74.4", "holdingPercent": "0.00128", "trendType": null, "averageHoldingPeriod": "1775465219", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "7i5E9i8kHSkbNTsWwDJZNicern2tniiZxFqxyjqEehoX", "holdingAmount": "1282082.500834", "holdingValueUsd": "74.4", "holdingPercent": "0.00128", "averageHoldingPeriod": "1775465219", "lastActiveTimestamp": "0", "addressRank": "108", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1225604.4", "holdingValueUsd": "71.1", "holdingPercent": "0.00123", "trendType": [ "buy" ], "averageHoldingPeriod": "1774100049", "pnlUsd": "-366.464196560645838808872642", "pnlPercent": "-0.83753", "buyVolume": "437.55587654096982475845665", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1774538129", "clusterAddressList": [ { "address": "DhzKGGEL5v5wwjRRnX6kfLcZtS89PYQzeH9TXb4p9yjp", "holdingAmount": "1225604.378833", "holdingValueUsd": "71.1", "holdingPercent": "0.00123", "averageHoldingPeriod": "1774100049", "lastActiveTimestamp": "1774538129", "addressRank": "109", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1124705.3", "holdingValueUsd": "65.2", "holdingPercent": "0.00112", "trendType": [ "buy" ], "averageHoldingPeriod": "1772701762", "pnlUsd": "-603.924364438550379864068192", "pnlPercent": "-0.04346", "buyVolume": "13896.736323792449049350685761", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "13219.718488213900597242639228", "averageSellPriceUsd": "0.0022990177", "lastActiveTimestamp": "1772701773", "clusterAddressList": [ { "address": "7wzgLgvFsX68UvikCuf2DB6wAJjeknqkooRpUajQWoat", "holdingAmount": "1124705.265552", "holdingValueUsd": "65.2", "holdingPercent": "0.00112", "averageHoldingPeriod": "1772701762", "lastActiveTimestamp": "1772701773", "addressRank": "111", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1108040.6", "holdingValueUsd": "64.3", "holdingPercent": "0.00111", "trendType": null, "averageHoldingPeriod": "1768162476", "pnlUsd": "-1263.403025850252446440265620", "pnlPercent": "-0.95159", "buyVolume": "1327.675373598519924316248007", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1772319104", "clusterAddressList": [ { "address": "HJhbEoCUcCPrvLQfbWLC5yW7eRYbQ6JVoxxnCn8UhcpK", "holdingAmount": "1108040.643574", "holdingValueUsd": "64.3", "holdingPercent": "0.00111", "averageHoldingPeriod": "1768162476", "lastActiveTimestamp": "1772319104", "addressRank": "112", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1046626.6", "holdingValueUsd": "60.7", "holdingPercent": "0.00105", "trendType": [ "buy" ], "averageHoldingPeriod": "1767400301", "pnlUsd": "-3801.499665042634258209718784", "pnlPercent": "-0.98428", "buyVolume": "3862.209663587239994599449336", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1768905893", "clusterAddressList": [ { "address": "7kmdXKLiQPeBMw1gJRedEBchTXvS8hcA2pqVvWX3iN3s", "holdingAmount": "1046626.554272", "holdingValueUsd": "60.7", "holdingPercent": "0.00105", "averageHoldingPeriod": "1767400301", "lastActiveTimestamp": "1768905893", "addressRank": "113", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1034898.3", "holdingValueUsd": "60.0", "holdingPercent": "0.00103", "trendType": [ "buy" ], "averageHoldingPeriod": "1765683285", "pnlUsd": "-1636.179548614452035447563755", "pnlPercent": "-0.55691", "buyVolume": "2937.94277390382026712909551", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "1235.387309170170080470716939", "averageSellPriceUsd": "0.0011445195", "lastActiveTimestamp": "1775663873", "clusterAddressList": [ { "address": "CbFE95ViH798MHcyHdTDvnTZQTEji7fpBWpt1BtHML7m", "holdingAmount": "1034898.28466", "holdingValueUsd": "60.0", "holdingPercent": "0.00103", "averageHoldingPeriod": "1765683285", "lastActiveTimestamp": "1775663873", "addressRank": "114", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1032870.5", "holdingValueUsd": "59.9", "holdingPercent": "0.00103", "trendType": [ "buy" ], "averageHoldingPeriod": "1762860042", "pnlUsd": "-5916.836112098266190357723370", "pnlPercent": "-0.98998", "buyVolume": "5976.748186883160108195085256", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1762860090", "clusterAddressList": [ { "address": "9wrEVfwcEeF2Qc1mEko2FxsnBXwR6V8fz6xrAYJdFhVY", "holdingAmount": "1032870.530302", "holdingValueUsd": "59.9", "holdingPercent": "0.00103", "averageHoldingPeriod": "1762860042", "lastActiveTimestamp": "1762860090", "addressRank": "115", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1021496.6", "holdingValueUsd": "59.3", "holdingPercent": "0.00102", "trendType": [ "buy" ], "averageHoldingPeriod": "1762573117", "pnlUsd": "1977.729278884385763996459468", "pnlPercent": "0.55506", "buyVolume": "3563.117536240861396717704337", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "5481.594492210629895079045993", "averageSellPriceUsd": "0.0016282453", "lastActiveTimestamp": "1762573116", "clusterAddressList": [ { "address": "2ysRt3sR32A15yaBnk6RQ5CPr2HT4DYHrifXi9n7NNQi", "holdingAmount": "1021496.558251", "holdingValueUsd": "59.3", "holdingPercent": "0.00102", "averageHoldingPeriod": "1762573117", "lastActiveTimestamp": "1762573116", "addressRank": "116", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1017774.7", "holdingValueUsd": "59.0", "holdingPercent": "0.00102", "trendType": [ "buy" ], "averageHoldingPeriod": "1774916110", "pnlUsd": "-154.725235815430259657182069", "pnlPercent": "-0.72382", "buyVolume": "213.76166836987033032464632", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1775615393", "clusterAddressList": [ { "address": "yQqJVr1sYChXUE9o4ngn6rp2oGsqT8Lvx6e8EWkJ9Ka", "holdingAmount": "1017774.657589", "holdingValueUsd": "59.0", "holdingPercent": "0.00102", "averageHoldingPeriod": "1774916110", "lastActiveTimestamp": "1775615393", "addressRank": "117", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1003423.3", "holdingValueUsd": "58.2", "holdingPercent": "0.00100", "trendType": [ "buy" ], "averageHoldingPeriod": "1767903346", "pnlUsd": "-3694.81704797293353885485888", "pnlPercent": "-0.98449", "buyVolume": "3753.021024382670030273769201", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1767903346", "clusterAddressList": [ { "address": "FXNS8rJ5yJTUt68owi48gWzbeQqBV4fSEMz3duXe8VvZ", "holdingAmount": "1003423.29844", "holdingValueUsd": "58.2", "holdingPercent": "0.00100", "averageHoldingPeriod": "1767903346", "lastActiveTimestamp": "1767903346", "addressRank": "118", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1001012.0", "holdingValueUsd": "58.1", "holdingPercent": "0.00100", "trendType": [ "buy" ], "averageHoldingPeriod": "1764953832", "pnlUsd": "-2645.197263001792732329250369", "pnlPercent": "-0.95794", "buyVolume": "2761.325477045069619687080619", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1764953832", "clusterAddressList": [ { "address": "3hyKAcCW6GXyhwDeRAUtSUpzGnupdMQMRNKZexcYpeuo", "holdingAmount": "1001011.986754", "holdingValueUsd": "58.1", "holdingPercent": "0.00100", "averageHoldingPeriod": "1764953832", "lastActiveTimestamp": "1764953832", "addressRank": "119", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1000000.0", "holdingValueUsd": "58.0", "holdingPercent": "0.00100", "trendType": [ "buy" ], "averageHoldingPeriod": "1762715093", "pnlUsd": "-8007.488212712595858468226659", "pnlPercent": "-0.63163", "buyVolume": "12677.539932898570080747064769", "averageBuyPriceUsd": "1.0000000000", "sellVolume": "4603.568511317179917046633247", "averageSellPriceUsd": "0.0038808890", "lastActiveTimestamp": "1769385338", "clusterAddressList": [ { "address": "2h7Ns9w2grSeQ9mE9WggJZvxMKKLNADJrKTSLucrbmzB", "holdingAmount": "1000000.0", "holdingValueUsd": "58.0", "holdingPercent": "0.00100", "averageHoldingPeriod": "1762715093", "lastActiveTimestamp": "1769385338", "addressRank": "165", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1000000.0", "holdingValueUsd": "58.0", "holdingPercent": "0.00100", "trendType": [ "sell", "transferIn" ], "averageHoldingPeriod": "1762490866", "pnlUsd": "0E-18", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "1762743168", "clusterAddressList": [ { "address": "CYjykZu3qjZxLB9qfRWiHbFDkfvATF818YStxbTkUD6T", "holdingAmount": "1000000.0", "holdingValueUsd": "58.0", "holdingPercent": "0.00100", "averageHoldingPeriod": "1762490866", "lastActiveTimestamp": "1762743168", "addressRank": "167", "isContract": false, "isExchange": false, "isKol": false } ] }, { "holdingAmount": "1000000.0", "holdingValueUsd": "58.0", "holdingPercent": "0.00100", "trendType": null, "averageHoldingPeriod": "1764163542", "pnlUsd": "0", "pnlPercent": "0.0", "buyVolume": "0", "averageBuyPriceUsd": "0.0", "sellVolume": "0", "averageSellPriceUsd": "0.0", "lastActiveTimestamp": "0", "clusterAddressList": [ { "address": "myqSd681pLZ2Ajscfr3kxkZWQe8pfRZVMAQ6Bm4CwDh", "holdingAmount": "1000000.0", "holdingValueUsd": "58.0", "holdingPercent": "0.00100", "averageHoldingPeriod": "1764163542", "lastActiveTimestamp": "0", "addressRank": "153", "isContract": false, "isExchange": false, "isKol": false } ] } ] } } ``` - [Get Token Top Holders Cluster Overview](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-cluster-top-holders.md) {/* api-page */} # Get Token Top Holders Cluster Overview Get the overview data for the top 10/50/100 holding addresses of a specified token. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/cluster/top-holders` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | string | Yes | Unique chain identifier. Pass in the chain ID (e.g., 501 for Solana). Only supports single-chain queries | | tokenContractAddress | string | Yes | Token contract address | | rangeFilter | string | Yes | Data for the top 10/50/100 holding addresses. Values: 1=10, 2=50, 3=100 | ## Response Parameters | Field | Type | Description | |---|---|---| | holdingAmount | string | Total token holdings of the top 10/50/100 addresses (excluding black holes and liquidity pool addresses) | | holdingPercent | string | Percentage of token supply held by the top 10/50/100 addresses | | clusterTrendType | Array | Buy/Sell/Neutral/Transfer dominant. The overall direction of traders' holdings over time — increasing (buying), decreasing (selling), flat (neutral), or primarily accumulated through transfers (transfer dominant) | | averageHoldingPeriod | string | Weighted average holding period of the top 10/50/100 holders | | averagePnlUsd | string | Weighted average PnL of the top 10/50/100 holders | | averageBuyPriceUsd | string | Weighted average cost price of the top 10/50/100 holders | | averageBuyPricePercent | string | Percentage difference between the average cost price of the top 10/50/100 holders and the current token price | | averageSellPriceUsd | string | Weighted average selling price of the top 10/50/100 holders | | averageSellPricePercent | string | Percentage difference between the average selling price of the top 10/50/100 holders and the current token price | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/cluster/top-holders?chainIndex=8453&tokenContractAddress=0xfde4c96c8593536e31f229ea8f37b2ada2699bb2&rangeFilter=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": 0, "msg": "success", "error_code": "0", "error_message": "", "detailMsg": "", "data": { "holdingAmount": "9651442.5", "holdingPercent": "0.42483", "clusterTrendType": [ "buy", "transferIn" ], "averageHoldingPeriod": "1744614666", "averagePnlUsd": "null", "averageBuyPriceUsd": "null", "averageBuyPricePercent": "null", "averageSellPriceUsd": "null", "averageSellPricePercent": "null" } } ``` - [Token Profit Address Information](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-top-trader.md) {/* api-page */} # Token Profit Address Information Support viewing the top 100 profitable addresses and corresponding address information ## Request Path GET `https://web3.okx.com/api/v6/dex/market/token/top-trader` ## Request Parameters Return to the top 100 profitable addresses | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain. For example: `1`: Ethereum. | | tokenContractAddress | String | Yes | Token contract address (e.g. 0x382bb369d343125bfb2117af9c149795c6c65c50) | | tagFilter | String | No | Default: No input, return the address data of the top 100 profitable addresses, arranged in reverse order according to the realized income.
Enter 1: Return the holding address labeled KOL.
Enter 2: Return the token address labeled Developer
Enter 3: Return the holding address labeled Smart Money
Enter 4: Return the holding address labeled as Whale
Enter 5: Return the holding address labeled New Wallet
Enter 6: Return the holding address labeled Suspicious
Enter 7: Return the holding address labeled Sniper
Enter 8: Return the holding address labeled as Suspected phishing.
Enter 9: Return the holding address labeled Bundle | | cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request | | limit | String | No | Number of records per page, max 100 | ## Response Parameters | Field | Type | Description | |---|---|---| | holderWalletAddress | String | Cash holding address | | cursor | String | Pagination cursor | | holdAmount | String | Number of coins held | | holdPercent | String | Percentage of holdings | | nativeTokenBalance | String | Mainnet currency balance | | boughtAmount | String | Total Buy Quantity | | avgBuyPrice | String | Average buying price | | soldAmount | String | Total sold quantity | | avgSellPrice | String | Average selling price | | totalPnlUsd | String | Total profit and loss | | realizedPnlUsd | String | Realized profit and loss | | unrealizedPnlUsd | String | Unrealized profit and loss | | fundingSource | String | Sources of funding | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/token/top-trader?chainIndex=501&tokenContractAddress=EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v&tagFilter=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "avgBuyPrice": "0.000061961311739113", "avgSellPrice": "0.000122073405687202", "boughtAmount": "48443482.085545000000000000", "cursor": "0", "fundingSource": "AC5RDfQFmDS1deWZos921JfqscXdByf8BKHs5ACWjtW2", "holdAmount": "0", "holdPercent": "0.000000000000000000", "holderWalletAddress": "GHPyCYecXh398J72qi8nx9Sdaq8PiUJmLoL2q2yLwTY9", "nativeTokenBalance": "0.024254276", "realizedPnlUsd": "2912.039146298874538842343358", "soldAmount": "41626711.761828000000000000", "totalPnlUsd": "2912.039146298874538842343358", "unrealizedPnlUsd": "0.000000000000000000" }, { "avgBuyPrice": "0.000045836227988662", "avgSellPrice": "0.000117400306217832", "boughtAmount": "29120882.898397000000000000", "cursor": "1", "fundingSource": "FLipG5QHjZe1H12f6rr5LCnrmqjhwuBTBp78GwzxnwkR", "holdAmount": "0", "holdPercent": "0.000000000000000000", "holderWalletAddress": "HYSq1KBAvqWpEv1pCbV31muKM1za5A1WSHGdiVLUoNhb", "nativeTokenBalance": "37.572873625", "realizedPnlUsd": "2084.009141843422246184643326", "soldAmount": "29120882.898397000000000000", "totalPnlUsd": "2084.009141843422246184643326", "unrealizedPnlUsd": "0.000000000000000000" } ], "msg": "" } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/market-token-error-code.md) # Error Codes ## API error handling | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------------------------------| | 0 | 200 | Succeeded | | 50011 | 429 | Rate limit reached. Please refer to API documentation and throttle requests accordingly | | 50014 | 400 | Parameter \{param0\} cannot be empty | | 50026 | 500 | System error. Try again later | | 50103 | 401 | Request header "OK-ACCESS-KEY" cannot be empty | | 50104 | 401 | Request header "OK-ACCESS-PASSPHRASE" cannot be empty| | 50105 | 401 | Request header "OK-ACCESS-PASSPHRASE" incorrect | | 50106 | 401 | Request header "OK-ACCESS-SIGN" cannot be empty | | 50107 | 401 | Request header "OK-ACCESS-TIMESTAMP" cannot be empty | | 50111 | 401 | Invalid OK-ACCESS-KEY | | 50112 | 401 | Invalid OK-ACCESS-TIMESTAMP | | 50113 | 401 | Invalid signature | | 51000 | 400 | Parameter \{param0\} error | ## Payment error handling | Error Message | Meaning | Troubleshooting Action | |------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | Empty / null response | Request did not include PAYMENT-SIGNATURE or X-PAYMENT header | Include PAYMENT-SIGNATURE or X-PAYMENT in the request after signing | | invalid payment header | PAYMENT-SIGNATURE content is invalid | Check for truncation / encoding issues / multiple base64 nesting | | param_mismatch | Missing required fields or invalid parameters (address / nonce format) | Verify that parameters in the signature match the expected values | | toAddr mismatch | PayTo address does not match or is zero address | Ensure the address matches exactly and is not 0x0000… | | amount mismatch | Signed amount does not match returned amount | Ensure value in EIP-3009 signature equals the returned amount | | unsupported_chain | Parsed chainIndex from network is not supported | Currently only X Layer (eip155:196) is supported | | payer_blocked | authorization.from triggered risk control rules | Contact OKX support / risk team | | risk_address | payer or payTo is flagged (blacklist / sanctioned address) | Use a different address | | resource mismatch | Signed URL does not match request URL | Use the exact request URL when signing; do not reuse payload | | no matching payment option | Payment token does not match required token | Sign using the token specified in the response | | invalid_signature | Invalid signature format (length, r/s range, v value, etc.) | Use OKXEvmSigner; avoid manual EIP-712 construction | | not_yet_valid | validAfter > now | Check system time | | expired | `validBefore <= now` | Check system time | | invalid signature, nonce_used | Nonce already used on-chain | Generate a new 32-byte nonce and sign again | | insufficient_balance | Insufficient balance | Fund the account or reduce concurrent payments | | onchain_error | On-chain RPC / multicall failure | Retry the request | | payment processing | Duplicate request within cache window | Avoid reusing the same signature within cache period | - [Signal API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/market-signal-reference.md) # Signal API Reference - [Get Signal Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/market-signal-chains.md) {/* api-page */} # Get Signal Supported Chains Returns a list of all blockchain networks supported by the Signal service. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/signal/supported/chain` ## Request Parameters No ## Response Parameters | Parameter | Type | Description | |------------|--------|----------------------------| | chainIndex | String | Unique identifier of the chain. | | chainName | String | Chain name (e.g., Ethereum). | | chainLogo | String | Chain icon. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/signal/supported/chain' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "chainIndex": "1", "chainLogo": "https://static.coinall.ltd/cdn/wallet/logo/ETH-20220328.png", "chainName": "Ethereum" }, { "chainIndex": "196", "chainLogo": "https://static.coinall.ltd/cdn/wallet/logo/okb_22400.png", "chainName": "X Layer" }, { "chainIndex": "501", "chainLogo": "https://static.coinall.ltd/cdn/wallet/logo/SOL-20220525.png", "chainName": "Solana" }, { "chainIndex": "8453", "chainLogo": "https://static.coinall.ltd/cdn/web3/dex/market/base_v2.png", "chainName": "Base" }, { "chainIndex": "56", "chainLogo": "https://static.coinall.ltd/cdn/web3/oklinkadmin/picture/new_bsc_chain_color.png", "chainName": "BNB Chain" } ], "msg": "" } ``` - [Get Latest Signal List](https://web3pre.okex.org/onchainos/dev-docs/market/market-signal-list.md) {/* api-page */} # Get Latest Signal List Retrieve the latest buy-direction token signal list on a specified chain, sorted in descending order by time. ## Request URL POST `https://web3.okx.com/api/v6/dex/market/signal/list` ## Request Parameters | Parameter | Type | Required | Description | |----------------------|---------|----------|-----------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier of the chain. Pass the chain ID (e.g., 1: Ethereum). Only single-chain queries are supported. | | walletType | String | No | Wallet type code. Enum: 1 = Smart Money, 2 = KOL / Influencer, 3 = Whales. Multiple values supported, separated by commas. | | minAmountUsd | String | No | Minimum total transaction amount (USD) for the selected wallet type(s). | | maxAmountUsd | String | No | Maximum total transaction amount (USD) for the selected wallet type(s). | | minAddressCount | String | No | Minimum number of addresses of the selected wallet type that triggered the signal. | | maxAddressCount | String | No | Maximum number of addresses of the selected wallet type that triggered the signal. | | tokenAddress | String | No | Token contract address. If provided, query the specified token; if not, return a filtered list within constraints. | | minMarketCapUsd | String | No | Minimum market cap (USD) of the token when the signal was triggered. | | maxMarketCapUsd | String | No | Maximum market cap (USD) of the token when the signal was triggered. | | minLiquidityUsd | String | No | Minimum liquidity (USD) of the token when the signal was triggered. | | maxLiquidityUsd | String | No | Maximum liquidity (USD) of the token when the signal was triggered. | | | cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request | | limit | String | No | Number of records per page, max 100 | ## Response Parameters | Parameter | Type | Description | |-------------------------|---------|-------------| | timestamp | String | Timestamp when the signal was triggered. | | cursor | String | Pagination cursor | | chainIndex | String | Unique identifier of the chain. | | token | Object | Token information. | | >tokenAddress | String | Token address. | | >symbol | String | Token symbol. | | >name | String | Token name. | | >logo | String | Token logo. | | >marketCapUsd | String | Market cap in USD. | | >holders | String | Number of holder addresses. | | >top10HolderPercent | String | Top 10 holder percentage. | | price | String | Token price in USD when the signal was triggered. | | walletType | String | Wallet type. Enum: SMART_MONEY / WHALE / INFLUENCER. | | triggerWalletCount | String | Number of triggering wallet addresses. | | triggerWalletAddress | String | List of triggering wallet addresses, separated by commas. | | amountUsd | String | Transaction amount in USD. | | soldRatioPercent | String | Sold percentage. | ## Request Example ```shell curl --location --request POST 'https://web3.okx.com/api/v6/dex/market/signal/list' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \ --data-raw '[ { "chainIndex": "501", "walletType": "1,2,3", "minAmountUsd": "1000", "maxAmountUsd": "500000", "minAddressCount": "2", "maxAddressCount": "50", "tokenAddress": "", "minMarketCapUsd": "168564", "maxMarketCapUsd": "", "minLiquidityUsd": "333", "maxLiquidityUsd": "" } ]' ``` ## Response Example ```json { "code": "0", "data": [ { "amountUsd": "669.455417761799554132", "chainIndex": "501", "price": "0.000122496972899498", "soldRatioPercent": "64.29", "timestamp": "1774364940575", "token": { "holders": "445", "logo": "https://static.oklink.com/cdn/web3/currency/token/pre/large/501-FN9ZSeNDdPV6bBF9DeDYxvqYK4JvFKeF7DBrhGGXJZ3Q-109/type=webp_90_0?v=1774292374274", "marketCapUsd": "64466.670905193533007211", "name": "Van Cleef Memes", "symbol": "VanCleef", "tokenAddress": "FN9ZSeNDdPV6bBF9DeDYxvqYK4JvFKeF7DBrhGGXJZ3Q", "top10HolderPercent": "17.9547" }, "triggerWalletAddress": "5jds1qi6nYu2JTZv5YTczPwyaq1RAkNkjbpsma8xSTem,4YzpSZpxDdjNf3unjkCtdWEsz2FL5mok7e5XQaDNqry8,F8sHTSpZpoNB7H2JUZ7tmMb2YWRM1pXiHPuubHVRDSsB", "triggerWalletCount": "3", "walletType": "2", "cursor": "1774364940575!@#123" }, { "amountUsd": "1912.742277985131470193", "chainIndex": "501", "price": "0.000043905847119596", "soldRatioPercent": "74.73", "timestamp": "1774350239648", "token": { "holders": "1112", "logo": "https://static.oklink.com/cdn/web3/currency/token/pre/large/501-AytNmHWe8uXfgBACLnvhyKWrecAcYFywLK2nXbegpump-109/type=webp_90_0?v=1774359780606", "marketCapUsd": "127139.702497190490981742", "name": "The Sandwich Heist", "symbol": "Sandwich", "tokenAddress": "AytNmHWe8uXfgBACLnvhyKWrecAcYFywLK2nXbegpump", "top10HolderPercent": "18.4131" }, "triggerWalletAddress": "As7HjL7dzzvbRbaD3WCun47robib2kmAKRXMvjHkSMB5,719sfKUjiMThumTt2u39VMGn612BZyCcwbM5Pe8SqFYz,3L8RAxLkvwkz4CgHivaVRtq19741FAdGLk5DgjRfc1fW,9FNz4MjPUmnJqTf6yEDbL1D4SsHVh7uA8zRHhR5K138r,FRbUNvGxYNC1eFngpn7AD3f14aKKTJVC6zSMtvj2dyCS,6iM1Ljh8zkY9Vxw6VqHmm9HJ3axD4f9yYpXnSCi22hvY", "triggerWalletCount": "6", "walletType": "2", "cursor": "1774350239648!@#123" // pass this for next pagination } ] } ``` - [Get Leaderboard Supported Chain List](https://web3pre.okex.org/onchainos/dev-docs/market/market-signal-leaderboard-supported-chain.md) {/* api-page */} # Get Leaderboard Supported Chain List Get the list of supported chains ## Request Path GET `https://web3.okx.com/api/v6/dex/market/leaderboard/supported/chain` ## Request Parameters None ## Response Parameters | Field | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain | | chainName | String | Chain name | | chainLogo | String | Chain logo URL | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/leaderboard/supported/chain' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "chainIndex": "1", "chainName": "Ethereum", "chainLogo": "https://static.okx.com/cdn/wallet/logo/ETH-20220328.png" }, { "chainIndex": "501", "chainName": "Solana", "chainLogo": "https://static.okx.com/cdn/wallet/logo/SOL.png" } ], "msg": "" } ``` - [Get Smart Money Leaderboard List](https://web3pre.okex.org/onchainos/dev-docs/market/market-signal-leaderboard-list.md) {/* api-page */} # Get Smart Money Leaderboard List Retrieve the Smart Money leaderboard according to specified sorting and filter options; can be used in conjunction with the Signal API. Limit: Maximum 20 records per request ## Request Path GET `https://web3.okx.com/api/v6/dex/market/leaderboard/list` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | string | Yes | Unique chain identifier (e.g., 1 for Ethereum). Only supports single-chain queries | | timeFrame | string | Yes | Address transactions and PnL timeframe index (i.e. 1=1D, 2=3D, 3=7D, 4=1M, 5=3M) | | sortBy | string | Yes | Sorting according to the selected timeFrame: PnL, ProfitRate, WinRate, TxVolume, TxCount. 1=Pnl, 2=Win Rate, 3=Tx number, 4=Volume, 5=ROI (profit rate) | | walletType | string | No | Wallet type index. Enum: 1 = KOL, 2 = Developer, 3 = Smart Money, 4 = Whale, 5 = New Wallet, 6 = Insider (Mouse Position), 7 = Sniper, 8 = Suspected Phishing, 9 = Bundled Trader, 10 = Pump Smart Money. Supports single selection. If not provided, rankings for all wallet types will be returned. | | minRealizedPnlUsd | string | No | Minimum realized profit and loss amount (USD) | | maxRealizedPnlUsd | string | No | Maximum realized profit and loss amount (USD) | | minWinRatePercent | string | No | Minimum win rate percentage | | maxWinRatePercent | string | No | Maximum win rate percentage | | minTxs | string | No | Minimum number of transactions | | maxTxs | string | No | Maximum number of transactions | | minTxVolume | string | No | Minimum transaction volume (USD) | | maxTxVolume | string | No | Maximum transaction volume (USD) | ## Response Parameters | Field | Type | Description | |---|---|---| | walletAddress | string | Wallet address | | realizedPnlUsd | string | Accumulated realized PnL USD value for completed transactions within the selected timeframe | | realizedPnlPercent | string | Accumulated realized PnL percentage for completed transactions within the selected timeframe | | winRatePercent | string | The percentage of profitable tokens relative to the total number of tokens traded | | avgBuyValueUsd | string | Average buy value | | topPnlTokenList | array | Top 3 token list by PnL | | > tokenContractAddress | string | Token contract address | | > tokenSymbol | string | Token symbol | | > tokenPnlUsd | string | Token PnL in USD | | > tokenPnlPercent | string | Token PnL percentage | | txVolume | string | Transaction volume in USD within the selected timeframe | | txs | string | Transaction count within the selected timeframe | | lastActiveTimestamp | string | Last active time | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/leaderboard/list?chainIndex=501&timeFrame=1&sortBy=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "walletAddress": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU", "realizedPnlUsd": "125430.56", "realizedPnlPercent": "312.45", "winRatePercent": "68.5", "avgBuyValueUsd": "2340.00", "topPnlTokenList": [ { "tokenContractAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "tokenSymbol": "USDC", "tokenPnlUsd": "45230.12", "tokenPnlPercent": "156.78" }, { "tokenContractAddress": "So11111111111111111111111111111111111111112", "tokenSymbol": "SOL", "tokenPnlUsd": "38120.00", "tokenPnlPercent": "98.34" }, { "tokenContractAddress": "DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263", "tokenSymbol": "BONK", "tokenPnlUsd": "20450.88", "tokenPnlPercent": "204.60" } ], "txVolume": "890234.50", "txs": "342", "lastActiveTimestamp": "1697630501000" } ], "msg": "" } ``` - [Trenches API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/market-scan-chain-api-reference.md) # Trenches API Reference - [Get Supported Chains and Protocols](https://web3pre.okex.org/onchainos/dev-docs/market/market-memepump-get-supported-chains-and-protocols.md) {/* api-page */} # Get Supported Chains and Protocols Retrieve the list of chains and their corresponding protocols supported by Meme Pump. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/memepump/supported/chainsProtocol` ## Request Parameters None ## Response Parameters | Parameter | Type | Description | |-----------------|--------|--------------------------------------------------------------| | chainIndex | String | Chain unique identifier (e.g., `501` = Solana, `56` = BSC). | | chainName | String | Chain name（eg.Ethereum） | | protocolList | Array | List of supported protocols on this chain. | | >protocolId | String | Protocol ID (e.g., `1` = PUMP_FUN). | | >protocolName | String | Protocol name (e.g., `PUMP_FUN`, `SUNPUMP`). | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/memepump/supported/chainsProtocol' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "501", "chainName": "Solana", "protocolList": [ { "protocolId": "1", "protocolName": "PUMP_FUN" }, { "protocolId": "2", "protocolName": "MOONSHOT" } ] }, { "chainIndex": "56", "chainName": "BSC", "protocolList": [ { "protocolId": "3", "protocolName": "SUNPUMP" } ] } ] } ``` - [Get Token List](https://web3pre.okex.org/onchainos/dev-docs/market/market-memepump-get-token-list.md) {/* api-page */} # Get Token List Retrieve the list of tokens matching specified filter criteria,with a maximum limit of 30 entries. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/memepump/tokenList` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier for the blockchain network. e.g., `501` = Solana, `56` = BSC. Only single-chain queries are supported. | | stage | String | Yes | Token lifecycle stage filter. Enum: `NEW` = newly created tokens, `MIGRATING` = tokens nearly migrated to DEX, `MIGRATED` = tokens that have completed migration to DEX. | | walletAddress | String | No | User's wallet address. When provided, response will include user-specific position data (e.g., holdings, P&L). | | protocolIdList | String | No | Comma-separated protocol IDs to filter by. e.g., `"120596"` for PumpFun, `"120596,139661"` for multiple protocols. Get available protocol IDs from `/memepump/supported/chainsProtocol`. | | quoteTokenAddressList | String | No | Comma-separated quote token contract addresses to filter by. e.g., `"So11111111111111111111111111111111111111111"` for SOL. Filters tokens by their trading pair's quote currency. | | minTop10HoldingsPercent | String | No | Minimum percentage of total supply held by top 10 holders. Value range: 0–100. e.g., `"10"` means top 10 holders hold at least 10%. | | maxTop10HoldingsPercent | String | No | Maximum percentage of total supply held by top 10 holders. Value range: 0–100. | | minDevHoldingsPercent | String | No | Minimum percentage of total supply held by the developer wallet. Value range: 0–100. | | maxDevHoldingsPercent | String | No | Maximum percentage of total supply held by the developer wallet. Value range: 0–100. | | minInsidersPercent | String | No | Minimum percentage of insider wallets among all holders. Value range: 0–100. | | maxInsidersPercent | String | No | Maximum percentage of insider wallets among all holders. Value range: 0–100. | | minBundlersPercent | String | No | Minimum percentage of bundler wallets among all holders. Value range: 0–100. Bundlers are wallets that bundle multiple transactions together. | | maxBundlersPercent | String | No | Maximum percentage of bundler wallets among all holders. Value range: 0–100. | | minSnipersPercent | String | No | Minimum percentage of sniper wallets among all holders. Value range: 0–100. Snipers are wallets that buy tokens extremely early after launch. | | maxSnipersPercent | String | No | Maximum percentage of sniper wallets among all holders. Value range: 0–100. | | minFreshWalletsPercent | String | No | Minimum percentage of fresh (newly created) wallets among all holders. Value range: 0–100. | | maxFreshWalletsPercent | String | No | Maximum percentage of fresh (newly created) wallets among all holders. Value range: 0–100. | | minSuspectedPhishingWalletPercent | String | No | Minimum percentage of suspected phishing wallets among all holders. Value range: 0–100. | | maxSuspectedPhishingWalletPercent | String | No | Maximum percentage of suspected phishing wallets among all holders. Value range: 0–100. | | minBotTraders | String | No | Minimum number of bot trader wallets. | | maxBotTraders | String | No | Maximum number of bot trader wallets. | | minDevMigrated | String | No | Minimum number of tokens previously migrated by the same developer. Useful for evaluating dev history. | | maxDevMigrated | String | No | Maximum number of tokens previously migrated by the same developer. | | communityTakeover | Boolean | No | Filter by whether the token has undergone a community takeover (CTO). `true` = only CTO tokens, `false` = only non-CTO tokens. | | minFeesNative | String | No | Minimum total fees spent on the token, denominated in native chain currency (e.g., SOL). | | maxFeesNative | String | No | Maximum total fees spent on the token, denominated in native chain currency. | | minTxCount | String | No | Minimum total transaction count for the token. | | maxTxCount | String | No | Maximum total transaction count for the token. | | minBondingPercent | String | No | Minimum bonding curve completion percentage. Value range: 0–100. Applicable when `stage=NEW` or `stage=MIGRATING`. | | maxBondingPercent | String | No | Maximum bonding curve completion percentage. Value range: 0–100. | | minMarketCapUsd | String | No | Minimum market capitalization in USD. e.g., `"50000"` means market cap ≥ $50,000. | | maxMarketCapUsd | String | No | Maximum market capitalization in USD. | | minVolumeUsd | String | No | Minimum 24-hour trading volume in USD. | | maxVolumeUsd | String | No | Maximum 24-hour trading volume in USD. | | minHolders | String | No | Minimum number of unique token holders. e.g., `"100"` means at least 100 holders. | | maxHolders | String | No | Maximum number of unique token holders. | | minTokenAge | String | No | Minimum token age in minutes. When `stage=MIGRATED`, counted from migration timestamp; otherwise from creation timestamp. e.g., `"60"` means at least 1 hour old. | | maxTokenAge | String | No | Maximum token age in minutes. When `stage=MIGRATED`, counted from migration timestamp; otherwise from creation timestamp. | | minBuyTxCount | String | No | Minimum number of buy transactions in the last 1 hour. | | maxBuyTxCount | String | No | Maximum number of buy transactions in the last 1 hour. | | minSellTxCount | String | No | Minimum number of sell transactions in the last 1 hour. | | maxSellTxCount | String | No | Maximum number of sell transactions in the last 1 hour. | | minTokenSymbolLength | String | No | Minimum length of the token ticker symbol. e.g., `"3"` means symbol has at least 3 characters. | | maxTokenSymbolLength | String | No | Maximum length of the token ticker symbol. | | hasAtLeastOneSocialLink | Boolean | No | Filter by whether the token has at least one social media link. `true` = must have at least one social link. | | hasX | Boolean | No | Filter by whether the token has an X (Twitter) link. `true` = must have X link. | | hasTelegram | Boolean | No | Filter by whether the token has a Telegram link. `true` = must have Telegram link. | | hasWebsite | Boolean | No | Filter by whether the token has an official website link. `true` = must have a website. | | websiteTypeList | String | No | Comma-separated website type codes. Enum: `0` = official website, `1` = YouTube, `2` = Twitch, `3` = Facebook, `4` = Instagram, `5` = TikTok, `6` = Discord, `7` = GitHub. e.g., `"1,6"` for tokens with YouTube or Discord links. | | dexScreenerPaid | Boolean | No | Filter by whether the token has paid for DexScreener promotion. `true` = only tokens that have paid for DexScreener. | | liveOnPumpFun | Boolean | No | Filter by whether the token is currently live streaming on PumpFun. `true` = only tokens with active PumpFun live stream. | | bagsFeeClaimed | Boolean | No | Filter by whether the developer has claimed bags fees (royalties). `true` = developer has claimed fees. | | devSellAll | Boolean | No | Filter by whether the developer has sold all their token holdings. `true` = developer has sold everything. | | devStillHolding | Boolean | No | Filter by whether the developer is still holding tokens. `true` = developer still holds tokens. | | keywordsInclude | String | No | Filter tokens whose name or symbol contains the specified keyword. Case-insensitive. e.g., `"dog"` matches `"DOGE"`, `"DogWifHat"`. | | keywordsExclude | String | No | Exclude tokens whose name or symbol contains the specified keyword. Case-insensitive. | ## Response Parameters | Parameter | Type | Description | |------------------------------------|---------|-------------------------------------------------------------------------------| | cursor | String | Pagination cursor for the next page. Empty if no more data. | | items | Array | Token list. | | >chainIndex | String | Chain ID (e.g., `501` = Solana). | | >protocolId | String | Protocol ID (e.g., `1` = PUMP_FUN). | | >quoteTokenAddress | String | Quote token contract address. | | >tokenContractAddress | String | Token contract address. | | >symbol | String | Token symbol. | | >name | String | Token name. | | >logoUrl | String | Token logo URL. | | >createdTimestamp | String | Token creation time (millisecond timestamp). | | >market | Object | Market data. | | >>marketCapUsd | String | Market cap (USD). | | >>volumeUsd1h | String | 1h trading volume (USD). | | >>txCount1h | String | 1h total transaction count. | | >>buyTxCount1h | String | 1h buy transaction count. | | >>sellTxCount1h | String | 1h sell transaction count. | | >bondingPercent | String | Bonding curve progress (%). | | >mayhemModeTimeRemaining | String | Pump.fun Mayhem Mode remaining time. Empty if not applicable. | | >tags | Object | Audit / tag data. | | >>top10HoldingsPercent | String | Top 10 holders' combined holdings (%). | | >>devHoldingsPercent | String | Developer holdings (%). | | >>insidersPercent | String | Insiders holdings (%). | | >>bundlersPercent | String | Bundlers holdings (%). | | >>snipersPercent | String | Snipers holdings (%). | | >>freshWalletsPercent | String | Fresh wallets holdings (%). | | >>suspectedPhishingWalletPercent | String | Suspected phishing wallets (%). | | >>totalHolders | String | Total number of holder addresses. | | >social | Object | Social media info. | | >>x | String | X (Twitter) link. | | >>telegram | String | Telegram link. | | >>website | String | Website link. | | >>websiteType | String | Website type identifier. | | >>dexScreenerPaid | Boolean | Whether DEX Screener ads are active. | | >>communityTakeover | Boolean | Community takeover (CTO) flag. | | >>liveOnPumpFun | Boolean | Live on Pump.fun flag. | | >bagsFeeClaimed | Boolean | Whether bags fee has been claimed. | | >aped | String | Number of co-invested (aped) wallets. | | >migratedBeginTimestamp | String | Migration start time (ISO 8601). | | >migratedEndTimestamp | String | Migration end time (ISO 8601). | | >creatorAddress | String | Token creator wallet address. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/memepump/tokenList?chainIndex=501&protocolId=1&sort=createdTimestamp&order=desc&limit=30' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "cursor": "eyJsYXN0SWQiOiI3R2Y5Li4ucHVtcCJ9", "items": [ { "chainIndex": "501", "protocolId": "1", "quoteTokenAddress": "11111111111111111111111111111111", "tokenContractAddress": "7Gf9...pump", "symbol": "TETANUS", "name": "tetanus", "logoUrl": "https://static.okx.com/cdn/assets/imgs/xxx.png", "createdTimestamp": "1730000000000", "market": { "marketCapUsd": "154880.12", "volumeUsd1h": "50231.11", "txCount1h": "225", "buyTxCount1h": "128", "sellTxCount1h": "97" }, "bondingPercent": "63.5", "mayhemModeTimeRemaining": "", "tags": { "top10HoldingsPercent": "0.12", "devHoldingsPercent": "0.10", "insidersPercent": "0.23", "bundlersPercent": "0.48", "snipersPercent": "0.35", "freshWalletsPercent": "0.50", "suspectedPhishingWalletPercent": "0.00", "totalHolders": "2080" }, "social": { "x": "https://x.com/xxxx", "telegram": "https://t.me/xxxx", "website": "https://xxxx.com", "websiteType": "1", "dexScreenerPaid": false, "communityTakeover": false, "liveOnPumpFun": true }, "bagsFeeClaimed": false, "aped": "12", "migratedBeginTimestamp": "", "migratedEndTimestamp": "", "creatorAddress": "3kXoZt...q1Re" } ] } } ``` - [Get Token Details](https://web3pre.okex.org/onchainos/dev-docs/market/market-memepump-get-token-details.md) {/* api-page */} # Get Token Details Retrieve Meme Pump scanner data for a specified token. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/memepump/tokenDetails` ## Request Parameters | Parameter | Type | Required | Description | |-----------------------|--------|----------|------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Chain unique identifier (e.g., `501` = Solana). Only single-chain queries are supported. | | tokenContractAddress | String | Yes | Token contract address. | | walletAddress | String | Yes | User's wallet address. When provided, response will include user-specific position and P&L data for this token. | ## Response Parameters Same fields as individual items in the [Get Token List](#get-token-list) response, returned as a single object. | Parameter | Type | Description | |------------------------------------|---------|-------------------------------------------------------------------------------| | chainIndex | String | Chain ID (e.g., `501` = Solana). | | protocolId | String | Protocol ID (e.g., `1` = PUMP_FUN). | | quoteTokenAddress | String | Quote token contract address. | | tokenContractAddress | String | Token contract address. | | symbol | String | Token symbol. | | name | String | Token name. | | logoUrl | String | Token logo URL. | | createdTimestamp | String | Token creation time (millisecond timestamp). | | market | Object | Market data. | | >marketCapUsd | String | Market cap (USD). | | >volumeUsd1h | String | 1h trading volume (USD). | | >txCount1h | String | 1h total transaction count. | | >buyTxCount1h | String | 1h buy transaction count. | | >sellTxCount1h | String | 1h sell transaction count. | | bondingPercent | String | Bonding curve progress (%). | | mayhemModeTimeRemaining | String | Pump.fun Mayhem Mode remaining time. Empty if not applicable. | | tags | Object | Audit / tag data. | | >top10HoldingsPercent | String | Top 10 holders' combined holdings (%). | | >devHoldingsPercent | String | Developer holdings (%). | | >insidersPercent | String | Insiders holdings (%). | | >bundlersPercent | String | Bundlers holdings (%). | | >snipersPercent | String | Snipers holdings (%). | | >freshWalletsPercent | String | Fresh wallets holdings (%). | | >suspectedPhishingWalletPercent | String | Suspected phishing wallets (%). | | >totalHolders | String | Total number of holder addresses. | | social | Object | Social media info. | | >x | String | X (Twitter) link. | | >telegram | String | Telegram link. | | >website | String | Website link. | | >websiteType | String | Website type identifier. | | >dexScreenerPaid | Boolean | Whether DEX Screener ads are active. | | >communityTakeover | Boolean | Community takeover (CTO) flag. | | >liveOnPumpFun | Boolean | Live on Pump.fun flag. | | bagsFeeClaimed | Boolean | Whether bags fee has been claimed. | | aped | String | Number of co-invested (aped) wallets. | | migratedBeginTimestamp | String | Migration start time (ISO 8601). | | migratedEndTimestamp | String | Migration end time (ISO 8601). | | creatorAddress | String | Token creator wallet address. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/memepump/tokenDetails?chainIndex=501&tokenContractAddress=7Gf9...pump' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "chainIndex": "501", "protocolId": "1", "quoteTokenAddress": "11111111111111111111111111111111", "tokenContractAddress": "7Gf9...pump", "symbol": "TETANUS", "name": "tetanus", "logoUrl": "https://static.okx.com/cdn/assets/imgs/xxx.png", "createdTimestamp": "1730000000000", "market": { "marketCapUsd": "154880.12", "volumeUsd1h": "50231.11", "txCount1h": "225", "buyTxCount1h": "128", "sellTxCount1h": "97" }, "bondingPercent": "63.5", "mayhemModeTimeRemaining": "", "tags": { "top10HoldingsPercent": "0.12", "devHoldingsPercent": "0.10", "insidersPercent": "0.23", "bundlersPercent": "0.48", "snipersPercent": "0.35", "freshWalletsPercent": "0.50", "suspectedPhishingWalletPercent": "0.00", "totalHolders": "2080" }, "social": { "x": "https://x.com/xxxx", "telegram": "https://t.me/xxxx", "website": "https://xxxx.com", "websiteType": "1", "dexScreenerPaid": false, "communityTakeover": false, "liveOnPumpFun": true }, "bagsFeeClaimed": false, "aped": "12", "migratedBeginTimestamp": "", "migratedEndTimestamp": "", "creatorAddress": "3kXoZt...q1Re" } } ``` - [Get Token Developer Info](https://web3pre.okex.org/onchainos/dev-docs/market/market-memepump-get-token-developer-info.md) {/* api-page */} # Get Token Developer Info Retrieve developer-related data for a specified token. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/memepump/tokenDevInfo` ## Request Parameters | Parameter | Type | Required | Description | |-----------------------|--------|----------|------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Chain unique identifier (e.g., `501` = Solana). Only single-chain queries are supported. | | tokenContractAddress | String | Yes | Token contract address. | ## Response Parameters | Parameter | Type | Description | |-----------------------|--------|------------------------------------------------------------------------| | devLaunchedInfo | Object | Summary of tokens launched by this developer. | | >totalToken | String | Total number of tokens launched by this developer. | | >rugPullCount | String | Number of rug pulls. | | >migratedCount | String | Number of successfully migrated tokens. | | >goldenGemCount | String | Number of golden gem tokens. | | devHoldingInfo | Object | Developer's current holding info for this token. | | >devHoldingPercent | String | Developer's current holdings (%). | | >devAddress | String | Developer wallet address. | | >fundingAddress | String | Funding source wallet address. | | >devBalance | String | Developer's native token balance. | | >lastFundedTimestamp | String | Last time the developer wallet was funded (ISO 8601). | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/memepump/tokenDevInfo?chainIndex=501&tokenContractAddress=7Gf9...pump' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "devLaunchedInfo": { "totalToken": "18", "rugPullCount": "3", "migratedCount": "11", "goldenGemCount": "2" }, "devHoldingInfo": { "devHoldingPercent": "2.35", "devAddress": "3kXoZt...q1Re", "fundingAddress": "Fv8N...tuQ", "devBalance": "0.064", "lastFundedTimestamp": "2025-06-26T06:37:39Z" } } } ``` - [Get Similar Tokens](https://web3pre.okex.org/onchainos/dev-docs/market/market-memepump-get-similar-tokens.md) {/* api-page */} # Get Similar Tokens Retrieve tokens similar to the specified token. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/memepump/similarToken` ## Request Parameters | Parameter | Type | Required | Description | |-----------------------|--------|----------|------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Chain unique identifier (e.g., `501` = Solana). Only single-chain queries are supported. | | tokenContractAddress | String | Yes | Token contract address. | ## Response Parameters | Parameter | Type | Description | |-----------------------|--------|--------------------------------------------------| | similarToken | Array | List of similar tokens. | | >tokenContractAddress | String | Token contract address. | | >tokenSymbol | String | Token symbol. | | >tokenLogo | String | Token logo URL. | | >marketCapUsd | String | Market cap (USD). | | >lastTxTimestamp | String | Last transaction time (ISO 8601). | | >createdTimestamp | String | Token creation time (ISO 8601). | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/memepump/similarToken?chainIndex=501&tokenContractAddress=7Gf9...pump' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "similarToken": [ { "tokenContractAddress": "8Hd92...xYp1", "tokenSymbol": "TETAX", "tokenLogo": "https://static.okx.com/cdn/assets/imgs/tetax.png", "marketCapUsd": "245800.32", "lastTxTimestamp": "2025-03-08T12:45:21Z", "createdTimestamp": "2025-03-01T08:00:00Z" }, { "tokenContractAddress": "9Ks81...LpQ9", "tokenSymbol": "TETAN", "tokenLogo": "https://static.okx.com/cdn/assets/imgs/tetan.png", "marketCapUsd": "158920.00", "lastTxTimestamp": "2025-03-08T12:40:10Z", "createdTimestamp": "2025-02-28T15:12:00Z" } ] } } ``` - [Get Token Bundle Details](https://web3pre.okex.org/onchainos/dev-docs/market/market-memepump-get-token-bundle-details.md) {/* api-page */} # Get Token Bundle Details Retrieve bundler-related data for a specified token. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/memepump/tokenBundleInfo` ## Request Parameters | Parameter | Type | Required | Description | |-----------------------|--------|----------|------------------------------------------------------------------------------------------| | chainIndex | String | Yes | Chain unique identifier (e.g., `501` = Solana). Only single-chain queries are supported. | | tokenContractAddress | String | Yes | Token contract address. | ## Response Parameters | Parameter | Type | Description | |----------------------|--------|-----------------------------------------------------| | bundlerAthPercent | String | Bundlers' all-time-high combined holdings (%). | | totalBundlers | String | Total number of bundler addresses. | | bundledValueNative | String | Total bundled amount in native token. | | bundledTokenAmount | String | Total bundled token amount. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/memepump/tokenBundleInfo?chainIndex=501&tokenContractAddress=7Gf9...pump' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "bundlerAthPercent": "0.92", "totalBundlers": "9", "bundledValueNative": "375", "bundledTokenAmount": "4880000" } } ``` - [Get Token Aped Wallet Details](https://web3pre.okex.org/onchainos/dev-docs/market/market-memepump-get-token-aped-wallet-details.md) {/* api-page */} # Get Token Aped Wallet Details Retrieve co-invested ("aped") wallet data for a specified token,with a maximum limit of 50 entries. ## Request URL GET `https://web3.okx.com/api/v6/dex/market/memepump/apedWallet` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier for the blockchain network. e.g., `501` = Solana, `56` = BSC. Only single-chain queries are supported. | | tokenContractAddress | String | Yes | The contract address of the token to query aped wallet list for. | | walletAddress | String | No | User's wallet address. When provided, the response will highlight whether the user's wallet is among the aped wallets. | ## Response Parameters | Parameter | Type | Description | |------------------|--------|----------------------------------------------------------------------| | apedWalletList | Array | List of co-invested wallets. | | >walletAddress | String | Wallet address. | | >walletType | String | Wallet type. Enum: `SMART_MONEY`, `INFLUENCER`, `NORMAL`. | | >holdingUsd | String | Current holdings value (USD). | | >holdingPercent | String | Current holdings as a percentage of total supply (%). | | >totalPnl | String | Total profit and loss (USD). | | >pnlPercent | String | PnL as a percentage (%). | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/memepump/apedWallet?chainIndex=501&tokenContractAddress=7Gf9...pump' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "apedWalletList": [ { "walletAddress": "9xK3ab...Tg91", "walletType": "SMART_MONEY", "holdingUsd": "12450.32", "holdingPercent": "1.28", "totalPnl": "5320.11", "pnlPercent": "74.32" }, { "walletAddress": "3Lm92Q...Hs77", "walletType": "INFLUENCER", "holdingUsd": "8420.50", "holdingPercent": "0.86", "totalPnl": "2100.00", "pnlPercent": "33.18" } ] } } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/market-scan-chain-error-code.md) # Error Codes ## API error handling | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------------------------------| | 0 | 200 | Succeeded | | 50011 | 429 | Rate limit reached. Please refer to API documentation and throttle requests accordingly | | 50014 | 400 | Parameter \{param0\} cannot be empty | | 50026 | 500 | System error. Try again later | | 50103 | 401 | Request header "OK-ACCESS-KEY" cannot be empty | | 50104 | 401 | Request header "OK-ACCESS-PASSPHRASE" cannot be empty| | 50105 | 401 | Request header "OK-ACCESS-PASSPHRASE" incorrect | | 50106 | 401 | Request header "OK-ACCESS-SIGN" cannot be empty | | 50107 | 401 | Request header "OK-ACCESS-TIMESTAMP" cannot be empty | | 50111 | 401 | Invalid OK-ACCESS-KEY | | 50112 | 401 | Invalid OK-ACCESS-TIMESTAMP | | 50113 | 401 | Invalid signature | | 51000 | 400 | Parameter \{param0\} error | ## Payment error handling | Error Message | Meaning | Troubleshooting Action | |------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | Empty / null response | Request did not include PAYMENT-SIGNATURE or X-PAYMENT header | Include PAYMENT-SIGNATURE or X-PAYMENT in the request after signing | | invalid payment header | PAYMENT-SIGNATURE content is invalid | Check for truncation / encoding issues / multiple base64 nesting | | param_mismatch | Missing required fields or invalid parameters (address / nonce format) | Verify that parameters in the signature match the expected values | | toAddr mismatch | PayTo address does not match or is zero address | Ensure the address matches exactly and is not 0x0000… | | amount mismatch | Signed amount does not match returned amount | Ensure value in EIP-3009 signature equals the returned amount | | unsupported_chain | Parsed chainIndex from network is not supported | Currently only X Layer (eip155:196) is supported | | payer_blocked | authorization.from triggered risk control rules | Contact OKX support / risk team | | risk_address | payer or payTo is flagged (blacklist / sanctioned address) | Use a different address | | resource mismatch | Signed URL does not match request URL | Use the exact request URL when signing; do not reuse payload | | no matching payment option | Payment token does not match required token | Sign using the token specified in the response | | invalid_signature | Invalid signature format (length, r/s range, v value, etc.) | Use OKXEvmSigner; avoid manual EIP-712 construction | | not_yet_valid | validAfter > now | Check system time | | expired | `validBefore <= now` | Check system time | | invalid signature, nonce_used | Nonce already used on-chain | Generate a new 32-byte nonce and sign again | | insufficient_balance | Insufficient balance | Fund the account or reduce concurrent payments | | onchain_error | On-chain RPC / multicall failure | Retry the request | | payment processing | Duplicate request within cache window | Avoid reusing the same signature within cache period | - [Usage Guide](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-usage-guide.md) # Usage Guide The Onchain Core Data API provides public-chain summaries, blocks, transactions, event logs, and address data. Always discover support for the target endpoint before calling it. Support for a chain in one module does not imply support in another module. ## API references ## Quick start ### Request conventions - Base URL: `https://web3.okx.com` - `chainIndex` is a numeric string, such as `1` for Ethereum and `0` for Bitcoin. Chain names are not accepted. - Time parameters use Unix timestamps in milliseconds, such as `1597026383085`. - Every request requires `OK-ACCESS-KEY`, `OK-ACCESS-SIGN`, `OK-ACCESS-TIMESTAMP`, and `OK-ACCESS-PASSPHRASE`. - Generate the signature from the method, path, query, body, and timestamp of the current request. Do not reuse it across URLs or pages. - Successful responses use a `code`, `msg`, and `data` envelope. `code` is a string. ### Recommended request flow 1. Convert the input chain name to a `chainIndex`. 2. Call the target module's `supported-chains` endpoint. 3. Match both `apiName` and `chainIndex` in the response. 4. Call the target endpoint only after a match; otherwise return that the endpoint does not currently support the chain. 5. Split batch parameters and block ranges according to endpoint limits. 6. Return each `cursor` unchanged until the response `cursor` is an empty string. ## Composed scenarios | Goal | Calls in order | Key handling | |---|---|---| | Multi-chain overview | 1. `info/supported-chains`
2. Call `info/summary`, `info/block`, `info/transaction`, and `info/address` in parallel
3. Use `info/stats` for trends | Validate each `apiName + chainIndex`; preserve successful cards when one call fails; keep statistics ranges within one year | | Time to block and transactions | 1. `block/supported-chains`
2. `block/block-height-by-time`
3. Pass the returned height to `block/block-fills` and `block/transaction-list` | `closest=before` selects the nearest earlier block; `after` selects the nearest later block | | Complete transaction view | 1. Discover transaction and log support separately
2. `transaction/transaction-multi`
3. Call `internal-transaction-multi`, `token-transfer-multi`, and `log/by-transaction` in parallel | Send at most 20 hashes per batch; if logs are unsupported, return the base transaction and mark logs as `unsupported` | | Address profile | 1. `address/address-active-chain`
2. Validate support per module
3. Call `address/information-evm`, both address-transaction endpoints, and `block/address-balance-history` | Send at most 50 addresses per batch and 10,000 blocks per range; do not call `information-evm` for non-EVM addresses | | Contract event monitor | 1. `log/supported-chains`
2. `log/by-address-and-topic`
3. Paginate by `cursor` | Continue while the `cursor` is non-empty; deduplicate by `chainIndex + txId + logIndex` | | Multi-address fund flows | 1. Split addresses into groups of 50
2. Split blocks into windows of 10,000
3. Call both address-transaction endpoints for every slice
4. Merge and deduplicate | Paginate each slice serially; run independent slices concurrently within rate limits; use `isFromOrTo` for direction | ## Supported-chain mapping ### Discover support by module | Module | Discovery endpoint | Endpoints validated | |---|---|---| | Public chain info | `/api/v6/explorer/info/supported-chains` | `/info/*` | | Block | `/api/v6/explorer/block/supported-chains` | `/block/*` | | Transaction | `/api/v6/explorer/transaction/supported-chains` | `/transaction/*` | | Event log | `/api/v6/explorer/log/supported-chains` | `/log/*` | | Address | `/api/v6/explorer/address/supported-chains` | `/address/*` | Store the response as a `supported[(module, apiName, chainIndex)] = true` set. For example, before calling `/api/v6/explorer/transaction/transaction-multi`, check `supported[("transaction", "transaction-multi", "1")]`. ### apiName-to-endpoint mapping | Module | apiName | Endpoint path | |---|---|---| | info | `detail` | `/api/v6/explorer/info/detail` | | info | `summary` | `/api/v6/explorer/info/summary` | | info | `transaction` | `/api/v6/explorer/info/transaction` | | info | `block` | `/api/v6/explorer/info/block` | | info | `address` | `/api/v6/explorer/info/address` | | info | `stats` | `/api/v6/explorer/info/stats` | | info | `hashes` | `/api/v6/explorer/info/hashes` | | block | `block-list` | `/api/v6/explorer/block/block-list` | | block | `block-fills` | `/api/v6/explorer/block/block-fills` | | block | `transaction-list` | `/api/v6/explorer/block/transaction-list` | | block | `block-height-by-time` | `/api/v6/explorer/block/block-height-by-time` | | block | `block-stats` | `/api/v6/explorer/block/block-stats` | | block | `address-balance-history` | `/api/v6/explorer/block/address-balance-history` | | transaction | `transaction-multi` | `/api/v6/explorer/transaction/transaction-multi` | | transaction | `internal-transaction-multi` | `/api/v6/explorer/transaction/internal-transaction-multi` | | transaction | `token-transfer-multi` | `/api/v6/explorer/transaction/token-transfer-multi` | | transaction | `normal-transaction-list-multi` | `/api/v6/explorer/transaction/normal-transaction-list-multi` | | transaction | `token-transaction-list-multi` | `/api/v6/explorer/transaction/token-transaction-list-multi` | | log | `by-block-and-address` | `/api/v6/explorer/log/by-block-and-address` | | log | `by-address-and-topic` | `/api/v6/explorer/log/by-address-and-topic` | | log | `by-address` | `/api/v6/explorer/log/by-address` | | log | `by-transaction` | `/api/v6/explorer/log/by-transaction` | | address | `address-active-chain` | `/api/v6/explorer/address/address-active-chain` | | address | `information-evm` | `/api/v6/explorer/address/information-evm` | Use `address/information-evm`, event-log endpoints, and endpoints marked EVM-only only after the relevant support response confirms the chain. On `50038`, refresh support for the current module instead of permanently marking the chain as globally unsupported. See the appendix for the complete name mapping. ## Pagination, batches, and ranges ### Cursor pagination 1. Omit `cursor` on the first request. 2. Pass the returned `cursor` unchanged on the next request; do not convert it to a page number. 3. Stop when `cursor` is an empty string. 4. For log endpoints, continue when `logList` is empty but `cursor` is non-empty. 5. Paginate serially within one `cursor` chain. Independent queries can run concurrently within the rate-limit budget. ### Request limits | Parameter or scenario | Limit | |---|---| | `transaction-multi.txId` | Comma-separated, at most 20; duplicates are removed | | `internal-transaction-multi.txId` | Comma-separated, at most 20 | | `token-transfer-multi.txId` | Comma-separated, at most 20 | | Address transaction query `address` | Comma-separated, at most 50 | | `tokenContractAddress` filter | At most 50 contracts | | `startBlockHeight` to `endBlockHeight` | At most 10,000 blocks | | Standard `cursor` `limit` | Default 20, maximum 100 | | Log scanning `limit` | Default 100, maximum 1,000 | | `info/stats` time range | At most one year | Split oversized input on the client. Deduplicate merged results by transaction hash, log index, or another documented business key. ## Appendix: complete chainName-to-chainIndex mapping Use this table to convert a chain name or alias to a candidate `chainIndex`. It includes mainnets, testnets, and historical names. It is not an endpoint-support list; before making a business request, match both `apiName` and `chainIndex` through the corresponding module's `supported-chains` endpoint. Some names identify different networks or historical registry entries, including `CORE=70000025` and `CORE_EVM=1116`, `CRO=25` and `CRO_COSMOS=394`, and `CFX=1030` and `Conflux=503`. Resolve ambiguous names from the network context instead of guessing from the display name alone. | chainName | chainIndex | chainName | chainIndex | |---|---:|---|---:| | ACT | `666` | ADA | `1815` | | ALGO | `283` | ARB_ETH | `42161` | | ARDR | `16754` | ARK | `111` | | ASP | `70000008` | ASTR_DOT | `70000090` | | ATOM | `118` | AURORA_ETH | `1313161554` | | AVAX | `43114` | AXL | `718` | | BCH | `145` | BITCI | `70000006` | | BNB | `56` | BOBA_ETH | `288` | | BRISE | `32520` | BSV | `236` | | BTC | `0` | BTS | `308` | | CELO | `42220` | CFX | `1030` | | CHZ | `2182` | CRO | `25` | | CUBE | `1818` | DASH | `5` | | DOT | `354` | ECH | `70000005` | | ECOC | `70000009` | EGLD | `70000003` | | ELA | `20` | EOS | `194` | | ETC | `61` | ETH | `1` | | ETL | `70000010` | EVER | `396` | | EVMOS | `710` | FLOW | `539` | | FSN | `32659` | FTM | `250` | | FUSE | `122` | GLMR | `1284` | | GO | `60` | GT | `86` | | GXC | `2303` | HIVE | `70000004` | | HOO | `70` | HT | `128` | | HTML | `172` | ICX | `74` | | INT | `70000007` | IOST | `291` | | IOTX | `4689` | JUNO | `709` | | KAI | `70000002` | KAR | `686` | | KAVA | `459` | KCS | `321` | | Kaia(KLAY) | `8217` | KSM | `434` | | LTC | `2` | LUNC | `70000001` | | MAN | `318` | MATIC | `137` | | METIS | `1088` | MOVR | `1285` | | MTR | `82` | NAS | `2718` | | NBT | `12` | NEAR | `397` | | NULS | `8964` | NXT | `29` | | OKT | `66` | ONE | `1666600000` | | ONT | `1024` | OP_ETH | `10` | | OSMO | `706` | QTUM | `2301` | | RON | `2020` | ROSE | `474` | | SCRT | `529` | SDN | `336` | | SGB | `19` | SOL | `501` | | STARKNET | `9004` | STARS | `563` | | STX | `5757` | THETA | `361` | | TLOS | `40` | TOMO | `88` | | TRC | `83` | TRX | `195` | | UBQ | `8` | VET | `818` | | VITE | `666666` | VLX | `106` | | WAN | `5718350` | WAVES | `5741564` | | WAX | `708` | XCP | `9` | | XDAI | `100` | XDC | `50` | | XEM | `43` | XHB | `3030` | | XLM | `70000088` | XOR | `617` | | XRP | `144` | XTZ | `1729` | | ZEC | `133` | ZIL | `313` | | APT | `637` | KUJI | `70000011` | | AKT | `70000012` | ABT | `260` | | ACA | `787` | AERGO | `441` | | ALPHA | `622` | AR | `472` | | BAND | `494` | BCD | `999` | | BHP | `547` | BNT | `483` | | BTG | `156` | BTM | `153` | | CFG | `747` | CMT | `1122` | | CSPR | `506` | CTC | `583` | | DCR | `42` | DMD | `152` | | DOGE | `3` | EFI | `1155` | | ELF | `1616` | HC(HSR) | `171` | | HYC | `1397` | ICP | `70000048` | | IOTA | `4218` | KDA | `626` | | LAMB | `364` | LAT | `210425` | | LET | `518` | LSK(KLY) | `134` | | LUNA | `330` | MINA | `12586` | | RVN | `175` | SC | `1991` | | SRM | `573` | TON | `607` | | TRUE | `2049` | VSYS | `360` | | XCH | `8444` | XEC | `899` | | XMR | `70000013` | XNO | `165` | | YEE | `4096` | YOU | `534` | | ZEN | `121` | NRG | `39797` | | FCTID | `281` | KMD | `141` | | JEWEL | `53935` | mADA | `2001` | | XIN | `2365` | CANTO | `70000014` | | HYDRA | `609` | ARB_NOVA | `42170` | | SYS | `57` | CET | `52` | | FRA | `2152` | STRAT | `105` | | SX | `416` | ETP | `2302` | | RUNE | `931` | TT | `108` | | POLIS | `333999` | smartBCH | `10000` | | ETHW | `10001` | ENQ | `70000016` | | YOC | `70000017` | CELR | `70000018` | | SKL | `70000019` | ETHF | `513100` | | IRIS | `566` | IMX | `1761886` | | ERA_ETH | `324` | SUI | `784` | | DEV_SUI | `783` | FITFI | `1234` | | pCKB | `71402` | SERO | `569` | | CTXC | `70000021` | FLR | `14` | | PHA_KHA | `70000022` | CLV | `70000023` | | EM | `70000024` | CORE | `70000025` | | CORE_EVM | `1116` | YOYOW | `70000026` | | WTC | `70000027` | AAC | `512` | | ZKS | `13` | LITE_ETH | `805` | | FIL | `314` | UMEE | `70000028` | | CRO_COSMOS | `394` | POM | `18159` | | X1_TEST | `19500` | OKT_TEST | `65` | | GON_ETH | `1101` | SEI | `70000029` | | KAVA_EVM | `2222` | Conflux | `503` | | GOERLI_ETH | `70000030` | SEI_TEST | `70000031` | | BMTC | `4321` | ZETA_MAINNET | `7000` | | OMN | `408` | WEMIX | `1111` | | ROSE_EVM | `42262` | OAS | `70000033` | | XETA | `70000034` | BNC | `788` | | HASH | `505` | POKT | `635` | | DNA | `515` | DGB | `70000035` | | CKB | `309` | AVAX_X | `9000` | | WICC(WGRT) | `70000036` | FAN | `99999` | | PLS | `369` | ACE | `648` | | TIA | `70000037` | MNT | `5000` | | LINEA | `59144` | Base | `8453` | | BTC_TestNet | `70000038` | OP_BNB | `204` | | Sepolia | `11155111` | enj | `70000039` | | Beacon | `70000040` | scroll | `534352` | | injective | `70000041` | DYDX | `70000042` | | Kaspa | `111111` | Venom | `70000043` | | MANTA_ETH | `169` | HAQQ | `11235` | | NOSTR | `1237` | FacetVM | `70000044` | | hnt | `904` | gas_n3 | `888` | | astr_evm | `592` | FIL_EVM | `461` | | IMX_ZKEVM | `13371` | MXC | `18686` | | CHZ_V2 | `88888` | Mumbai_Testnet | `80001` | | PolygonzkEVM_Testnet | `1442` | ETHS | `70000045` | | BTC_src20 | `70000046` | Amoy_Testnet | `80002` | | BTC_Signet | `70000047` | DYM | `1100` | | Rangers | `2025` | Blast_Sepolia | `168587773` | | WEMIX3_Testnet | `1112` | Avocado | `634` | | zkSync_Sepolia | `300` | Shardeum_Sphinx | `8082` | | Mode | `34443` | MerLin | `4200` | | XION | `70000051` | XION_TEST | `70000052` | | DYM_TEST | `70000053` | Blast | `81457` | | Arbitrum_Sepolia | `421614` | LUMI | `94168` | | BBNylon_TEST | `70000054` | B2Network_TEST | `1102` | | BEVM_Canary | `1501` | TunaChain_TEST | `10123` | | XLayer_TEST | `196` | BITLAYER_BTC | `200901` | | B2Network | `223` | ZKLINK_ETH | `810180` | | Avail | `70000055` | ZETA_COSMOS | `70000050` | | STC | `70000056` | BOB_ETH | `60808` | | BounceBit_BTC | `6001` | TAIKO_ETH | `167000` | | SOL_Testnet | `70000057` | ZORA_ETH | `7777777` | | ONCHAIN_ETH | `27563` | OVER | `54176` | | BEVM_BTC | `11501` | frxETH | `252` | | MAT | `698` | KARAK_ETH | `2410` | | KROMA_ETH | `255` | Lisk | `1135` | | Sonic_Testnet | `70000058` | Sonic_Devnet | `70000059` | | EVM_SEI | `1329` | PLUME_ETH_TEST | `161221135` | | MOVEMENT_TestNet | `70000060` | B3_ETH | `8333` | | G | `1625` | FB | `70000061` | | APE | `33139` | WORLD | `480` | | RBTC | `30` | Sonic_Testnet_v1 | `70000062` | | TESTNET_IP | `1516` | Reya | `70000063` | | Zircuit | `48900` | CTK | `70000064` | | DORA_FACTORY | `70000065` | DuckChain_TON | `5545` | | HSK | `177` | MOVE | `70000066` | | SOON_testnet | `70000067` | Eclipse | `70000068` | | MINT_ETH | `185` | S | `146` | | PLUME_ETH | `98865` | XTERIO_BNB | `112358` | | SOON_mainnet | `70000069` | tbaby | `70000070` | | XYM | `70000071` | assetHub | `70000072` | | Abstract | `2741` | Soneium | `1868` | | Unite | `88899` | TESTNET_MON | `10143` | | SONIC_SOL | `70000130` | TESTNET_SAHARA | `313313` | | SOON_BNB | `70000075` | Plume | `98866` | | TAKER | `1125` | Endless | `70000076` | | BABY | `70000077` | ZKCANDY_ETH | `320` | | INIT | `70000078` | NERO | `1689` | | MEZO_BTC | `31612` | Noble | `70000079` | | BTT | `199` | HYPE_TEST | `998` | | assethub_ksm | `70000081` | FX | `530` | | VC | `207` | FLOW_EVM | `70000082` | | BOTANIX | `3637` | XLayer_testnet2 | `1952` | | GOAT_BTC | `2345` | USTC | `70000001` | | SOPH | `50104` | Mind | `228` | | Silicon | `2355` | Metadium | `11` | | AlephZero_EVM | `41455` | Ink | `57073` | | lens | `232` | redstone | `690` | | Etherlink | `42793` | Superposition | `55244` | | Swell | `1923` | Vana | `1480` | | Corn | `21000000` | Fuse | `122` | | Degen | `666666666` | Glue | `1300` | | Hemi | `43111` | Lightlink | `1890` | | Nibiru | `6900` | Peaq | `3338` | | RariChain | `1380012617` | Hedera | `295` | | Shibarium | `109` | RadixDLT | `70000083` | | MAYA | `70000084` | WITNESS | `1702448187` | | LUMIA | `994873017` | WIREX | `31415` | | HAUST | `938` | TERNOA | `752025` | | PENTAGON | `3344` | FORKNET | `838` | | ENI | `173` | MANTRA | `70000085` | | IOTA_MOVE | `70000086` | KATANA_ETH | `747474` | | MORPH_ETH | `2818` | XPL_Plasma | `9745` | | EVM_HYPE | `70000080` | 0G | `16661` | | FOGO | `70000087` | MemeCore | `4352` | | ShimmerEVM | `148` | MON | `143` | | CANTON | `70000089` | BITTENSOR | `964` | | STABLE | `988` | Mega_ETH | `4326` | | BRIDGE | `13441` | ZANO | `70000091` | | Gate_Layer | `10088` | PROS | `1672` | | Tempo | `4217` | Edge | `3343` | | Jovay | `5734951` | TradeZone | `70000196` | | TradeZoneTestNet | `70000195` | orbit | `70000092` | | KITE | `2366` | BittensorDot | `70000093` | | Gensyn | `685689` | xlayertest | `1952` | | HyperCore | `70000094` | MMPTestnet | `70000095` | | RobinhoodChain | `4663` | HPP | `190415` | - [Public Chain Info Reference](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-reference.md) # Public Chain Info Reference - [Get Public Chain Info API Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-supported-chains.md) {/* api-page */} # Get Public Chain Info API Supported Chains Retrieve the chains supported by each Chain Info API endpoint. Each response row represents one API-chain pair. ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/supported-chains` ## Request Parameters None. ## Response Parameters | Parameter | Type | Description | |---|---|---| | apiName | String | Module-local API name without the `info/` prefix, e.g., `detail`. | | chainIndex | String | Unique identifier of the chain, e.g., `1` for Ethereum. | | chainName | String | Chain name, e.g., `Ethereum`. | | chainSymbol | String | Native token symbol, e.g., `ETH`. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/supported-chains' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "apiName": "detail", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" }, { "apiName": "summary", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" } ] } ``` - [Get Public Chain Details](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-detail.md) {/* api-page */} # Get Public Chain Details Query basic details for a specific chain, including market cap rank, consensus algorithm, mining difficulty, supply, TPS, and latest block height. Supported chains: see [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) (`apiName`: `detail`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/detail` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) for supported values. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain. | | symbol | String | Native token of the chain. | | rank | String | Market cap rank of the chain. | | mineable | Boolean | Whether mining is supported, e.g., `true` / `false`. | | algorithm | String | Core algorithm, e.g., SHA-256. | | consensus | String | Consensus algorithm, e.g., PoW. | | diffEstimation | String | Estimated next mining difficulty. Unit for BTC: T. | | currentDiff | String | Current network-wide mining difficulty. | | diffAdjustTime | String | Time of the next mining difficulty adjustment. | | circulatingSupply | String | Circulating supply. | | totalSupply | String | Maximum supply. | | tps | String | On-chain transactions processed per second, averaged over the past week. | | lastHeight | String | Latest block height. | | lastBlockTime | String | Time of the previous block. Unix timestamp in milliseconds, e.g., 1597026383085. | | issueDate | String | Issue date. Unix timestamp in milliseconds, e.g., 1597026383085. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/detail?chainIndex=0' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "0", "symbol": "BTC", "rank": "1", "mineable": true, "algorithm": "SHA-256", "consensus": "PoW", "diffEstimation": "128.42", "currentDiff": "126.98", "diffAdjustTime": "1754563200000", "circulatingSupply": "19891234", "totalSupply": "21000000", "tps": "5.32", "lastHeight": "908123", "lastBlockTime": "1753690007000", "issueDate": "1231006505000" } ] } ``` - [Get Public Chain Summary](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-summary.md) {/* api-page */} # Get Public Chain Summary Query summary information for a chain, including latest block height, latest block time, circulating supply, and total transaction count. `chainIndex` is optional: if omitted, a summary for every supported chain is returned, one chain per row. Supported chains: see [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) (`apiName`: `summary`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/summary` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | No | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. If omitted, all supported chains are returned. See [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) for supported values. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain. | | symbol | String | Native token of the chain. | | lastHeight | String | Latest block height. | | lastBlockTime | String | Latest block time. | | circulatingSupply | String | Current circulating supply of the chain's native token. | | circulatingSupplyProportion | String | Circulating supply of the chain's native token as a proportion of total supply. | | transactions | String | Total transaction count. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/summary?chainIndex=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "1", "symbol": "ETH", "lastHeight": "22990123", "lastBlockTime": "1753690007000", "circulatingSupply": "120708026.34", "circulatingSupplyProportion": "", "transactions": "2915678123" } ] } ``` - [Get Public Chain Transaction Statistics](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-transaction.md) {/* api-page */} # Get Public Chain Transaction Statistics Query on-chain transaction statistics for a specific chain, including pending transaction count, 24-hour transaction volume, total transaction count, and average TPS. Supported chains: see [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) (`apiName`: `transaction`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/transaction` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) for supported values. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain. | | symbol | String | Native token of the chain. | | pendingTransactionCount | String | Number of pending transactions. | | transactionValue24h | String | 24-hour on-chain transaction volume. | | totalTransactionCount | String | Total on-chain transaction count. | | tranRate | String | Average TPS over the last 50 blocks. | | avgTransactionCount24h | String | 24-hour average transaction count. | | avgTransactionCount24hPercent | String | Change in the 24-hour average transaction count. | | pendingTransactionSize | String | Size of pending transactions. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/transaction?chainIndex=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "1", "symbol": "ETH", "pendingTransactionCount": "147583", "transactionValue24h": "2412345.8", "totalTransactionCount": "2915678123", "tranRate": "14.2", "avgTransactionCount24h": "1234567", "avgTransactionCount24hPercent": "0.023", "pendingTransactionSize": "" } ] } ``` - [Get Basic Block Statistics](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-block.md) {/* api-page */} # Get Basic Block Statistics Query basic block statistics for a specific chain, including latest block height, first block information, average block interval, and average block size. Supported chains: see [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) (`apiName`: `block`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/block` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) for supported values. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain. | | symbol | String | Native token of the chain. | | lastHeight | String | Latest block height. | | firstExchangeHistoricalTime | String | Time of the first transaction. Unix timestamp in milliseconds, e.g., 1597026383085. | | firstBlockTime | String | Time of the first block. Unix timestamp in milliseconds, e.g., 1597026383085. | | firstBlockHeight | String | Height of the first block. | | avgBlockInterval | String | Average block interval (past week). | | avgBlockSize24h | String | Average block size (24 hours). | | avgBlockSize24hPercent | String | Change in average block size. | | mediaBlockSize | String | Median block size (past week). | | halveTime | String | Halving time. Unix timestamp in milliseconds, e.g., 1597026383085. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/block?chainIndex=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "1", "symbol": "ETH", "lastHeight": "22990123", "firstExchangeHistoricalTime": "", "firstBlockTime": "1438269973000", "firstBlockHeight": "0", "avgBlockInterval": "12.08", "avgBlockSize24h": "78345", "avgBlockSize24hPercent": "0.0123", "mediaBlockSize": "72110", "halveTime": "" } ] } ``` - [Get Holder Address Statistics](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-address.md) {/* api-page */} # Get Holder Address Statistics Query address statistics for a specific chain, including the number of holder addresses, total addresses, contract addresses, external addresses, and active addresses, each with its 24-hour change. Supported chains: see [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) (`apiName`: `address`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/address` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) for supported values. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain. | | symbol | String | Native token of the chain. | | validAddressCount | String | Number of addresses holding the chain's native token. | | newAddressCount24h | String | Number of new holder addresses in the last 24 hours. | | totalAddresses | String | Total number of addresses on the chain. | | newTotalAddresses24h | String | Increase or decrease in total addresses over the last 24 hours. | | contractAddresses | String | Total number of contract addresses on the chain. | | newContractAddresses24h | String | Increase or decrease in contract addresses over the last 24 hours. | | externalAddresses | String | Number of external addresses. | | newExternalAddresses24h | String | Increase or decrease in external addresses over the last 24 hours. | | activeAddresses | String | Number of active addresses. | | newActiveAddresses | String | Increase or decrease in active addresses over the last 24 hours. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/address?chainIndex=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "1", "symbol": "ETH", "validAddressCount": "141234567", "newAddressCount24h": "98765", "totalAddresses": "331234567", "newTotalAddresses24h": "120345", "contractAddresses": "68123456", "newContractAddresses24h": "23456", "externalAddresses": "263111111", "newExternalAddresses24h": "96889", "activeAddresses": "512345", "newActiveAddresses": "-2345" } ] } ``` - [Get Historical Public Chain Statistics](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-stats.md) {/* api-page */} # Get Historical Public Chain Statistics Returns daily historical statistics for the specified chain, including daily new addresses, transaction count, contract calls, transaction fees, and network utilization, sorted by time in descending order with cursor-based pagination. Only supported on selected major chains. Supported chains: see [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) (`apiName`: `stats`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/stats` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) for supported values. | | startTime | String | No | Query start time in Unix timestamp milliseconds, e.g., 1597026383085. The span between startTime and endTime cannot exceed 1 year. | | endTime | String | No | Query end time. Returns statistics earlier than this date, in Unix timestamp milliseconds, e.g., 1597026383085. | | cursor | String | No | Pagination cursor. Omit for the first page; pass back the cursor from the previous response unchanged when paginating. | | limit | String | No | Number of results per page. Default 20, maximum 100. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of results per page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back unchanged — clients should not parse or construct it. | | statsHistoryList | Array | List of historical statistics. | | > time | String | Date at daily granularity, in Unix timestamp milliseconds, e.g., 1597026383085. | | > newAddressCount | String | Number of new addresses per day. | | > totalTransactionCount | String | Total number of transactions per day. | | > totalContractCalls | String | Total number of onchain contract calls per day. | | > transactionFee | String | Daily transaction fees paid to validators, denominated in the native token. | | > networkUtilization | String | Daily network utilization, i.e., total gas used / total gas limit per day. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/stats?chainIndex=1&limit=2' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "2", "cursor": "1753545600000", "statsHistoryList": [ { "time": "1753632000000", "newAddressCount": "95321", "totalTransactionCount": "1345678", "totalContractCalls": "2456789", "transactionFee": "1023.45", "networkUtilization": "0.5234" }, { "time": "1753545600000", "newAddressCount": "92104", "totalTransactionCount": "1312456", "totalContractCalls": "2401233", "transactionFee": "987.12", "networkUtilization": "0.5108" } ] } ] } ``` - [Get Basic Hash Rate Information](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-info-hashes.md) {/* api-page */} # Get Basic Hash Rate Information Query basic network hash rate information for a specific chain, including the past week's network hash rate and its 24-hour change. Only PoW chains provide meaningful hash rate data. Supported chains: see [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) (`apiName`: `hashes`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/info/hashes` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Chain Info API Supported Chains](../market/onchaindata-info-supported-chains) for supported values. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain. | | symbol | String | Native token of the chain. | | hashRate | String | Network hash rate over the past week. | | hashRateChange24h | String | 24-hour change in network hash rate, expressed as a decimal. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/info/hashes?chainIndex=0' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "0", "symbol": "BTC", "hashRate": "745.62 EH/s", "hashRateChange24h": "0.0231" } ] } ``` - [Block API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-reference.md) # Block API Reference - [Get Block API Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-supported-chains.md) {/* api-page */} # Get Block API Supported Chains Retrieve the chains supported by each Block API endpoint. Each response row represents one API-chain pair. ## Request URL GET `https://web3.okx.com/api/v6/explorer/block/supported-chains` ## Request Parameters None. ## Response Parameters | Parameter | Type | Description | |---|---|---| | apiName | String | Module-local API name without the `block/` prefix, e.g., `block-list`. | | chainIndex | String | Unique identifier of the chain, e.g., `1` for Ethereum. | | chainName | String | Chain name, e.g., `Ethereum`. | | chainSymbol | String | Native token symbol, e.g., `ETH`. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/block/supported-chains' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "apiName": "block-list", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" }, { "apiName": "block-fills", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" } ] } ``` - [Get Block List](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-block-list.md) {/* api-page */} # Get Block List Retrieve the block list for a specified chain, returned from newest to oldest by block height. Use the `height` parameter to locate the block at a specific height. Supported chains: see [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) (`apiName`: `block-list`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/block/block-list` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) for supported values. | | height | String | No | Block height (digits only). When provided, returns the block at that height; when omitted, returns the latest block list. | | cursor | String | No | Pagination cursor. Pass the cursor returned by the previous response; omit it on the first request. | | limit | String | No | Number of results to return. Defaults to the most recent 20, up to a maximum of 100. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of results per page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | chainIndex | String | Unique identifier of the chain. | | blockList | Array | Block list. | | > hash | String | Block hash. | | > height | String | Block height. | | > validator | String | Block producer / super node / validator. | | > blockTime | String | Block time, as a Unix timestamp in milliseconds, e.g., 1597026383085. | | > txnCount | String | Number of transactions contained in the block. | | > blockSize | String | Block size, in bytes. | | > mineReward | String | Block reward. Total block earnings equal mineReward + totalFee. | | > totalFee | String | Sum of all transaction fees in the block. | | > feeSymbol | String | Transaction fee currency. | | > avgFee | String | Average transaction fee per transaction. | | > ommerBlock | String | Number of ommer (uncle) blocks. | | > gasUsed | String | Gas used. | | > gasLimit | String | Gas limit. | | > gasAvgPrice | String | Average gas price. | | > state | String | Block state: `pending` when confirming, `done` when confirmed. Chains where this does not apply return an empty string `""`. | | > burnt | String | Amount of transaction fees burnt. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/block/block-list?chainIndex=1&limit=20' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "20", "cursor": "2", "chainIndex": "1", "blockList": [ { "hash": "0xba9ded5ca1ec9adb9451bf062c9de309d9552fa0f0254a7b982d3daf7ae436cd", "height": "19000000", "validator": "beaverbuild", "blockTime": "1705146239000", "txnCount": "150", "blockSize": "57619", "mineReward": "0.044304750347454041", "totalFee": "0.352967975656501696", "feeSymbol": "ETH", "avgFee": "0.0023", "ommerBlock": "0", "gasUsed": "12849554", "gasLimit": "30000000", "gasAvgPrice": "0.000000027468899821", "state": "", "burnt": "0.308663225309047655" } ] } ] } ``` - [Get Block Details](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-block-fills.md) {/* api-page */} # Get Block Details Retrieve the block header details for a block at a specified height, including the block producer, gas, difficulty, confirmations, and other complete fields. Supported chains: see [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) (`apiName`: `block-fills`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/block/block-fills` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) for supported values. | | height | String | Yes | Block height (digits only). | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain. | | hash | String | Block hash. | | height | String | Block height. | | validator | String | Block producer / super node / validator. | | blockTime | String | Block time, as a Unix timestamp in milliseconds, e.g., 1597026383085. | | txnCount | String | Number of transactions contained in the block. | | amount | String | Total transaction amount in the block. | | blockSize | String | Block size, in bytes. | | mineReward | String | Block reward. Total block earnings equal mineReward + totalFee. | | totalFee | String | Sum of all transaction fees in the block. | | feeSymbol | String | Transaction fee currency. | | ommerBlock | String | Number of ommer (uncle) blocks. | | merkleRootHash | String | Merkle root hash. | | gasUsed | String | Gas used. | | gasLimit | String | Gas limit. | | gasAvgPrice | String | Average gas price. | | state | String | Block state: `pending` when confirming, `done` when confirmed. Chains where this does not apply return an empty string `""`. | | burnt | String | Amount of transaction fees burnt. | | txnInternal | String | Number of internal transactions contained in the block. | | miner | String | Miner address hash. | | difficulty | String | Mining difficulty. | | nonce | String | On PoW blockchains, the nonce describes the mining difficulty. | | tips | String | Tips. | | confirm | String | Number of confirmations. | | baseFeePerGas | String | Base fee per gas. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/block/block-fills?chainIndex=1&height=19000000' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "1", "hash": "0xba9ded5ca1ec9adb9451bf062c9de309d9552fa0f0254a7b982d3daf7ae436cd", "height": "19000000", "validator": "beaverbuild", "blockTime": "1705146239000", "txnCount": "150", "amount": "213.6975", "blockSize": "57619", "mineReward": "0.044304750347454041", "totalFee": "0.352967975656501696", "feeSymbol": "ETH", "ommerBlock": "0", "merkleRootHash": "0x2f8b104344fca4fbca3b6ba1b46247ae2ac02c15dcd7a19b4549351c110c6c5a", "gasUsed": "12849554", "gasLimit": "30000000", "gasAvgPrice": "0.000000027468899821", "state": "", "burnt": "0.308663225309047655", "txnInternal": "46", "miner": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5", "difficulty": "0", "nonce": "0000000000000000", "tips": "0.000866267", "confirm": "1024", "baseFeePerGas": "0.000000024021260851" } ] } ``` - [Get Transactions in a Block](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-transaction-list.md) {/* api-page */} # Get Transactions in a Block Retrieve the transaction list within a specified block, with filtering by transaction type (regular transactions, internal transactions, token transfers, and more). Supported chains: see [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) (`apiName`: `transaction-list`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/block/transaction-list` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) for supported values. | | height | String | Yes | Block height (digits only). | | protocolType | String | No | Transaction type: `transaction` for regular transactions (default), `internal` for internal transactions, `token_transfer_20` for ERC-20 token transactions, `token_transfer_721` for ERC-721 token transactions, `token_transfer_1155` for ERC-1155 token transactions, `token_transfer_10` for TRC-10 token transactions. | | cursor | String | No | Pagination cursor. Pass the cursor returned by the previous response; omit it on the first request. | | limit | String | No | Number of results to return. Defaults to the most recent 20, up to a maximum of 100. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of results per page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | chainIndex | String | Unique identifier of the chain. | | transactionList | Array | Transaction list within the block. | | > txid | String | Transaction hash. | | > methodId | String | Method ID. | | > blockHash | String | Block hash. | | > height | String | Height of the block containing the transaction. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds, e.g., 1597026383085. | | > from | String | Sender address. | | > isFromContract | Boolean | Whether the `from` address is a contract address. | | > isToContract | Boolean | Whether the `to` address is a contract address. | | > to | String | Recipient address. | | > amount | String | Transaction amount. | | > transactionSymbol | String | Currency corresponding to the transaction amount. | | > txfee | String | Transaction fee. Returned only for regular transactions (`transaction`); an empty string `""` for other types. | | > state | String | Transaction state. | | > tokenId | String | NFT ID. | | > tokenContractAddress | String | Token contract address. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/block/transaction-list?chainIndex=1&height=19000000&protocolType=transaction' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "20", "cursor": "2", "chainIndex": "1", "transactionList": [ { "txid": "0x9a92dcd2a29ba1b195f6ee752f8be5da96b03b25ad38ae12de304a01048bf9c4", "methodId": "0xa9059cbb", "blockHash": "0xba9ded5ca1ec9adb9451bf062c9de309d9552fa0f0254a7b982d3daf7ae436cd", "height": "19000000", "transactionTime": "1705146239000", "from": "0x28c6c06298d514db089934071355e5743bf21d60", "isFromContract": false, "isToContract": true, "to": "0xdac17f958d2ee523a2206206994597c13d831ec7", "amount": "0", "transactionSymbol": "ETH", "txfee": "0.001744128940281", "state": "success", "tokenId": "", "tokenContractAddress": "" } ] } ] } ``` - [Get Block Height by Time](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-block-height-by-time.md) {/* api-page */} # Get Block Height by Time Retrieve the block height closest to a specified time. Use the `closest` parameter to select the nearest block before or after that time. Supported chains: see [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) (`apiName`: `block-height-by-time`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/block/block-height-by-time` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) for supported values. | | time | String | Yes | Target time, as a Unix timestamp in milliseconds, e.g., 1597026383085. | | closest | String | No | Either `before` or `after`, defaults to `before`. `before` returns the nearest block at or before the specified time; `after` returns the nearest block after the specified time. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | height | String | Height of the block closest to the specified time, in the direction given by `closest`. | | blockTime | String | Block time of that block, as a Unix timestamp in milliseconds, e.g., 1597026383085. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/block/block-height-by-time?chainIndex=1&time=1705146239000&closest=before' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "height": "19000000", "blockTime": "1705146239000" } ] } ``` - [Get Block Statistics](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-block-stats.md) {/* api-page */} # Get Block Statistics Retrieve daily historical block statistics for a chain, including the number of blocks produced, average block size, block rewards, and average block interval. Data is returned by date from most recent to oldest. Only some major chains are supported (BTC, ETH, TRON, and major EVM chains). Supported chains: see [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) (`apiName`: `block-stats`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/block/block-stats` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) for supported values. | | startTime | String | No | Query start time, as a Unix timestamp in milliseconds, e.g., 1597026383085. The interval between startTime and endTime must not exceed 1 year. | | endTime | String | No | Query end time, as a Unix timestamp in milliseconds, e.g., 1597026383085. The interval between startTime and endTime must not exceed 1 year. | | cursor | String | No | Pagination cursor. Pass the cursor returned by the previous response; omit it on the first request. | | limit | String | No | Number of results to return. Defaults to the most recent 20, up to a maximum of 100. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of results per page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | blockHistoryList | Array | Historical block statistics. | | > time | String | Date, at daily granularity, as a Unix timestamp in milliseconds, e.g., 1597026383085. | | > blockCount | String | Total number of blocks produced that day. | | > blockSize | String | Average block size that day, in bytes. | | > mineReward | String | Total block rewards that day. | | > rewardSymbol | String | Currency of the total block rewards that day. | | > avgBlockInterval | String | Average block interval that day, in seconds. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/block/block-stats?chainIndex=1&limit=20' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "20", "cursor": "MTcwNTA1OTgzOTAwMA", "blockHistoryList": [ { "time": "1705104000000", "blockCount": "7126", "blockSize": "98510", "mineReward": "327.5041", "rewardSymbol": "ETH", "avgBlockInterval": "12.12" }, { "time": "1705017600000", "blockCount": "7130", "blockSize": "97236", "mineReward": "331.2087", "rewardSymbol": "ETH", "avgBlockInterval": "12.11" } ] } ] } ``` - [Get Address Historical Balance](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-block-address-balance-history.md) {/* api-page */} # Get Address Historical Balance Retrieve an address's native coin or token balance at a specified block height (historical balance). This is a premium endpoint. Only some chains are supported (BTC, ETH, TRON, BSC, and others). Supported chains: see [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) (`apiName`: `address-balance-history`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/block/address-balance-history` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Block API Supported Chains](../market/onchaindata-block-supported-chains) for supported values. | | height | String | Yes | Block height (digits only). Returns the balance at that height. | | address | String | Yes | Address to query the balance for. | | tokenContractAddress | String | No | Token contract address. When omitted, returns the native coin balance. | | project | String | No | Project identifier. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | address | String | Address the balance was queried for. | | height | String | Block height the balance was queried at. | | balance | String | Balance. | | balanceRaw | String | Raw balance (no decimals, in the smallest unit). | | balanceSymbol | String | Balance currency: the native token name for a native coin query, or the token's abbreviated name for a specific token query. | | tokenContractAddress | String | Token contract address; an empty string `""` for a native coin query. | | blockTime | String | Block time of that block, as a Unix timestamp in milliseconds, e.g., 1597026383085. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/block/address-balance-history?chainIndex=1&height=19000000&address=0x28c6c06298d514db089934071355e5743bf21d60' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "address": "0x28c6c06298d514db089934071355e5743bf21d60", "height": "19000000", "balance": "123456.735278657822018352", "balanceRaw": "123456735278657822018352", "balanceSymbol": "ETH", "tokenContractAddress": "", "blockTime": "1705146239000" } ] } ``` - [Transaction API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-transaction-reference.md) # Transaction API Reference - [Get Transaction API Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-transaction-supported-chains.md) {/* api-page */} # Get Transaction API Supported Chains Retrieve the chains supported by each Transaction API endpoint. Each response row represents one API-chain pair. ## Request URL GET `https://web3.okx.com/api/v6/explorer/transaction/supported-chains` ## Request Parameters None. ## Response Parameters | Parameter | Type | Description | |---|---|---| | apiName | String | Module-local API name without the `transaction/` prefix, e.g., `transaction-multi`. | | chainIndex | String | Unique identifier of the chain, e.g., `1` for Ethereum. | | chainName | String | Chain name, e.g., `Ethereum`. | | chainSymbol | String | Native token symbol, e.g., `ETH`. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/transaction/supported-chains' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "apiName": "transaction-multi", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" }, { "apiName": "token-transfer-multi", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" } ] } ``` - [Batch Get Transaction Details](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-transaction-transaction-multi.md) {/* api-page */} # Batch Get Transaction Details Retrieve basic transaction details for multiple transaction hashes at once, with up to 20 hashes per request (comma-separated; duplicate hashes are deduplicated automatically). Results are returned as a flat array without pagination. This endpoint supports EVM chains only. Supported chains: see [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) (`apiName`: `transaction-multi`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/transaction/transaction-multi` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) for supported values. | | txId | String | Yes | Transaction hash. Separate multiple transactions with commas, up to 20; duplicate hashes are deduplicated automatically. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | txId | String | Transaction hash. | | methodId | String | Method ID; an empty string for non-contract calls. | | blockHash | String | Block hash. | | height | String | Height of the block containing the transaction. | | transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | from | String | Sender address. | | to | String | Recipient address. | | isFromContract | Boolean | Whether the `from` address is a contract address. | | isToContract | Boolean | Whether the `to` address is a contract address. | | amount | String | Transaction amount. | | symbol | String | Currency corresponding to the transaction amount. | | nonce | String | Sequence number of this transaction from the sender address. | | txFee | String | Transaction fee. | | gasPrice | String | Gas price. | | gasLimit | String | Gas limit. | | gasUsed | String | Gas used. | | state | String | Transaction state: `success` for succeeded, `fail` for failed, `pending` for awaiting confirmation. | | transactionType | String | Transaction type. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/transaction/transaction-multi?chainIndex=1&txId=0x1e4996d90e77ee87f6a1a2a071603ee5d55d6dd7b272209b741ff276f4a1c34c,0x8e2fbf59e7ffbc0d5cbb2a6e903824adecc9d2a5b78539e0bce9db32adfd85c9' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "txId": "0x1e4996d90e77ee87f6a1a2a071603ee5d55d6dd7b272209b741ff276f4a1c34c", "methodId": "0xa9059cbb", "blockHash": "0x7c1f0d95cbc7c4c018daae6cf3cf4ffef4dee62dfc9444838f4c5122a4899c9f", "height": "18126486", "transactionTime": "1694991899000", "from": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "to": "0xdac17f958d2ee523a2206206994597c13d831ec7", "isFromContract": false, "isToContract": true, "amount": "0", "symbol": "ETH", "nonce": "1057", "txFee": "0.001222264816491852", "gasPrice": "26510970622", "gasLimit": "63209", "gasUsed": "46106", "state": "success", "transactionType": "2" }, { "txId": "0x8e2fbf59e7ffbc0d5cbb2a6e903824adecc9d2a5b78539e0bce9db32adfd85c9", "methodId": "", "blockHash": "0x2b6cbc4bb2b6f52e7a2c11d4a9762dcefb985dbd6448bd41ce00cf50c02fca92", "height": "18126501", "transactionTime": "1694992079000", "from": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "to": "0x282edab8a933bc1c02649fe3ea2842ecb8e26183", "isFromContract": false, "isToContract": false, "amount": "0.5", "symbol": "ETH", "nonce": "1058", "txFee": "0.000549084273462", "gasPrice": "26147822546", "gasLimit": "21000", "gasUsed": "21000", "state": "success", "transactionType": "2" } ] } ``` - [Batch Get Internal Transaction Details](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-transaction-internal-transaction-multi.md) {/* api-page */} # Batch Get Internal Transaction Details Retrieve details of internal transactions triggered by contract calls for multiple transaction hashes at once, with up to 20 hashes per request (comma-separated; duplicate hashes are deduplicated automatically). Results are paginated with `cursor` and `limit`. This endpoint supports EVM chains only. Supported chains: see [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) (`apiName`: `internal-transaction-multi`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/transaction/internal-transaction-multi` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH, `0` for BTC. See [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) for supported values. | | txId | String | Yes | Transaction hash. Separate multiple transactions with commas, up to 20; duplicate hashes are deduplicated automatically. | | limit | String | No | Number of results per page, defaults to 20, up to a maximum of 100. | | cursor | String | No | Cursor returned by the previous response; omit it on the first page. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of results per page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | transactionList | Array | Internal transaction list. | | > txId | String | Transaction hash. | | > blockHash | String | Block hash. | | > height | String | Block height. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | > operation | String | Operation type, e.g., `call`, `delegatecall`, `create`. | | > from | String | Sender address. | | > to | String | Recipient address. | | > isFromContract | Boolean | Whether the `from` address is a contract address. | | > isToContract | Boolean | Whether the `to` address is a contract address. | | > amount | String | Transaction amount. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/transaction/internal-transaction-multi?chainIndex=1&txId=0x1e4996d90e77ee87f6a1a2a071603ee5d55d6dd7b272209b741ff276f4a1c34c&limit=20' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "20", "cursor": "", "transactionList": [ { "txId": "0x1e4996d90e77ee87f6a1a2a071603ee5d55d6dd7b272209b741ff276f4a1c34c", "blockHash": "0x7c1f0d95cbc7c4c018daae6cf3cf4ffef4dee62dfc9444838f4c5122a4899c9f", "height": "18126486", "transactionTime": "1694991899000", "operation": "call", "from": "0x7a250d5630b4cf539739df2c5dacb4c659f2488d", "to": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2", "isFromContract": true, "isToContract": true, "amount": "0.25" } ] } ] } ``` - [Batch Get Token Transfer Details](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-transaction-token-transfer-multi.md) {/* api-page */} # Batch Get Token Transfer Details Query token transfer details within transactions by transaction hash in batches. Up to 20 transaction hashes can be passed per request (comma-separated; duplicate hashes are deduplicated automatically). Results are returned with cursor + limit pagination. This endpoint supports EVM-compatible chains only. Supported chains: see [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) (`apiName`: `token-transfer-multi`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/transaction/token-transfer-multi` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH and `0` for BTC. See [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) for supported values. | | txId | String | Yes | Transaction hash. Separate multiple transactions with commas, up to 20; duplicate hashes are deduplicated automatically. | | protocolType | String | No | Token protocol type: `token_20`, `token_721`, `token_1155`. If omitted, no protocol type filter is applied. | | limit | String | No | Number of entries per page. Default is 20, maximum is 100. | | cursor | String | No | Cursor returned by the previous response. Omit it for the first page. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of entries on this page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | transactionList | Array | Token transfer list. | | > txId | String | Transaction hash. | | > blockHash | String | Block hash. | | > height | String | Block height. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | > from | String | Sender address. | | > to | String | Recipient address. | | > isFromContract | Boolean | Whether the from address is a contract address. | | > isToContract | Boolean | Whether the to address is a contract address. | | > amount | String | Transaction amount. | | > tokenId | String | NFT tokenId; an empty string for non-NFT transfers. | | > symbol | String | Token symbol. | | > tokenContractAddress | String | Token contract address. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/transaction/token-transfer-multi?chainIndex=1&txId=0x1e4996d90e77ee87f6a1a2a071603ee5d55d6dd7b272209b741ff276f4a1c34c&protocolType=token_20' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "20", "cursor": "", "transactionList": [ { "txId": "0x1e4996d90e77ee87f6a1a2a071603ee5d55d6dd7b272209b741ff276f4a1c34c", "blockHash": "0x7c1f0d95cbc7c4c018daae6cf3cf4ffef4dee62dfc9444838f4c5122a4899c9f", "height": "18126486", "transactionTime": "1694991899000", "from": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "to": "0x5041ed759dd4afc3a72b8192c143f72f4724081a", "isFromContract": false, "isToContract": true, "amount": "2500", "tokenId": "", "symbol": "USDT", "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7" } ] } ] } ``` - [Batch Get Normal Transaction List by Address](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-transaction-normal-transaction-list-multi.md) {/* api-page */} # Batch Get Normal Transaction List by Address Query the normal transaction list for multiple addresses within a given block range in batches. Up to 50 addresses are allowed, and the block range must not span more than 10,000 blocks. Results are returned with cursor + limit pagination. Supports EVM-compatible chains and TRON. Supported chains: see [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) (`apiName`: `normal-transaction-list-multi`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/transaction/normal-transaction-list-multi` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH and `0` for BTC. See [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) for supported values. | | address | String | Yes | Address. Separate multiple addresses with commas, up to 50; duplicate addresses are deduplicated automatically. | | startBlockHeight | String | Yes | Start block height. The range between this and endBlockHeight must not span more than 10,000 blocks. | | endBlockHeight | String | Yes | End block height. | | isFromOrTo | String | No | `from`: return only transactions where the from address is the queried address; `to`: return only transactions where the to address is the queried address. If omitted, a match on either from or to is returned. | | limit | String | No | Number of entries per page. Default is 20, maximum is 100. | | cursor | String | No | Cursor returned by the previous response. Omit it for the first page. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of entries on this page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | transactionList | Array | Transaction list. | | > txId | String | Transaction hash. | | > methodId | String | Method ID; an empty string when the transaction is not a contract call. | | > blockHash | String | Block hash. | | > height | String | Block height. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | > from | String | Sender address. | | > to | String | Recipient address. | | > isFromContract | Boolean | Whether the from address is a contract address. | | > isToContract | Boolean | Whether the to address is a contract address. | | > amount | String | Transaction amount. | | > symbol | String | Symbol of the currency the transaction amount is denominated in. | | > txFee | String | Transaction fee. | | > gasLimit | String | Gas limit. | | > gasUsed | String | Gas used. | | > gasPrice | String | Gas price. | | > nonce | String | Sequence number of the transaction sent from the initiating address. | | > transactionType | String | Transaction type. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/transaction/normal-transaction-list-multi?chainIndex=1&address=0xd8da6bf26964af9d7eed9e03e53415d37aa96045,0x282edab8a933bc1c02649fe3ea2842ecb8e26183&startBlockHeight=18717000&endBlockHeight=18718000' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "20", "cursor": "", "transactionList": [ { "txId": "0x9d918f5c1b0b04b8f5b0a2e6d9c78a3f5f89f24d43be3fb4b17e58fcbb42a95b", "methodId": "", "blockHash": "0x4a151d9d3e1b7fca2f9f34ea70e2ae35b6f4cd8e4a1cdbedb50ac52c1c50b1af", "height": "18717042", "transactionTime": "1702138715000", "from": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "to": "0x282edab8a933bc1c02649fe3ea2842ecb8e26183", "isFromContract": false, "isToContract": false, "amount": "0.1", "symbol": "ETH", "txFee": "0.000893972405466", "gasLimit": "21000", "gasUsed": "21000", "gasPrice": "42570114546", "nonce": "1178", "transactionType": "2" } ] } ] } ``` - [Batch Get Token Transaction List by Address](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-transaction-token-transaction-list-multi.md) {/* api-page */} # Batch Get Token Transaction List by Address Query the token transaction list for multiple addresses within a given block range in batches. Up to 50 addresses are allowed, and the block range must not span more than 10,000 blocks. Results are returned with cursor + limit pagination. Supports EVM-compatible chains plus APT and TRON. Supported chains: see [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) (`apiName`: `token-transaction-list-multi`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/transaction/token-transaction-list-multi` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH and `0` for BTC. See [Get Transaction API Supported Chains](../market/onchaindata-transaction-supported-chains) for supported values. | | address | String | Yes | Address. Separate multiple addresses with commas, up to 50; duplicate addresses are deduplicated automatically. | | startBlockHeight | String | Yes | Start block height. The range between this and endBlockHeight must not span more than 10,000 blocks. | | endBlockHeight | String | Yes | End block height. | | protocolType | String | No | Contract protocol type: `token_20`, `token_721`, `token_1155`; TRON additionally supports `token_10`. If omitted, no protocol type filter is applied. | | tokenContractAddress | String | No | Token contract address. Separate multiple contract addresses with commas, up to 50. | | isFromOrTo | String | No | `from`: return only transactions where the from address is the queried address; `to`: return only transactions where the to address is the queried address. If omitted, a match on either from or to is returned. | | limit | String | No | Number of entries per page. Default is 20, maximum is 100. | | cursor | String | No | Cursor returned by the previous response. Omit it for the first page. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of entries on this page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | transactionList | Array | Token transaction list. | | > txId | String | Transaction hash. | | > blockHash | String | Block hash. | | > height | String | Block height. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | > from | String | Sender address. | | > to | String | Recipient address. | | > isFromContract | Boolean | Whether the from address is a contract address. | | > isToContract | Boolean | Whether the to address is a contract address. | | > amount | String | Transaction amount. | | > tokenId | String | NFT tokenId; an empty string for non-NFT transactions. | | > symbol | String | Token symbol. | | > tokenContractAddress | String | Token contract address. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/transaction/token-transaction-list-multi?chainIndex=1&address=0xd8da6bf26964af9d7eed9e03e53415d37aa96045&startBlockHeight=18717000&endBlockHeight=18718000&protocolType=token_20' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "20", "cursor": "", "transactionList": [ { "txId": "0x6a4cc25f0eda663b7d5cb92e2f1c92ff1c4bd3f34f7f3a54c8b74e29e3c25e11", "blockHash": "0x4a151d9d3e1b7fca2f9f34ea70e2ae35b6f4cd8e4a1cdbedb50ac52c1c50b1af", "height": "18717042", "transactionTime": "1702138715000", "from": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "to": "0x5041ed759dd4afc3a72b8192c143f72f4724081a", "isFromContract": false, "isToContract": true, "amount": "1000", "tokenId": "", "symbol": "USDT", "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7" } ] } ] } ``` - [Event Log API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-log-reference.md) # Event Log API Reference - [Get Event Log API Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-log-supported-chains.md) {/* api-page */} # Get Event Log API Supported Chains Retrieve the chains supported by each Event Log API endpoint. Each response row represents one API-chain pair. ## Request URL GET `https://web3.okx.com/api/v6/explorer/log/supported-chains` ## Request Parameters None. ## Response Parameters | Parameter | Type | Description | |---|---|---| | apiName | String | Module-local API name without the `log/` prefix, e.g., `by-address`. | | chainIndex | String | Unique identifier of the chain, e.g., `1` for Ethereum. | | chainName | String | Chain name, e.g., `Ethereum`. | | chainSymbol | String | Native token symbol, e.g., `ETH`. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/log/supported-chains' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "apiName": "by-address", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" }, { "apiName": "by-transaction", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" } ] } ``` - [Get Event Logs by Block Range and Address](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-log-by-block-and-address.md) {/* api-page */} # Get Event Logs by Block Range and Address Query the event logs emitted by a given contract address within a specified block height range, returned page by page using a cursor. This endpoint supports EVM-compatible chains only. Supported chains: see [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) (`apiName`: `by-block-and-address`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/log/by-block-and-address` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH and `0` for BTC. See [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) for supported values. | | startBlockHeight | String | Yes | Start block height, minimum 1. | | endBlockHeight | String | Yes | End block height, minimum 1. | | address | String | Yes | Contract address. | | cursor | String | No | Cursor returned by the previous response. Omit it or pass an empty string to start from the first page. | | limit | String | No | Number of entries per page. Default is 100, maximum is 1000. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of entries on this page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | logList | Array | Event log list. | | > height | String | Block height. | | > address | String | Contract address that emitted the event log. | | > topics | Array | Topic list, with String elements. | | > data | String | The event log's data field, as a hexadecimal string. | | > methodId | String | methodId, identifying the method that triggered the log. | | > blockHash | String | Block hash. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | > logIndex | String | Log index. | | > txId | String | Transaction hash. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/log/by-block-and-address?chainIndex=1&startBlockHeight=19000000&endBlockHeight=19000100&address=0xdac17f958d2ee523a2206206994597c13d831ec7' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "100", "cursor": "100", "logList": [ { "height": "19000012", "address": "0xdac17f958d2ee523a2206206994597c13d831ec7", "topics": [ "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "0x0000000000000000000000005041ed759dd4afc3a72b8192c143f72f4724081a", "0x000000000000000000000000c6a2ad8cc6e4a7e08fc37cc5954be07d499e7654" ], "data": "0x00000000000000000000000000000000000000000000000000000000004c4b40", "methodId": "0xa9059cbb", "blockHash": "0x1f3c5a0d9e7b2c4a6d8f0b1c3e5a7d9f2b4c6e8a0d1f3b5c7e9a2d4f6b8c0e1a", "transactionTime": "1705316735000", "logIndex": "156", "txId": "0x7d4b1e9c3a5f70d2b8e6c4a1f9d3b5e7c0a2d4f6b8e1c3a5d7f9b2e4c6a8d0f3" } ] } ] } ``` - [Get Event Logs by Address and Topic](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-log-by-address-and-topic.md) {/* api-page */} # Get Event Logs by Address and Topic Query the event logs under a given contract address that match a specified event signature (topic0), returned page by page using a cursor. This endpoint supports EVM-compatible chains only. **This endpoint uses a scan-style cursor**: on each request, the server scans a fixed number of logs from that address's log stream and filters them by topic0 (which keeps the time cost of a single request bounded). As a result, the number of matches returned on a single page **may be fewer than limit, or even 0**. As long as `cursor` is non-empty, unscanned data remains, and the client must keep paginating with the returned cursor until `cursor` is an empty string. Supported chains: see [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) (`apiName`: `by-address-and-topic`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/log/by-address-and-topic` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH and `0` for BTC. See [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) for supported values. | | address | String | Yes | Contract address. | | topic0 | String | Yes | Event signature hash (topic0), e.g., 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef for the ERC-20 Transfer event. | | cursor | String | No | Scan cursor returned by the previous response. Omit it or pass an empty string to start scanning from the latest logs. | | limit | String | No | Maximum number of matches returned per page. Default is 100, maximum is 1000 (with a scan-style cursor, a single page may return fewer than this value). | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of entries on this page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | logList | Array | Event log list. | | > height | String | Block height. | | > address | String | Contract address that emitted the event log. | | > topics | Array | Topic list, with String elements. | | > data | String | The event log's data field, as a hexadecimal string. | | > methodId | String | methodId, identifying the method that triggered the log. | | > blockHash | String | Block hash. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | > logIndex | String | Log index. | | > txId | String | Transaction hash. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/log/by-address-and-topic?chainIndex=1&address=0xdac17f958d2ee523a2206206994597c13d831ec7&topic0=0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "100", "cursor": "100", "logList": [ { "height": "21283946", "address": "0xdac17f958d2ee523a2206206994597c13d831ec7", "topics": [ "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "0x000000000000000000000000f89d7b9c864f589bbf53a82105107622b35eaa40", "0x00000000000000000000000028c6c06298d514db089934071355e5743bf21d60" ], "data": "0x000000000000000000000000000000000000000000000000000000174876e800", "methodId": "0xa9059cbb", "blockHash": "0x9b2e4c6a8d0f31f3c5a0d9e7b2c4a6d8f0b1c3e5a7d9f2b4c6e8a0d1f3b5c7e9", "transactionTime": "1733196827000", "logIndex": "87", "txId": "0x3a5f70d2b8e6c4a1f9d3b5e7c0a2d4f6b8e1c3a5d7f9b2e4c6a8d0f37d4b1e9c" } ] } ] } ``` - [Get Event Logs by Address](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-log-by-address.md) {/* api-page */} # Get Event Logs by Address Query the event logs emitted by a given contract address, returned page by page using a cursor. This endpoint supports EVM-compatible chains only. Supported chains: see [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) (`apiName`: `by-address`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/log/by-address` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH and `0` for BTC. See [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) for supported values. | | address | String | Yes | Contract address. | | cursor | String | No | Cursor returned by the previous response. Omit it or pass an empty string to start from the first page. | | limit | String | No | Number of entries per page. Default is 100, maximum is 1000. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | limit | String | Maximum number of entries on this page. | | cursor | String | Cursor for the next page; an empty string means no more pages. Pass it back as-is; clients should not parse or construct it. | | logList | Array | Event log list. | | > height | String | Block height. | | > address | String | Contract address that emitted the event log. | | > topics | Array | Topic list, with String elements. | | > data | String | The event log's data field, as a hexadecimal string. | | > methodId | String | methodId, identifying the method that triggered the log. | | > blockHash | String | Block hash. | | > transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | > logIndex | String | Log index. | | > txId | String | Transaction hash. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/log/by-address?chainIndex=1&address=0xdac17f958d2ee523a2206206994597c13d831ec7&limit=100' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "limit": "100", "cursor": "100", "logList": [ { "height": "21284102", "address": "0xdac17f958d2ee523a2206206994597c13d831ec7", "topics": [ "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925", "0x0000000000000000000000001b7baa734c00298b9429b518d621753bb0f6eff2", "0x00000000000000000000000068b3465833fb72a70ecdf485e0e4c7bd8665fc45" ], "data": "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", "methodId": "0x095ea7b3", "blockHash": "0x5c7e9a2d4f6b8c0e1a1f3c5a0d9e7b2c4a6d8f0b1c3e5a7d9f2b4c6e8a0d1f3b", "transactionTime": "1733198723000", "logIndex": "42", "txId": "0xb8e6c4a1f9d3b5e7c0a2d4f6b8e1c3a5d7f9b2e4c6a8d0f37d4b1e9c3a5f70d2" } ] } ] } ``` - [Get Event Logs by Transaction Hash](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-log-by-transaction.md) {/* api-page */} # Get Event Logs by Transaction Hash Query all event logs emitted by a single transaction, returned as a flat list (each element of the data array is one log). A single transaction returns at most 1000 logs, with no pagination. This endpoint supports EVM-compatible chains only. Supported chains: see [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) (`apiName`: `by-transaction`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/log/by-transaction` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH and `0` for BTC. See [Get Event Log API Supported Chains](../market/onchaindata-log-supported-chains) for supported values. | | txId | String | Yes | Transaction hash. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | height | String | Block height. | | address | String | Contract address that emitted the event log. | | topics | Array | Topic list, with String elements. | | data | String | The event log's data field, as a hexadecimal string. | | methodId | String | methodId, identifying the method that triggered the log. | | blockHash | String | Block hash. | | transactionTime | String | Transaction time, as a Unix timestamp in milliseconds. | | logIndex | String | Log index. | | txId | String | Transaction hash. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/log/by-transaction?chainIndex=1&txId=0x2d4f6b8e1c3a5d7f9b2e4c6a8d0f37d4b1e9c3a5f70d2b8e6c4a1f9d3b5e7c0a' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "height": "21284215", "address": "0xdac17f958d2ee523a2206206994597c13d831ec7", "topics": [ "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "0x0000000000000000000000005041ed759dd4afc3a72b8192c143f72f4724081a", "0x00000000000000000000000068b3465833fb72a70ecdf485e0e4c7bd8665fc45" ], "data": "0x00000000000000000000000000000000000000000000000000000002540be400", "methodId": "0x38ed1739", "blockHash": "0xd9f2b4c6e8a0d1f3b5c7e9a2d4f6b8c0e1a1f3c5a0d9e7b2c4a6d8f0b1c3e5a7", "transactionTime": "1733200079000", "logIndex": "118", "txId": "0x2d4f6b8e1c3a5d7f9b2e4c6a8d0f37d4b1e9c3a5f70d2b8e6c4a1f9d3b5e7c0a" }, { "height": "21284215", "address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2", "topics": [ "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "0x00000000000000000000000068b3465833fb72a70ecdf485e0e4c7bd8665fc45", "0x0000000000000000000000005041ed759dd4afc3a72b8192c143f72f4724081a" ], "data": "0x0000000000000000000000000000000000000000000000000de0b6b3a7640000", "methodId": "0x38ed1739", "blockHash": "0xd9f2b4c6e8a0d1f3b5c7e9a2d4f6b8c0e1a1f3c5a0d9e7b2c4a6d8f0b1c3e5a7", "transactionTime": "1733200079000", "logIndex": "119", "txId": "0x2d4f6b8e1c3a5d7f9b2e4c6a8d0f37d4b1e9c3a5f70d2b8e6c4a1f9d3b5e7c0a" } ] } ``` - [Address API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-address-reference.md) # Address API Reference - [Get Address API Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-address-supported-chains.md) {/* api-page */} # Get Address API Supported Chains Retrieve the chains supported by each Address API endpoint. Each response row represents one API-chain pair. ## Request URL GET `https://web3.okx.com/api/v6/explorer/address/supported-chains` ## Request Parameters None. ## Response Parameters | Parameter | Type | Description | |---|---|---| | apiName | String | Module-local API name without the `address/` prefix, e.g., `address-active-chain`. | | chainIndex | String | Unique identifier of the chain, e.g., `1` for Ethereum. | | chainName | String | Chain name, e.g., `Ethereum`. | | chainSymbol | String | Native token symbol, e.g., `ETH`. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/address/supported-chains' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "apiName": "address-active-chain", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" }, { "apiName": "information-evm", "chainIndex": "1", "chainName": "Ethereum", "chainSymbol": "ETH" } ] } ``` - [Get Active Chains for an Address](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-address-address-active-chain.md) {/* api-page */} # Get Active Chains for an Address Query which chains an address is active on (that is, has on-chain records), and whether the address is a contract address on each of them. One active chain is returned per row. Only EVM-format addresses are supported (`0x` prefix plus 40 hexadecimal characters). Supported chains: see [Get Address API Supported Chains](../market/onchaindata-address-supported-chains) (`apiName`: `address-active-chain`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/address/address-active-chain` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | address | String | Yes | Address. Only EVM-format addresses are supported (`0x` prefix plus 40 hexadecimal characters). | ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain, e.g., `1` for ETH. Each row corresponds to one chain the address is active on. | | isContractAddress | Boolean | Whether the address is a contract address on this chain. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/address/address-active-chain?address=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "chainIndex": "1", "isContractAddress": false }, { "chainIndex": "56", "isContractAddress": false }, { "chainIndex": "137", "isContractAddress": false } ] } ``` - [Get EVM Address Information](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-address-information-evm.md) {/* api-page */} # Get EVM Address Information Query basic information for an EVM address, including its native token balance, transaction count, first and last transaction times, and contract creation and call details for contract addresses. EVM chains only. If the address has no on-chain records, `data` returns an empty array. Supported chains: see [Get Address API Supported Chains](../market/onchaindata-address-supported-chains) (`apiName`: `information-evm`). ## Request URL GET `https://web3.okx.com/api/v6/explorer/address/information-evm` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, e.g., `1` for ETH. EVM chains only. See [Get Address API Supported Chains](../market/onchaindata-address-supported-chains) for supported values. | | address | String | Yes | EVM address. | ## Response Parameters | Parameter | Type | Description | |---|---|---| | address | String | Address. | | isValidator | Boolean | Whether the address is a validator node. | | balance | String | Native token balance. | | balanceSymbol | String | Symbol of the native token balance (e.g., Gnosis chain returns ETH). | | transactionCount | String | Number of transactions for the address. | | firstTransactionTime | String | Time of the address's first transaction. | | lastTransactionTime | String | Time of the address's most recent transaction. | | contractAddress | Boolean | Whether the address is a contract address (used to determine whether it is an EOA). | | createContractAddress | String | Address that created the contract. An empty string for non-contract addresses. | | createContractTransactionHash | String | Transaction hash that created the contract. An empty string for non-contract addresses. | | contractCorrespondingToken | String | Token corresponding to the contract. An empty string for non-contract addresses. | | contractCalls | String | Number of contract calls. An empty string for non-contract addresses. | | contractCallingAddresses | String | Number of addresses that have called the contract. An empty string for non-contract addresses. | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/explorer/address/information-evm?chainIndex=1&address=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": [ { "address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "isValidator": false, "balance": "744.5387964072138", "balanceSymbol": "ETH", "transactionCount": "1568", "firstTransactionTime": "1438922865000", "lastTransactionTime": "1753690000000", "contractAddress": false, "createContractAddress": "", "createContractTransactionHash": "", "contractCorrespondingToken": "", "contractCalls": "", "contractCallingAddresses": "" } ] } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/onchaindata-error-code.md) # Error Codes ## API error handling | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------------------------------| | 0 | 200 | Succeeded | | 50011 | 429 | Rate limit reached. Please refer to API documentation and throttle requests accordingly | | 50014 | 400 | Parameter \{param0\} cannot be empty | | 50026 | 500 | System error. Try again later | | 50036 | 400 | Parameter \{param0\} error | | 50038 | 200 | Unsupported chain. Please check that chainIndex is correct | | 50103 | 401 | Request header "OK-ACCESS-KEY" cannot be empty | | 50104 | 401 | Request header "OK-ACCESS-PASSPHRASE" cannot be empty| | 50105 | 401 | Request header "OK-ACCESS-PASSPHRASE" incorrect | | 50106 | 401 | Request header "OK-ACCESS-SIGN" cannot be empty | | 50107 | 401 | Request header "OK-ACCESS-TIMESTAMP" cannot be empty | | 50111 | 401 | Invalid OK-ACCESS-KEY | | 50112 | 401 | Invalid OK-ACCESS-TIMESTAMP | | 50113 | 401 | Invalid signature | | 50114 | 401 | Invalid authority | | 50125 | 401 | Your API key or region has no access to the current service | | 50404 | 404 | URL not found | ## Payment error handling | Error Message | Meaning | Troubleshooting Action | |------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | Empty / null response | Request did not include PAYMENT-SIGNATURE or X-PAYMENT header | Include PAYMENT-SIGNATURE or X-PAYMENT in the request after signing | | invalid payment header | PAYMENT-SIGNATURE content is invalid | Check for truncation / encoding issues / multiple base64 nesting | | param_mismatch | Missing required fields or invalid parameters (address / nonce format) | Verify that parameters in the signature match the expected values | | toAddr mismatch | PayTo address does not match or is zero address | Ensure the address matches exactly and is not 0x0000… | | amount mismatch | Signed amount does not match returned amount | Ensure value in EIP-3009 signature equals the returned amount | | unsupported_chain | Parsed chainIndex from network is not supported | Currently only X Layer (eip155:196) is supported | | payer_blocked | authorization.from triggered risk control rules | Contact OKX support / risk team | | risk_address | payer or payTo is flagged (blacklist / sanctioned address) | Use a different address | | resource mismatch | Signed URL does not match request URL | Use the exact request URL when signing; do not reuse payload | | no matching payment option | Payment token does not match required token | Sign using the token specified in the response | | invalid_signature | Invalid signature format (length, r/s range, v value, etc.) | Use OKXEvmSigner; avoid manual EIP-712 construction | | not_yet_valid | validAfter > now | Check system time | | expired | `validBefore <= now` | Check system time | | invalid signature, nonce_used | Nonce already used on-chain | Generate a new 32-byte nonce and sign again | | insufficient_balance | Insufficient balance | Fund the account or reduce concurrent payments | | onchain_error | On-chain RPC / multicall failure | Retry the request | | payment processing | Duplicate request within cache window | Avoid reusing the same signature within cache period | - [API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-news-reference.md) # API Reference - [Get Latest News Feed](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-news-latest.md) {/* api-page */} # Get Latest News Feed Retrieve the latest cryptocurrency news feed. Internally `sortBy=latest` is fixed; `importance` has no server-side default — omit to skip the filter. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/news/latest` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | tokenSymbols | string | No | Comma-separated list of token symbols, e.g. BTC,ETH,SOL. Case-insensitive. Omit to return data for all tokens. Maximum 20 symbols supported. | | begin | string | No | Query start timestamp (milliseconds). Defaults to current time − 72 hours; maximum lookback of 180 days. | | end | string | No | Query end timestamp (milliseconds). Defaults to current time (now). | | importance | string | No | SocialImportanceEnum code to filter by article importance: 1=high, 2=medium, 3=low. Omit to return all importance levels. | | platform | string | No | News source domain, e.g. coindesk.com. Retrieve the full list via GET /social/news/platforms. Omit to return data from all sources. | | limit | string | No | Number of results per page, range [1, 50], default 10. | | cursor | string | No | Pagination cursor. Omit on first request; pass the cursor from the previous response to fetch the next page. A null cursor indicates no more data. | | detailLevel | string | No | Response detail level: 1=summary (title + summary only, content field is empty), 2=full (also returns full article content). Default 1. Use 1 for list views and 2 for detail views to reduce bandwidth. | | language | string | No | Response language in BCP-47 format, e.g. en_US, zh_CN. Default en_US. Supported locales depend on the upstream Orbit service. | ## Response Parameters | Field | Type | Description | |---|---|---| | cursor | string | Next-page cursor; null indicates no more data | | articles | array | List of news articles | | > id | string | Unique article ID, can be used as the id parameter of GET /social/news/detail to retrieve the full article | | > title | string | Article title | | > summary | string | Article summary | | > content | string | Full article content; only returned when detailLevel=2 | | > sourceUrl | string | Original article URL | | > source | string | First platform domain of the news source, e.g. coindesk.com | | > timestamp | string | Article publish time, Unix millisecond timestamp | | > tokenSymbols | array | List of token symbols mentioned in the article | | > importance | string | Article importance level: high, medium, or low | | > tokenSymbolSentiments | array | Per-token sentiment analysis for this article | | >> sentiment | string | Sentiment label: bullish / bearish / neutral | | >> tokenSymbol | string | Token symbol | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/news/latest?limit=10&detailLevel=1&language=en_US' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "cursor": "eyJsYXN0SWQiOiIxNzM4MDAwMDAwMDAxIn0", "articles": [ { "id": "NEWS_20241018_001", "title": "Bitcoin Surges Past $70,000 as Institutional Demand Grows", "summary": "Bitcoin has broken through the $70,000 mark for the first time this month, driven by strong institutional buying and positive ETF inflows.", "content": "", "sourceUrl": "https://coindesk.com/markets/2024/10/18/bitcoin-surges-past-70000", "source": "coindesk.com", "timestamp": "1697630501000", "tokenSymbols": ["BTC"], "importance": "high", "tokenSymbolSentiments": [ { "tokenSymbol": "BTC", "sentiment": "bullish" } ] }, { "id": "NEWS_20241018_002", "title": "Ethereum Developers Finalize Next Upgrade Timeline", "summary": "Core Ethereum developers have agreed on a timeline for the next major network upgrade, focusing on scalability improvements.", "content": "", "sourceUrl": "https://cointelegraph.com/news/ethereum-upgrade-timeline", "source": "cointelegraph.com", "timestamp": "1697627000000", "tokenSymbols": ["ETH"], "importance": "medium", "tokenSymbolSentiments": [ { "tokenSymbol": "ETH", "sentiment": "bullish" } ] } ] } } ``` - [Get News by Token Symbol](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-news-by-symbol.md) {/* api-page */} # Get News by Token Symbol Retrieve news filtered by one or more token symbols. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/news/by-symbol` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | tokenSymbols | string | Yes | Comma-separated list of token symbols, e.g. BTC,ETH,SOL. Case-insensitive. Maximum 20 symbols supported. | | sortBy | string | No | Sort order: 1=latest (descending by publish time), 2=hot (descending by popularity). Default 1. | | sentiment | string | No | SocialSentimentEnum code to filter by sentiment: 1=bullish, 2=bearish, 3=neutral. Omit to return all sentiments. | | importance | string | No | SocialImportanceEnum code to filter by article importance: 1=high, 2=medium, 3=low. Omit to return all importance levels. | | platform | string | No | News source domain, e.g. coindesk.com. Retrieve the full list via GET /social/news/platforms. Omit to return data from all sources. | | limit | string | No | Number of results per page, range [1, 50], default 10. | | cursor | string | No | Pagination cursor. Omit on first request; pass the cursor from the previous response to fetch the next page. A null cursor indicates no more data. | | detailLevel | string | No | Response detail level: 1=summary (title + summary only, content field is empty), 2=full (also returns full article content). Default 1. | | begin | string | No | Query start timestamp (milliseconds). Defaults to current time − 72 hours; maximum lookback of 180 days. | | end | string | No | Query end timestamp (milliseconds). Defaults to current time (now). | | language | string | No | Response language in BCP-47 format, e.g. en_US, zh_CN. Default en_US. | ## Response Parameters | Field | Type | Description | |---|---|---| | cursor | string | Next-page cursor; null indicates no more data | | articles | array | List of news articles | | > id | string | Unique article ID, can be used as the id parameter of GET /social/news/detail to retrieve the full article | | > title | string | Article title | | > summary | string | Article summary | | > content | string | Full article content; only returned when detailLevel=2 | | > sourceUrl | string | Original article URL | | > source | string | First platform domain of the news source, e.g. coindesk.com | | > timestamp | string | Article publish time, Unix millisecond timestamp | | > tokenSymbols | array | List of token symbols mentioned in the article | | > importance | string | Article importance level: high, medium, or low | | > tokenSymbolSentiments | array | Per-token sentiment analysis for this article | | >> sentiment | string | Sentiment label: bullish / bearish / neutral | | >> tokenSymbol | string | Token symbol | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/news/by-symbol?tokenSymbols=BTC,ETH&sortBy=1&limit=10&detailLevel=1&language=en_US' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "cursor": "eyJsYXN0SWQiOiIxNzM4MDAwMDAwMDAyIn0", "articles": [ { "id": "NEWS_20241018_010", "title": "Bitcoin ETF Sees Record Inflows of $800M in Single Day", "summary": "Spot Bitcoin ETFs recorded their highest single-day inflows since launch, signaling renewed institutional interest.", "content": "", "sourceUrl": "https://coindesk.com/markets/2024/10/18/bitcoin-etf-record-inflows", "source": "coindesk.com", "timestamp": "1697630800000", "tokenSymbols": ["BTC"], "importance": "high", "tokenSymbolSentiments": [ { "tokenSymbol": "BTC", "sentiment": "bullish" } ] }, { "id": "NEWS_20241018_011", "title": "Ethereum Layer 2 Transactions Hit All-Time High", "summary": "Combined transaction volume on Ethereum Layer 2 networks surpassed a new record, highlighting growing adoption of scaling solutions.", "content": "", "sourceUrl": "https://theblock.co/post/ethereum-l2-record", "source": "theblock.co", "timestamp": "1697625000000", "tokenSymbols": ["ETH"], "importance": "medium", "tokenSymbolSentiments": [ { "tokenSymbol": "ETH", "sentiment": "bullish" } ] } ] } } ``` - [Search News](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-news-search.md) {/* api-page */} # Search News Full-text news search with filters. Supports keyword-based search across article titles and content. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/news/search` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | keyword | string | Yes | Full-text search keyword, supports token names, project names, and free-form text. Case-insensitive. | | sortBy | string | No | Sort order: 1=latest (descending by publish time), 2=hot (descending by popularity). Default 1. | | sentiment | string | No | SocialSentimentEnum code to filter by sentiment: 1=bullish, 2=bearish, 3=neutral. Omit to return all sentiments. | | importance | string | No | SocialImportanceEnum code to filter by article importance: 1=high, 2=medium, 3=low. Omit to return all importance levels. | | platform | string | No | News source domain, e.g. coindesk.com. Retrieve the full list via GET /social/news/platforms. Omit to return data from all sources. | | tokenSymbols | string | No | Comma-separated list of token symbols, e.g. BTC,ETH. Case-insensitive. Omit to search across all tokens. Maximum 20 symbols. | | begin | string | No | Query start timestamp (milliseconds). Defaults to current time − 72 hours; maximum lookback of 180 days. | | end | string | No | Query end timestamp (milliseconds). Defaults to current time (now). | | detailLevel | string | No | Response detail level: 1=summary (title + summary only), 2=full (also returns full article content). Default 1. | | limit | string | No | Number of results per page, range [1, 50], default 10. | | cursor | string | No | Pagination cursor. Omit on first request; pass the cursor from the previous response to fetch the next page. A null cursor indicates no more data. | | language | string | No | Response language in BCP-47 format, e.g. en_US, zh_CN. Default en_US. | ## Response Parameters | Field | Type | Description | |---|---|---| | cursor | string | Next-page cursor; null indicates no more data | | articles | array | List of news articles matching the search | | >id | string | Unique article ID, can be used as the id parameter of GET /social/news/detail | | >title | string | Article title | | >summary | string | Article summary | | >content | string | Full article content; only returned when detailLevel=2 | | >sourceUrl | string | Original article URL | | >source | string | First platform domain of the news source, e.g. coindesk.com | | >timestamp | string | Article publish time, Unix millisecond timestamp | | >tokenSymbols | array | List of token symbols mentioned in the article | | >importance | string | Article importance level: high, medium, or low | | >tokenSymbolSentiments | array | Per-token sentiment analysis for this article | | >>sentiment | string | Sentiment label: bullish / bearish / neutral | | >>tokenSymbol | string | Token symbol | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/news/search?keyword=ethereum&sortBy=1&limit=10&detailLevel=1&language=en_US' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "cursor": "eyJsYXN0SWQiOiIxNzM4MDAwMDAwMDAzIn0", "articles": [ { "id": "NEWS_20241018_020", "title": "Ethereum Foundation Announces New Developer Grants Program", "summary": "The Ethereum Foundation has launched a new round of developer grants targeting infrastructure and tooling improvements.", "content": "", "sourceUrl": "https://decrypt.co/ethereum-foundation-grants", "source": "decrypt.co", "timestamp": "1697631000000", "tokenSymbols": ["ETH"], "importance": "medium", "tokenSymbolSentiments": [ { "tokenSymbol": "ETH", "sentiment": "bullish" } ] }, { "id": "NEWS_20241018_021", "title": "Ethereum Staking Deposits Exceed 30 Million ETH", "summary": "The total amount of ETH staked on the Beacon Chain has surpassed 30 million, representing over 25% of the total supply.", "content": "", "sourceUrl": "https://coindesk.com/tech/2024/10/18/ethereum-staking", "source": "coindesk.com", "timestamp": "1697620000000", "tokenSymbols": ["ETH"], "importance": "high", "tokenSymbolSentiments": [ { "tokenSymbol": "ETH", "sentiment": "bullish" } ] } ] } } ``` - [Get News Article Detail](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-news-detail.md) {/* api-page */} # Get News Article Detail Retrieve the full content of a single news article by its unique ID. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/news/detail` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | articleId | string | Yes | Unique article ID. Obtained from the articles[].id field in responses from /social/news/latest, /social/news/by-symbol, or /social/news/search. | | language | string | No | Response language in BCP-47 format, e.g. en_US, zh_CN. Default en_US. | ## Response Parameters | Field | Type | Description | |---|---|---| | articles | array | Fixed array of 1 article on success | | > id | string | Unique article ID, consistent with the articles[].id field in list API responses | | > title | string | Article title | | > summary | string | Article summary | | > content | string | Full article content | | > sourceUrl | string | Original article URL | | > source | string | First platform domain of the news source | | > timestamp | string | Article publish time, Unix millisecond timestamp | | > tokenSymbols | array | List of token symbols mentioned in the article | | > importance | string | Article importance level: 1=high, 2=medium, 3=low | | > tokenSymbolSentiments | array | Per-token sentiment analysis for this article | | >> sentiment | string | Sentiment label: bullish / bearish / neutral | | >> tokenSymbol | string | Token symbol | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/news/detail?articleId=NEWS_20241018_001&language=en_US' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "articles": [ { "id": "NEWS_20241018_001", "title": "Bitcoin Surges Past $70,000 as Institutional Demand Grows", "summary": "Bitcoin has broken through the $70,000 mark for the first time this month, driven by strong institutional buying and positive ETF inflows.", "content": "Bitcoin reached a new monthly high on Wednesday, crossing the $70,000 threshold as institutional investors continued to pour capital into spot Bitcoin ETFs. Data from multiple sources shows that ETF inflows hit $800 million on Tuesday alone, pushing total assets under management to over $50 billion. Analysts attribute the price surge to a combination of factors including the approaching halving event, macroeconomic tailwinds from recent Federal Reserve policy signals, and growing corporate treasury adoption. Major financial institutions have reiterated their bullish outlook for Bitcoin heading into Q4.", "sourceUrl": "https://coindesk.com/markets/2024/10/18/bitcoin-surges-past-70000", "source": "coindesk.com", "timestamp": "1697630501000", "tokenSymbols": ["BTC"], "importance": "high", "tokenSymbolSentiments": [ { "tokenSymbol": "BTC", "sentiment": "bullish" } ] } ] } } ``` - [Get Available News Platforms](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-news-platforms.md) {/* api-page */} # Get Available News Platforms Retrieve a list of all available news source platforms. Use the returned domain values as the `platform` parameter in other news endpoints to filter by source. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/news/platforms` ## Request Parameters No request parameters required. ## Response Parameters | Field | Type | Description | |---|---|---| | platforms | array | List of available news platform domain names | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/news/platforms' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "platforms": [ "coindesk.com", "cointelegraph.com", "theblock.co", "decrypt.co", "cryptoslate.com", "bitcoinmagazine.com", "beincrypto.com", "cryptobriefing.com", "newsbtc.com", "ambcrypto.com", "u.today", "cryptopotato.com" ] } } ``` - [Get Token Sentiment Metrics](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-sentiment-symbol.md) {/* api-page */} # Get Token Sentiment Metrics Retrieve sentiment metrics for one or more tokens, including mention counts, sentiment ratios, and optional trend data. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/sentiment/symbol` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | tokenSymbols | string | Yes | Comma-separated list of token symbols, e.g. BTC,ETH. Case-insensitive. Maximum 20 symbols. Returns 400 error if blank. | | timeFrame | string | No | Statistical period: 1=1h (last 1 hour), 2=4h (last 4 hours), 3=24h (last 24 hours). Default 1. | | trendPoints | string | No | Number of trend data points. If > 0, the response will include a trend array with trendPoints equally-spaced historical time buckets. Set to 0 or omit to skip trend data. | ## Response Parameters | Field | Type | Description | |---|---|---| | period | string | Actual statistical period corresponding to the timeFrame parameter, e.g. "1h", "4h", "24h" | | ts | string | Server-side timestamp (milliseconds) | | details | array | One record per requested token | | > tokenSymbol | string | Token symbol | | > mentionCount | string | Total mention count for this token within the statistical period, including X/Twitter and news sources | | > xMentionCount | string | Mention count on X/Twitter platform | | > newsMentionCount | string | Mention count from news sources | | > sentiment | object | Sentiment breakdown for this token | | >> bullishCnt | string | Number of bullish-sentiment mentions | | >> bearishCnt | string | Number of bearish-sentiment mentions | | >> neutralCnt | string | Number of neutral-sentiment mentions | | >> bullishRatio | string | Bullish ratio, range 0.0–1.0 | | >> bearishRatio | string | Bearish ratio, range 0.0–1.0 | | >> label | string | Overall sentiment label: bullish / bearish / neutral / mixed | | > trend | array | Only returned when trendPoints > 0 | | >> ts | string | Time bucket timestamp (milliseconds) | | >> mentionCount | string | Total mention count within this time bucket | | >> bullishRatio | string | Bullish ratio within this time bucket | | >> bearishRatio | string | Bearish ratio within this time bucket | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/sentiment/symbol?tokenSymbols=BTC&timeFrame=1&trendPoints=24' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "period": "1h", "ts": "1697630501000", "details": [ { "tokenSymbol": "BTC", "mentionCount": "12540", "xMentionCount": "10200", "newsMentionCount": "2340", "sentiment": { "bullishCnt": "7890", "bearishCnt": "1230", "neutralCnt": "3420", "bullishRatio": "0.629", "bearishRatio": "0.098", "label": "bullish" }, "trend": [ { "ts": "1697626901000", "mentionCount": "520", "bullishRatio": "0.645", "bearishRatio": "0.092" }, { "ts": "1697627051000", "mentionCount": "498", "bullishRatio": "0.631", "bearishRatio": "0.101" } ] } ] } } ``` - [Get Sentiment Ranking](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-sentiment-ranking.md) {/* api-page */} # Get Sentiment Ranking Retrieve the top tokens ranked by sentiment activity (mention volume) within a specified time period. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/sentiment/ranking` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | timeFrame | string | No | Statistical period: 1=1h (last 1 hour), 2=4h (last 4 hours), 3=24h (last 24 hours). Default 1. | | sortBy | string | No | Sort order: currently only supports 1=hot (descending by total mention count). Default 1. | | limit | string | No | Number of results to return, range [1, 50], default 10. | ## Response Parameters | Field | Type | Description | |---|---|---| | period | string | Echo of the resolved period, e.g. "1h", "4h", "24h" | | ts | string | Server-side timestamp (milliseconds) | | details | array | Token list sorted by mention count in descending order, up to limit records | | > tokenSymbol | string | Token symbol | | > mentionCount | string | Total mention count within the statistical period, including X/Twitter and news sources | | > xMentionCount | string | Mention count on X/Twitter platform | | > newsMentionCount | string | Mention count from news sources | | > sentiment | object | Sentiment breakdown for this token | | >> bullishCnt | string | Number of bullish-sentiment mentions | | >> bearishCnt | string | Number of bearish-sentiment mentions | | >> neutralCnt | string | Number of neutral-sentiment mentions | | >> bullishRatio | string | Bullish ratio, range 0.0–1.0 | | >> bearishRatio | string | Bearish ratio, range 0.0–1.0 | | >> label | string | Overall sentiment label: bullish / bearish / neutral / mixed | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/sentiment/ranking?timeFrame=1&sortBy=1&limit=10' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "period": "1h", "ts": "1697630501000", "details": [ { "tokenSymbol": "BTC", "mentionCount": "12540", "xMentionCount": "10200", "newsMentionCount": "2340", "sentiment": { "bullishCnt": "7890", "bearishCnt": "1230", "neutralCnt": "3420", "bullishRatio": "0.629", "bearishRatio": "0.098", "label": "bullish" } }, { "tokenSymbol": "ETH", "mentionCount": "8320", "xMentionCount": "6890", "newsMentionCount": "1430", "sentiment": { "bullishCnt": "4980", "bearishCnt": "890", "neutralCnt": "2450", "bullishRatio": "0.598", "bearishRatio": "0.107", "label": "bullish" } }, { "tokenSymbol": "SOL", "mentionCount": "5670", "xMentionCount": "4920", "newsMentionCount": "750", "sentiment": { "bullishCnt": "3120", "bearishCnt": "680", "neutralCnt": "1870", "bullishRatio": "0.550", "bearishRatio": "0.120", "label": "bullish" } } ] } } ``` - [Get Token Vibe Timeline](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-vibe-timeline.md) {/* api-page */} # Get Token Vibe Timeline Retrieve the "vibe" (hotness) summary and historical timeline for a specific token. Returns an overall hotness score plus time-bucketed trend data with KOL activity. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/vibe/timeline` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | string | Yes | Chain ID, e.g. 1=Ethereum, 56=BNB Chain, 501=Solana. Supports all major EVM chains and Solana. | | tokenAddress | string | Yes | Token contract address. EVM chains use 0x... format; Solana uses Base58 encoding. | | timeFrame | string | No | Statistical period: 1=24h (last 24 hours), 2=72h (last 72 hours), 3=7d (last 7 days), 4=30d (last 30 days). Default 1. | ## Response Parameters | Field | Type | Description | |---|---|---| | summary | object | Vibe hotness summary metrics for the statistical window | | > score | string | Vibe hotness score, string integer from 0–100; higher values indicate greater recent discussion activity | | > scoreType | string | Fixed value dex_vibe_hotness, indicating the hotness score type | | > scoreRange | string | Fixed value 0-100, indicating the score range | | > scoreChangeRate | string | Percentage change compared to the previous period (string with sign) | | > mentionsCount | string | Total mention count within the statistical window | | > mentionsCountChangeRate | string | Percentage change in mention count compared to the previous period | | > engagement | string | Total engagement (likes, retweets, etc.) within the statistical window | | > engagementChangeRate | string | Percentage change in engagement compared to the previous period | | > impressions | string | Total impressions within the statistical window | | > impressionsChangeRate | string | Percentage change in impressions compared to the previous period | | > supportFirstMentioned | boolean | Whether first-mention data is supported; affects validity of kols[].firstMention | | timeline | array | Array of time buckets ordered chronologically (earliest to latest) | | > ts | string | Start timestamp of the time bucket (milliseconds) | | > score | string | Vibe hotness score for this time bucket (0–100 string) | | > mentionCount | string | Number of KOLs participating in discussion within this time bucket | | > kols | array | Representative KOL list for this time bucket | | >> handle | string | KOL's X/Twitter username (without @) | | >> nickname | string | KOL's display name | | >> avatar | string | KOL's avatar image URL | | >> followers | string | KOL's follower count | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/vibe/timeline?chainIndex=1&tokenAddress=0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2&timeFrame=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "summary": { "score": "82", "scoreType": "dex_vibe_hotness", "scoreRange": "0-100", "scoreChangeRate": "+15.3", "mentionsCount": "8450", "mentionsCountChangeRate": "+22.1", "engagement": "345600", "engagementChangeRate": "+18.7", "impressions": "12800000", "impressionsChangeRate": "+25.4", "supportFirstMentioned": true }, "timeline": [ { "ts": "1697544101000", "score": "65", "mentionCount": "42", "kols": [ { "handle": "VitalikButerin", "nickname": "vitalik.eth", "avatar": "https://pbs.twimg.com/profile_images/977496875887558661/L86xyLF4_400x400.jpg", "followers": "5200000" } ] }, { "ts": "1697547701000", "score": "78", "mentionCount": "68", "kols": [ { "handle": "sassal0x", "nickname": "sassal.eth", "avatar": "https://pbs.twimg.com/profile_images/example_400x400.jpg", "followers": "180000" } ] } ] } } ``` - [Get Top KOLs for Token](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-vibe-top-kols.md) {/* api-page */} # Get Top KOLs for Token Retrieve the top Key Opinion Leaders (KOLs) discussing a specific token, sorted by engagement, mentions, or impressions. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/social/vibe/top-kols` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | string | Yes | Chain ID, e.g. 1=Ethereum, 56=BNB Chain, 501=Solana. | | tokenAddress | string | Yes | Token contract address. EVM chains use 0x... format; Solana uses Base58 encoding. | | sortBy | string | No | KOL sort order: 1=engagement, 2=mentions, 3=impressions. Default 1. | | timeFrame | string | No | Statistical period: 1=24h (last 24 hours), 2=72h (last 72 hours), 3=7d (last 7 days), 4=30d (last 30 days). Default 1. | | limit | string | No | Number of KOLs to return, range [1, 50], default 20. Upstream maximum is TOP 50; results will be truncated if exceeded. | ## Response Parameters | Field | Type | Description | |---|---|---| | kols | array | Top KOL list, up to limit records | | > handle | string | KOL's X/Twitter username (without @) | | > nickname | string | KOL's display name | | > avatar | string | KOL's avatar image URL | | > followers | string | KOL's follower count | | > engagement | string | Total engagement by this KOL within the statistical period | | > mentions | string | Number of relevant posts by this KOL within the statistical period | | > impressions | string | Total impressions of this KOL's posts within the statistical period | | > firstMention | object | Information about the KOL's first mention of the token in the statistical period. Null if not available (requires summary.supportFirstMentioned=true to be valid). | | >> time | string | Timestamp of the first mention (Unix milliseconds) | | >> contentId | string | Tweet ID of the first mention | | >> tweetUrl | string | Full URL of the first mention tweet, format: https://x.com/{handle}/status/{contentId} | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/social/vibe/top-kols?chainIndex=1&tokenAddress=0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2&sortBy=1&timeFrame=1&limit=20' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "msg": "", "data": { "kols": [ { "handle": "VitalikButerin", "nickname": "vitalik.eth", "avatar": "https://pbs.twimg.com/profile_images/977496875887558661/L86xyLF4_400x400.jpg", "followers": "5200000", "engagement": "125400", "mentions": "8", "impressions": "4800000", "firstMention": { "time": "1697544101000", "contentId": "1714567890123456789", "tweetUrl": "https://x.com/VitalikButerin/status/1714567890123456789" } }, { "handle": "sassal0x", "nickname": "sassal.eth", "avatar": "https://pbs.twimg.com/profile_images/example_400x400.jpg", "followers": "180000", "engagement": "45200", "mentions": "12", "impressions": "980000", "firstMention": { "time": "1697547701000", "contentId": "1714578901234567890", "tweetUrl": "https://x.com/sassal0x/status/1714578901234567890" } }, { "handle": "AnthonyPompliano", "nickname": "Pomp", "avatar": "https://pbs.twimg.com/profile_images/pomp_400x400.jpg", "followers": "1680000", "engagement": "38900", "mentions": "5", "impressions": "2100000", "firstMention": null } ] } } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/market-social-news-error-code.md) # Error Codes ## API Error Handling | Code | HTTP Status | Message | |------|------------|---------| | 0 | 200 | Success | | 50011 | 429 | Rate limit triggered. Please refer to the API documentation and control request frequency accordingly | | 50014 | 400 | Parameter \{param0\} cannot be empty | | 50026 | 500 | System error. Please try again later | | 50103 | 401 | Request header "OK-ACCESS-KEY" cannot be empty | | 50104 | 401 | Request header "OK-ACCESS-PASSPHRASE" cannot be empty | | 50105 | 401 | Request header "OK-ACCESS-PASSPHRASE" is incorrect | | 50106 | 401 | Request header "OK-ACCESS-SIGN" cannot be empty | | 50107 | 401 | Request header "OK-ACCESS-TIMESTAMP" cannot be empty | | 50111 | 401 | Invalid OK-ACCESS-KEY | | 50112 | 401 | Invalid OK-ACCESS-TIMESTAMP | | 50113 | 401 | Invalid signature | | 51000 | 400 | Parameter \{param0\} is invalid | ## Payment Error Handling | Error Message | Meaning | Troubleshooting | |--------------|---------|----------------| | Empty / null response | Request missing PAYMENT-SIGNATURE or X-PAYMENT header | Include PAYMENT-SIGNATURE or X-PAYMENT in the request after signing | | invalid payment header | PAYMENT-SIGNATURE content is invalid | Check for truncation / character set issues / multiple base64 encodings | | param_mismatch | Required fields missing, address / nonce format invalid, or other parameter issues | Verify that parameters in the signature match the response | | toAddr mismatch | Pay-to address does not match the recipient address in the response, or recipient address is the zero address | Recipient address must match exactly and must not be 0x0000… | | amount mismatch | Signed amount does not match the amount in the response | Align the amount with the response; the value in EIP-3009 must equal the amount in the response | | unsupported_chain | The chainIndex resolved from network is not supported | Currently only X Layer (eip155:196) is supported | | payer_blocked | authorization.from has triggered a business risk control rule | Contact OKX business team / submit a risk control appeal | | risk_address | payer or payTo has triggered a compliance risk control rule (blacklist / sanctioned address) | This address cannot be used for x402; switch to a different address | | resource mismatch | The interface URL at signing time ≠ the current request URL | Always use the current request URL when signing; do not reuse payloads from other URLs | | no matching payment option | The payment token does not match the token required by the endpoint | Sign using the token specified in the response | | invalid_signature | Signature format is invalid (length, r/s range, low s, v value); deferred: Ed25519 verification failed | Use the OKXEvmSigner provided by OKX; do not manually construct EIP-712; tampered value/from cannot be verified | | not_yet_valid | validAfter \> now | Check system clock | | expired | In exact mode, `validBefore <= now` (no 60s grace period currently) | Check system clock | | invalid signature, nonce_used | The EIP-3009 nonce has already been consumed on-chain | Do not replay; generate a fresh 32-byte random nonce and re-sign | | insufficient_balance | Address balance is insufficient to cover the cost of this call | Top up the balance or reduce concurrent payments | | onchain_error | On-chain multicall RPC call failed / sub-call returned failure | Usually caused by node instability; retry the request | | payment processing | Duplicate request with the same signature within the cache window | Do not resubmit the same signature within the cache window | - [API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-reference.md) # API Reference - [Get Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-supported-chain.md) {/* api-page */} # Get Supported Chains Get the list of currently supported chains. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/portfolio/supported/chain` ## Request Parameters None ## Response Parameters | Parameter | Type | Description | |---|---|---| | chainIndex | String | Unique identifier of the chain | | chainName | String | Chain name | | chainLogo | String | Chain logo URL | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/portfolio/supported/chain' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "chainIndex": "1", "chainName": "Ethereum", "chainLogo": "https://static.okx.com/cdn/wallet/logo/ETH-20220328.png" }, { "chainIndex": "501", "chainName": "Solana", "chainLogo": "https://static.okx.com/cdn/wallet/logo/SOL.png" } ], "msg": "" } ``` - [Get Address Portfolio Overview](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-overview.md) {/* api-page */} # Get Address Portfolio Overview Get overview data related to address PnL, including total realized and unrealized PnL, winning rate, Top3 PnL tokens, and buy and sell transaction statistics ## Request Path GET `https://web3.okx.com/api/v6/dex/market/portfolio/overview` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, pass the chain ID (e.g., 501 for Solana), only single-chain query is supported | | walletAddress | String | Yes | Wallet address to query | | timeFrame | String | Yes | Statistical range number for address transactions and PnL (1=1D, 2=3D, 3=7D, 4=1M, 5=3M) | ## Response Parameters | Parameter | Type | Description | |---|---|---| | realizedPnlUsd | String | Realized PnL (USD) | | top3PnlTokenSumUsd | String | Total PnL of Top 3 tokens (USD) | | top3PnlTokenPercent | String | Top 3 tokens PnL percentage | | topPnlTokenList | Array | Top 3 PnL token list | | >tokenContractAddress | String | Token contract address | | >tokenSymbol | String | Token symbol | | >tokenPnLUsd | String | Token PnL (USD) | | >tokenPnLPercent | String | Token PnL percentage | | winRate | String | Win rate | | tokenCountByPnlPercent | Object | Token count statistics categorized by PnL percentage | | >over500Percent | String | Number of tokens with PnL over 500% | | >zeroTo500Percent | String | Number of tokens with PnL between 0% and 500% | | >zeroToMinus50Percent | String | Number of tokens with PnL between -50% and 0% | | >overMinus50Percent | String | Number of tokens with PnL below -50% | | buyTxCount | String | Number of buy transactions | | buyTxVolume | String | Buy transaction volume | | sellTxCount | String | Number of sell transactions | | sellTxVolume | String | Sell transaction volume | | avgBuyValueUsd | String | Average buy value (USD) | | preferredMarketCap | String | Preferred market cap range. Primary preference: `1: less than $100K, 2: $100K-$1M, 3: $1M-$10M, 4: $10M-$100M, 5: greater than $100M` | | buysByMarketCap | Array | Buy statistics categorized by market cap | | >marketCapRange | String | Market cap range. Enum includes: `1: less than $100K, 2: $100K-$1M, 3: $1M-$10M, 4: $10M-$100M, 5: greater than $100M` | | >buyCount | String | Buy count | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/portfolio/overview?chainIndex=1&walletAddress=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045&timeFrame=3' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": { "avgBuyValueUsd": "0", "buyTxCount": "0", "buyTxVolume": "0", "buysByMarketCap": [ { "buyCount": "0", "marketCapRange": "1" }, { "buyCount": "0", "marketCapRange": "2" }, { "buyCount": "0", "marketCapRange": "3" }, { "buyCount": "0", "marketCapRange": "4" }, { "buyCount": "0", "marketCapRange": "5" } ], "preferredMarketCap": "1", "realizedPnlUsd": "0", "sellTxCount": "4", "sellTxVolume": "0", "tokenCountByPnlPercent": { "over500Percent": "0", "overMinus50Percent": "0", "zeroTo500Percent": "0", "zeroToMinus50Percent": "0" }, "top3PnlTokenPercent": "0", "top3PnlTokenSumUsd": "0", "topPnlTokenList": [], "winRate": "0.00" }, "msg": "" } ``` - [Get Address Recent PnL List](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-recent-pnl.md) {/* api-page */} # Get Address Recent PnL List Get a list of recent PnL for an address in reverse chronological order Limit: 1000 records, up to 100 per request ## Request Path GET `https://web3.okx.com/api/v6/dex/market/portfolio/recent-pnl` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, pass the chain ID (e.g., 501 for Solana), only single-chain query is supported | | walletAddress | String | Yes | Wallet address to query | | cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request | | limit | String | No | Number of records per page, max 100 | ## Response Parameters | Parameter | Type | Description | |---|---|---| | cursor | String | Pagination cursor | | pnlList | Array | PnL list | | >chainIndex | String | Unique identifier of the chain | | >tokenContractAddress | String | Token contract address | | >tokenSymbol | String | Token symbol | | >lastActiveTimestamp | String | Last active timestamp (milliseconds) | | >unrealizedPnlUsd | String | Unrealized PnL (USD), returns SELL_ALL if the address has sold all holdings | | >unrealizedPnlPercent | String | Unrealized PnL percentage | | >realizedPnlUsd | String | Realized PnL (USD) | | >realizedPnlPercent | String | Realized PnL percentage | | >totalPnlUsd | String | Total PnL (USD) | | >totalPnlPercent | String | Total PnL percentage | | >tokenBalanceUsd | String | Token balance value (USD) | | >tokenBalanceAmount | String | Token balance amount | | >tokenPositionPercent | String | Token position percentage | | >tokenPositionDuration | Object | Token position duration info | | >>holdingTimestamp | String | Holding start timestamp (milliseconds) | | >>sellOffTimestamp | String | Sell-off timestamp (milliseconds), empty if still holding | | >buyTxCount | String | Number of buy transactions | | >buyTxVolume | String | Buy transaction volume | | >buyAvgPrice | String | Average buy price | | >sellTxCount | String | Number of sell transactions | | >sellTxVolume | String | Sell transaction volume | | >sellAvgPrice | String | Average sell price | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/portfolio/recent-pnl?chainIndex=1&walletAddress=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045&limit=10' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": { "pnlList": [ { "chainIndex": "1", "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7", "tokenSymbol": "USDT", "lastActiveTimestamp": "1710000000000", "unrealizedPnlUsd": "100.00", "unrealizedPnlPercent": "10.00", "realizedPnlUsd": "200.00", "realizedPnlPercent": "20.00", "totalPnlUsd": "300.00", "totalPnlPercent": "30.00", "tokenBalanceUsd": "1000.00", "tokenBalanceAmount": "1000", "tokenPositionPercent": "10.00", "tokenPositionDuration": { "holdingTimestamp": "1700000000000", "sellOffTimestamp": "" }, "buyTxCount": "5", "buyTxVolume": "900.00", "buyAvgPrice": "0.99", "sellTxCount": "2", "sellTxVolume": "400.00", "sellAvgPrice": "1.01" } ] }, "msg": "" } ``` - [Get Address Latest PnL for Specific Token](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-latest-pnl.md) {/* api-page */} # Get Address Latest PnL for Specific Token Get the latest income of the specified token of the address ## Request Path GET `https://web3.okx.com/api/v6/dex/market/portfolio/token/latest-pnl` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, pass the chain ID (e.g., 501 for Solana) | | walletAddress | String | Yes | Wallet address to query | | tokenContractAddress | String | Yes | Token contract address | ## Response Parameters | Parameter | Type | Description | |---|---|---| | totalPnlUsd | String | Total PnL (USD) | | totalPnlPercent | String | Total PnL percent | | unrealizedPnlUsd | String | Unrealized PnL (USD) | | unrealizedPnlPercent | String | Unrealized PnL percent | | realizedPnlUsd | String | Realized PnL (USD) | | realizedPnlPercent | String | Realized PnL percent | | isPnlSupported | Boolean | Whether PnL calculation is supported | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/portfolio/token/latest-pnl?chainIndex=1&walletAddress=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045&tokenContractAddress=0xdac17f958d2ee523a2206206994597c13d831ec7' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": 0, "data": { "totalPnlUsd": "1371.68", "totalPnlPercent": "20.22", "unrealizedPnlUsd": "685.4", "unrealizedPnlPercent": "10.11", "realizedPnlUsd": "-685.4", "realizedPnlPercent": "-10.11", "isPnlSupported": true } } ``` - [Get Address DEX Transaction List](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-dex-history.md) {/* api-page */} # Get Address DEX Transaction List Get the historical DEX transaction list of the address in reverse chronological order Limit: 1000 records, up to 100 per request ## Request Path GET `https://web3.okx.com/api/v6/dex/market/portfolio/dex-history` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | chainIndex | String | Yes | Unique identifier of the chain, pass the chain ID (e.g., 501 for Solana) | | walletAddress | String | Yes | Wallet address to query | | begin | String | Yes | Start timestamp (milliseconds) | | end | String | Yes | End timestamp (milliseconds) | | tokenContractAddress | String | No | Token contract address; if not provided, returns transactions for all tokens | | type | String | No | Transaction type: 1=BUY, 2=SELL, 3=Transfer In, 4=Transfer Out, supports comma-separated multiple types | | cursor | String | No | Pagination cursor, pass the cursor value returned from the previous request | | limit | String | No | Number of records per page, max 100 | ## Response Parameters | Parameter | Type | Description | |---|---|---| | transactionList | Array | Transaction list | | >type | String | Transaction type (1=BUY, 2=SELL, 3=Transfer In, 4=Transfer Out) | | >chainIndex | String | Unique identifier of the chain | | >tokenContractAddress | String | Token contract address | | >tokenSymbol | String | Token symbol | | >valueUsd | String | Transaction value (USD) | | >amount | String | Token amount | | >price | String | Transaction price | | >marketCap | String | Market cap | | >pnlUsd | String | PnL (USD) | | >time | String | Transaction timestamp (milliseconds) | | cursor | String | Pagination cursor for retrieving the next page of data | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/portfolio/dex-history?chainIndex=1&walletAddress=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045&begin=1700000000000&end=1710000000000&limit=10' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": { "transactionList": [ { "type": "1", "chainIndex": "1", "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7", "tokenSymbol": "USDT", "valueUsd": "1000.00", "amount": "1000", "price": "1.00", "marketCap": "100000000000", "pnlUsd": "50.00", "time": "1709900000000" } ], "cursor": "0" }, "msg": "" } ``` - [Get Latest DEX Trades for Multiple Addresses](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-address-tracker-trades.md) {/* api-page */} # Get Latest DEX Trades for Multiple Addresses Retrieve on-chain transaction dynamics of tracked addresses. Supports filtering by dynamic type (custom grouping, platform KOL addresses, smart money addresses), trade type, volume, market cap, liquidity, chain, and more. ## Request Path GET `https://web3.okx.com/api/v6/dex/market/address-tracker/trades` ## Request Parameters | Parameter | Type | Required | Description | |---|---|---|---| | trackerType | String | Yes | Track dynamic type. 1: smart_money, platform smart money addresses; 2: kol, platform Top 100 KOL addresses; 3: multi_address, query multiple addresses | | walletAddress | String | No | Required when trackerType=multi_address. Can be a single address or multiple addresses separated by commas, up to 20 | | tradeType | String | No | Trade type: 0: all (default); 1: buy; 2: sell | | chainIndex | String | No | Chain identifier, defaults to all. Options: 501 (Solana), 1 (Ethereum), 56 (BNB Chain), 8453 (Base), 196 (X Layer) | | minVolume | String | No | Minimum trade volume (USD) | | maxVolume | String | No | Maximum trade volume (USD) | | minHolders | String | No | Minimum number of holding addresses | | minMarketCap | String | No | Minimum market cap (USD) | | maxMarketCap | String | No | Maximum market cap (USD) | | minLiquidity | String | No | Minimum liquidity (USD) | | maxLiquidity | String | No | Maximum liquidity (USD) | ## Response Parameters | Parameter | Type | Description | |---|---|---| | trades | Array | List of transaction dynamics for tracked addresses | | >txHash | String | Transaction hash | | >walletAddress | String | Wallet address of the transaction | | >quoteTokenSymbol | String | Pricing token symbol; only mainnet tokens are returned here | | >quoteTokenAmount | String | Quantity of pricing tokens traded, indicating the amount priced in the mainnet token | | >tokenSymbol | String | Trading token symbol | | >tokenContractAddress | String | Trading token contract address | | >chainIndex | String | Chain identifier where the trading token is located | | >tokenPrice | String | Trading price of the token (USD) | | >marketCap | String | Market cap corresponding to the token's transaction price (USD) | | >realizedPnlUsd | String | Realized profit and loss of the trading token (USD) | | >tradeType | String | Trade type for the token: 1: buy; 2: sell | | >tradeTime | String | Transaction time (millisecond timestamp) | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/market/address-tracker/trades?trackerType=1' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": { "trades": [ { "chainIndex": "56", "marketCap": "6781.4431281050000000000000000000", "quoteTokenAmount": "0.105214264768396182", "quoteTokenSymbol": "BSC", "realizedPnlUsd": "-28.212213718646256043110124512", "tokenContractAddress": "0xcad59e019f06003303e56d4cc38fab0667114444", "tokenPrice": "0.000006781443128105", "tokenSymbol": "DoraemonToken", "tradeTime": "1773736186000", "tradeType": "2", "txHash": "0x1daf1ab1c393ea5bf901f2d8efdd4a67ce1e1e0e7dfd748820e195f2398a8afd", "walletAddress": "0xeb1222a0c07d4e62b0235d8b4b3e7e617d259be2" } ] }, "msg": "" } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/market-portfolio-error-code.md) # Error Codes ## API error handling | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------------------------------| | 0 | 200 | Succeeded | | 50011 | 429 | Rate limit reached. Please refer to API documentation and throttle requests accordingly | | 50014 | 400 | Parameter \{param0\} cannot be empty | | 50026 | 500 | System error. Try again later | | 50103 | 401 | Request header "OK-ACCESS-KEY" cannot be empty | | 50104 | 401 | Request header "OK-ACCESS-PASSPHRASE" cannot be empty| | 50105 | 401 | Request header "OK-ACCESS-PASSPHRASE" incorrect | | 50106 | 401 | Request header "OK-ACCESS-SIGN" cannot be empty | | 50107 | 401 | Request header "OK-ACCESS-TIMESTAMP" cannot be empty | | 50111 | 401 | Invalid OK-ACCESS-KEY | | 50112 | 401 | Invalid OK-ACCESS-TIMESTAMP | | 50113 | 401 | Invalid signature | | 51000 | 400 | Parameter \{param0\} error | ## Payment error handling | Error Message | Meaning | Troubleshooting Action | |------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | Empty / null response | Request did not include PAYMENT-SIGNATURE or X-PAYMENT header | Include PAYMENT-SIGNATURE or X-PAYMENT in the request after signing | | invalid payment header | PAYMENT-SIGNATURE content is invalid | Check for truncation / encoding issues / multiple base64 nesting | | param_mismatch | Missing required fields or invalid parameters (address / nonce format) | Verify that parameters in the signature match the expected values | | toAddr mismatch | PayTo address does not match or is zero address | Ensure the address matches exactly and is not 0x0000… | | amount mismatch | Signed amount does not match returned amount | Ensure value in EIP-3009 signature equals the returned amount | | unsupported_chain | Parsed chainIndex from network is not supported | Currently only X Layer (eip155:196) is supported | | payer_blocked | authorization.from triggered risk control rules | Contact OKX support / risk team | | risk_address | payer or payTo is flagged (blacklist / sanctioned address) | Use a different address | | resource mismatch | Signed URL does not match request URL | Use the exact request URL when signing; do not reuse payload | | no matching payment option | Payment token does not match required token | Sign using the token specified in the response | | invalid_signature | Invalid signature format (length, r/s range, v value, etc.) | Use OKXEvmSigner; avoid manual EIP-712 construction | | not_yet_valid | validAfter > now | Check system time | | expired | `validBefore <= now` | Check system time | | invalid signature, nonce_used | Nonce already used on-chain | Generate a new 32-byte nonce and sign again | | insufficient_balance | Insufficient balance | Fund the account or reduce concurrent payments | | onchain_error | On-chain RPC / multicall failure | Retry the request | | payment processing | Duplicate request within cache window | Avoid reusing the same signature within cache period | - [API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/balance-reference.md) # API Reference - [Get Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/balance-chains.md) {/* api-page */} # Get Supported Chains Retrieve information on chains supported by the DEX Balance endpoint ## Request URL GET `https://web3.okx.com/api/v6/dex/balance/supported/chain` ## Request Parameters None ## Response Parameters | Parameter | Type | Description | |-----------|--------|-------------------| | name | String | Chain name | | logoUrl | String | Chain logo URL | | shortName | String | Chain short name | | chainIndex| String | Chain unique identifier | ## Request Example ``` shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/balance/supported/chain' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "name": "Ethereum", "logoUrl": "http://www.eth.org/eth.png", "shortName": "ETH", "chainIndex": "1" } ], "msg": "" } ``` - [Get Total Value](https://web3pre.okex.org/onchainos/dev-docs/market/balance-total-value.md) {/* api-page */} # Get Total Value Retrieve the total balance of all tokens and DeFi assets under an account. ## Request URL GET `https://web3.okx.com/api/v6/dex/balance/total-value-by-address` ## Request Parameters | Parameter | Type | Required | Description | | ------------------| ------- | -------- | ------------------------------------------------------------------ | | address | String | Yes | Get the total valuation for the address | | chains | String | Yes | Filter chains for which to query total assets, separated by ",". Supports up to 50 chains..
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | assetType | String | No | Query balance type. Default is to query all asset balances.
`0`: Query total balance for all assets, including tokens and DeFi assets.
`1`: Query only token balance.
`2`: Query only DeFi balance. | | excludeRiskToken | Boolean | No | Option to filter out risky airdrop & honeypot tokens. Default is to filter.
`true`: filter out, `false`: do not filter out
It supports only `ETH`、`BSC`、`SOL`、`BASE` for honeypot tokens, more chains will be supported soon. | ## Response Parameters | Parameter | Type | Description | | --- | --- | --- | | totalValue | String | Total asset balance based on the query type, returned in USD | ## Request Example ``` shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/balance/total-value-by-address?address=0x0b32aa5c1e71715206fe29b7badb21ad95f272c0&chains=1&assetType=0' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ``` json { "code": "0", "msg": "success", "data": [ { "totalValue": "1172.895057177065864522056725546579939398" } ] } ``` - [Get Total Token Balances](https://web3pre.okex.org/onchainos/dev-docs/market/balance-total-token-balances.md) {/* api-page */} # Get Total Token Balances Retrieve the list of token balances for an address across multiple chains or specified chains. ## Request URL GET `https://web3.okx.com/api/v6/dex/balance/all-token-balances-by-address` ## Request Parameters | Parameter | Type | Required | Description | |----------------|--------|----------|-----------------------------------------| | address | String | Yes | Address | | chains | Array | Yes | When filtering the chains for querying asset details, multiple chains should be separated by commas (`,`). A maximum of 50 chains is supported.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain).| | excludeRiskToken | String | No | Option to filter out risky airdrop & honeypot tokens. Default is to filter.
`0`: Filter out
`1`: Do not filter out
It supports only `ETH`、`BSC`、`SOL`、`BASE` for honeypot tokens, more chains will be supported soon. | ## Response Parameters | Parameter | Type | Description | |---------------|--------|------------------------------------------| | tokenAssets | Array | List of token balances | | >chainIndex | String | Unique identifier for the chain | | >tokenContractAddress | String | Contract address | | >address | String | Address | | >symbol | String | Token symbol | | >balance | String | Token balance | | >rawBalance | String | Raw balance of token address. For unsupported chains, this field is empty. More chains will be supported soon. | | >tokenPrice | String | Token unit value, priced in USD | | >isRiskToken | Boolean| `true`: flagged as a risky airdrop & honeypot token
`false`: not flagged as a risky airdrop & honeypot token | ## Request Example ``` shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/balance/all-token-balances-by-address?address=0xEd0C6079229E2d407672a117c22b62064f4a4312&chains=1' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ``` json { "code": "0", "msg": "success", "data": [ { "tokenAssets": [ { "chainIndex": "1", "tokenContractAddress": "0x386ae941d4262b0ee96354499df2ab8442734ec0", "symbol": "PT-sUSDE-27FEB2025", "balance": "47042180.520700015", "tokenPrice": "0.968391562089677097", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0", "symbol": "wstETH", "balance": "7565.892480395067", "tokenPrice": "4321.611627695311", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599", "symbol": "WBTC", "balance": "329.10055205", "tokenPrice": "98847.8", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x23878914efe38d27c4d67ab83ed1b93a74d4086a", "symbol": "aEthUSDT", "balance": "30057379.938443", "tokenPrice": "0.99978", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x657e8c867d8b37dcc18fa4caead9c45eb088c642", "symbol": "eBTC", "balance": "271.94970471", "tokenPrice": "99094.345321371", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x4d5f47fa6a74757f35c14fd3a6ef8e3c9bc514e8", "symbol": "aEthWETH", "balance": "6080.001975381972", "tokenPrice": "3634.32", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xe00bd3df25fb187d6abbb620b3dfd19839947b81", "symbol": "PT-sUSDE-27MAR2025", "balance": "19016580.895408865", "tokenPrice": "0.952031186961110727", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xa17581a9e3356d9a858b789d68b4d866e593ae94", "symbol": "cWETHv3", "balance": "3000.000734740809", "tokenPrice": "3663.74", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x9d39a5de30e57443bff2a8307a4256c8797a3497", "symbol": "sUSDe", "balance": "4863500.628333919", "tokenPrice": "1.144688569528375454", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xec5a52c685cc3ad79a6a347abace330d69e0b1ed", "symbol": "PT-LBTC-27MAR2025", "balance": "46.02912324", "tokenPrice": "97165.169717785655331396", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x8236a87084f8b84306f72007f36f2618a5634494", "symbol": "LBTC", "balance": "38.09998", "tokenPrice": "99187.19184268864", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xbeef047a543e45807105e51a8bbefcc5950fcfba", "symbol": "steakUSDT", "balance": "482651.8612595832", "tokenPrice": "1.063", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x4c9edd5852cd905f086c759e8383e09bff1e68b3", "symbol": "USDe", "balance": "69564", "tokenPrice": "0.99977", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x8be3460a480c80728a8c4d7a5d5303c85ba7b3b9", "symbol": "sENA", "balance": "42294.989425", "tokenPrice": "1.19", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "", "symbol": "ETH", "balance": "8.135546539084933", "tokenPrice": "3638.63", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xbf5495efe5db9ce00f80364c8b423567e58d2110", "symbol": "ezETH", "balance": "5.270854886240325", "tokenPrice": "3763.152404188635320082", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x6b175474e89094c44da98b954eedeac495271d0f", "symbol": "DAI", "balance": "1196.2693184870445", "tokenPrice": "1.0002", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xc00e94cb662c3520282e6f5717214004a7f26888", "symbol": "COMP", "balance": "0.007643", "tokenPrice": "84.43345772756197", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x9abfc0f085c82ec1be31d30843965fcc63053ffe", "symbol": "Q*", "balance": "900", "tokenPrice": "0.000419255747329174", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xa1290d69c65a6fe4df752f95823fae25cb99e5a7", "symbol": "rsETH", "balance": "0.00007090104120006", "tokenPrice": "3765.640772858747921444", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x56015bbe3c01fe05bc30a8a9a9fd9a88917e7db3", "symbol": "CAT", "balance": "0.42", "tokenPrice": "0.06242994543936436", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xec53bf9167f50cdeb3ae105f56099aaab9061f83", "symbol": "EIGEN", "balance": "0.002496149915967488", "tokenPrice": "4.018538365202288", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x58d97b57bb95320f9a05dc918aef65434969c2b2", "symbol": "MORPHO", "balance": "0.001409373661132556", "tokenPrice": "3.3568669630371337", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xaf5191b0de278c7286d6c7cc6ab6bb8a73ba2cd6", "symbol": "STG", "balance": "0.000009547670354338", "tokenPrice": "0.49707759500034454", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xba3335588d9403515223f109edc4eb7269a9ab5d", "symbol": "GEAR", "balance": "0.000009005734110189", "tokenPrice": "0.012329598382413718", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x35fa164735182de50811e8e2e824cfb9b6118ac2", "symbol": "eETH", "balance": "0.000000000000000001", "tokenPrice": "3637.93", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84", "symbol": "stETH", "balance": "0.000000000000000001", "tokenPrice": "3637.93", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xa3931d71877c0e7a3148cb7eb4463524fec27fbd", "symbol": "sUSDS", "balance": "67435907.43236613", "tokenPrice": "0", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xa8705a14c79fa1cded70875510211fec822b3c30", "symbol": "BEEX", "balance": "5000000", "tokenPrice": "0", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0xabc0abace9fb9625fcefbedc423e8f94225bd251", "symbol": "TANUKI", "balance": "3548102.746002181", "tokenPrice": "0", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" }, { "chainIndex": "1", "tokenContractAddress": "0x356b8d89c1e1239cbbb9de4815c39a1474d5ba7d", "symbol": "syrupUSDT", "balance": "1750000", "tokenPrice": "0", "isRiskToken": false, "rawBalance": "", "address": "0xed0c6079229e2d407672a117c22b62064f4a4312" } ] } ] } ``` - [Get Specific Token Balance](https://web3pre.okex.org/onchainos/dev-docs/market/balance-specific-token-balance.md) {/* api-page */} # Get Specific Token Balance Query the balance of a specific token under an address. ## Request URL POST `https://web3.okx.com/api/v6/dex/balance/token-balances-by-address` ## Request Parameters | Parameter | Type | Required | Description | |----------------|--------|----------|-----------------------------------------| | address | String | Yes | Address | | tokenContractAddresses | Array | Yes | List of tokens addresses to query. Maximum of 20 items. | | >chainIndex | String | Yes | Unique identifier for the chain.
e.g., `1`: Ethereum.
See more [here](../home/supported-chain). | | >tokenContractAddress | String | Yes | Token address.
`1`: Pass an empty string `""` to query the native token of the corresponding chain.
`2`: Pass the specific token contract address to query the corresponding token. | | excludeRiskToken | String | No | Option to filter out risky airdrop & honeypot tokens. Default is to filter
`0`: Filter out
`1`: Do not filter out
It supports only `ETH`、`BSC`、`SOL`、`BASE` for honeypot tokens, more chains will be supported soon. | ## Response Parameters | Parameter | Type | Description | |--------------|--------|-----------------------------------------| | tokenAssets | Array | List for token balances | | >chainIndex | String | Unique identifier for the chain | | >tokenContractAddress | String | Token address.If the return is an empty string `""`, it means the query is for the native token of the corresponding blockchain. | | >address | String | Address | | >symbol | String | Token symbol | | >balance | String | Token balance. | | >rawBalance | String | Raw balance of token address. For unsupported chains, this field is empty. More chains will be supported soon. | | >tokenPrice | String | Token price in USD | | >isRiskToken | Boolean| `true`: flagged as a risky airdrop & honeypot token
`false`: not flagged as a risky airdrop & honeypot token | ## Request Example ```shell curl --location --request POST 'https://web3.okx.com/api/v6/dex/balance/token-balances' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \ --data-raw '{ "address": "0x50c476a139aab23fdaf9bca12614cdd54a4244e3", "tokenContractAddresses": [ { "chainIndex": "1", "tokenContractAddress": "" } ] }' ``` ## Response Example ``` json { "code": "0", "msg": "success", "data": [ { "tokenAssets": [ { "chainIndex": "1", "tokenContractAddress": "", "symbol": "eth", "balance": "0", "tokenPrice": "3640.43", "isRiskToken": false, "rawBalance": "", "address": "" } ] } ] } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/balance-error-code.md) # Error Codes | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------| | 50014 | 400 | param \{param0\} is invalid | | 50001 | 200 | Service temporarily unavailable. Try again later | | 81001 | 200 | Incorrect parameter: : \{param0\} | | 50011 | 429 | Too Many Requests | | 81104 | 200 | Chain not support | | 81001 | 200 | Required request body is missing | - [API Reference](https://web3pre.okex.org/onchainos/dev-docs/market/tx-history-reference.md) # API Reference - [Get Supported Chains](https://web3pre.okex.org/onchainos/dev-docs/market/tx-history-chains.md) {/* api-page */} # Get Supported Chains Retrieve information on chains supported by Transaction history API ## Request URL GET `https://web3.okx.com/api/v6/dex/balance/supported/chain` ## Request Parameters None ## Response Parameters | Parameter | Type | Description | |-----------|--------|-------------------| | name | String | Chain name | | logoUrl | String | Chain logo URL | | shortName | String | Chain short name | | chainIndex| String | Chain unique identifier | ## Request Example ``` shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/balance/supported/chain' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ```json { "code": "0", "data": [ { "name": "Ethereum", "logoUrl": "http://www.eth.org/eth.png", "shortName": "ETH", "chainIndex": "1" } ], "msg": "" } ``` - [Get History by Address](https://web3pre.okex.org/onchainos/dev-docs/market/tx-history-transactions-by-address.md) {/* api-page */} # Get History by Address Query the transaction history under the address dimension for 6 months, sorted in descending chronological order. ## Request URL GET `https://web3.okx.com/api/v6/dex/post-transaction/transactions-by-address` ## Request Parameters | Parameter | Type | Required | Description | |-------------- |-------- |---------- |--------------------------------------------------------------------------------------------------------------- | | address | String | Yes | Address to query the transaction history for | | chains | String | No | Filter the chains whose transaction history needs to be queried. Multiple chains are separated by ",". A maximum of 50 chains are supported. | | tokenContractAddress | String | No | Token contract address; if empty, query addresses with main chain currency balance;if not pass, query all | | begin | String | No | Start time, queries transactions after this time. Unix timestamp, in milliseconds | | end | String | No | End time, queries transactions before this time. If both begin and end are not provided, queries transactions before the current time. Unix timestamp, in milliseconds | | cursor | String | No | Cursor | | limit | String | No | Number of records to return, defaults to the most recent 20 records.
Up to a maximum of 20 records for query on single chain.
Up to a maximum of 100 records for query on multiple chain. | | ## Response Parameters | Parameter | Type | Description | |----------------- |--------------------------------- |----------------------------------------------------- | | transactions | Array | List of transactions | | >chainIndex | String | Chain ID | | >txHash | String | Transaction hash | | >itype | String | Transaction tier type
`0`: Outer main chain coin transfer
`1`: Contract inner main chain coin transfer
`2`: Token transfer | | >methodId | String | Contract Function Call | | >nonce | String | The nth transaction initiated by the sender address | | >txTime | String | Transaction time in Unix timestamp format, in milliseconds, e.g., 1597026383085 | | >from | Array | Transaction input | | >>address | String | Sending/input address, comma-separated for multi-signature transactions | | >>amount | String | Input amount | | >to | Array | Transaction output | | >>address | String | Receiving/output address, comma-separated for multiple addresses | | >>amount | String | Output amount | >tokenContractAddress | String | Token contract address | | >amount | String | Transaction amount | | >symbol | String | Currency symbol corresponding to the transaction amount | | >txFee | String | Transaction fee | | >txStatus | String | Transaction status: `success` for successful transactions, `fail` for failed transactions, `pending` for pending transactions | | >hitBlacklist | Boolean | `false`: Not in blacklist, `true`: In blacklist | | cursor | String | Cursor | ## Request Example ``` shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/post-transaction/transactions-by-address?addresses=0x50c476a139aab23fdaf9bca12614cdd54a4244e4&chains=1' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ``` json { "code": "0", "msg": "success", "data": [ { "cursor": "1706197403", "transactionList": [ { "chainIndex": "1", "txHash": "0x963767695543cfb7804039c470b110b87adf9ab69ebc002b571523b714b828ca", "methodId": "", "nonce": "", "txTime": "1724213411000", "from": [ { "address": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84" "amount": "" } ], "to": [ { "address": "0x50c476a139aab23fdaf9bca12614cdd54a4244e4" "amount": "" } ], "tokenContractAddress": "0xe13c851c331874028cd8f681052ad3367000fb13", "amount": "1", "symbol": "claim rewards on stethdao.net", "txFee": "", "txStatus": "success", "hitBlacklist": true, "itype": "2" } ] } ] } ``` - [Get Specific Transaction](https://web3pre.okex.org/onchainos/dev-docs/market/tx-history-specific-transaction-detail-by-txhash.md) {/* api-page */} # Get Specific Transaction Retrieve details of a transaction based on `txHash` for 6 months. It decomposes a transaction and its internal transactions into sub-transactions based on asset type:
`0`: Outer layer mainnet coin transfer
`1`: Inner layer mainnet coin transfer in a contract
`2`: Token transfer It decomposes a transaction into sub-transactions based on asset type. For EVM transactions, different sub-transaction types include:
`0`: Outer layer mainnet coin transfer
`1`: Inner layer mainnet coin transfer in a contract
`2`: Token transfer ## Request URL GET `https://web3.okx.com/api/v6/dex/post-transaction/transaction-detail-by-txhash` ## Request Parameters | Parameter | Type | Required | Description | |--------------------|----------------|------------------|--------------------------------------------------------------------------| | chainIndex | String | Yes | Unique identifier for the chain | | txHash | String | Yes | Transaction hash | | itype | String | No | Layer type for transactions
`0`: Outer layer mainnet coin transfer
`1`: Inner layer mainnet coin transfer
`2`: Token transfer | ## Response Parameters | Parameter | Type | Description | |------------------------------------|----------------|----------------------------------------------------------------| | chainIndex | String | Unique identifier for the chain | | height | String | Block height where the transaction occurred | | txTime | String | Transaction time; Unix timestamp in milliseconds | | txhash | String | Transaction hash | | txStatus | String | Transaction status:
`1`: pending
`2`: success
`3`: fail | | gasLimit | String | Gas limit | | gasUsed | String | Gas used | | gasPrice | String | Gas price | | txFee | String | Transaction fee. | | nonce | String | Nonce | | amount | String | Transaction amount | | symbol | String | Currency symbol for the transaction amount | | methodId | String | Contract method ID | | fromDetails | Array | Details of transaction inputs | | >address | String | Sender/input address | | >vinIndex | String | Index of the input in the current transaction | | >preVoutIndex | String | Index of the output in the previous transaction | | >txhash | String | Transaction hash, used with `preVoutIndex` to uniquely identify the UTXO | | >isContract | Boolean | Whether the sender address is a contract (true: yes; false: no) | | >amount | String | Transaction amount | | toDetails | Array | Details of transaction outputs | | >address | String | Receiver/output address | | >voutIndex | String | Output index | | >isContract | Boolean | Whether the receiver address is a contract (true: yes; false: no) | | >amount | String | Transaction amount | | internalTransactionDetails | Array | Internal transaction details | | >from | String | Sender address for the internal transaction | | >to | String | Receiver address for the internal transaction | | >isFromContract | Boolean | Whether the sender address is a contract (true: yes; false: no) | | >isToContract | Boolean | Whether the receiver address is a contract (true: yes; false: no) | | >amount | String | Transaction amount | | >txStatus | String | Transaction status | | tokenTransferDetails | Array | Token transfer details | | >from | String | Sender address for token transfer | | >to | String | Receiver address for token transfer | | >isFromContract | Boolean | Whether the sender address is a contract (true: yes; false: no) | | >isToContract | Boolean | Whether the receiver address is a contract (true: yes; false: no) | | >tokenContractAddress | String | Token contract address | | >symbol | String | Token symbol | | >amount | String | Token amount | | l1OriginHash | String | Hash of the L1 transaction executed | ## Request Example ```shell curl --location --request GET 'https://web3.okx.com/api/v6/dex/post-transaction/transaction-detail-by-txhash?txHash=0x9ab8ccccc9f778ea91ce4c0f15517672c4bd06d166e830da41ba552e744d29a5&chainIndex=42161' \ --header 'Content-Type: application/json' \ --header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \ --header 'OK-ACCESS-SIGN: leaV********3uw=' \ --header 'OK-ACCESS-PASSPHRASE: 1****6' \ --header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' ``` ## Response Example ``` json { "code": "0", "msg": "success", "data": [ { "chainIndex": "42161", "height": "245222398", "txTime": "1724253417000", "txhash": "0x9ab8ccccc9f778ea91ce4c0f15517672c4bd06d166e830da41ba552e744d29a5", "gasLimit": "2000000", "gasUsed": "2000000", "gasPrice": "10000000", "txFee":"", "nonce": "0", "symbol": "ETH", "amount": "0", "txStatus": "success", "methodId": "0xc9f95d32", "l1OriginHash": "0xa6a87ba2f18cc32bbae8f3b2253a29a9617ed1eb0940d80443f6e3bf9873dbad", "fromDetails": [ { "address": "0xd297fa914353c44b2e33ebe05f21846f1048cfeb", "vinIndex": "", "preVoutIndex": "", "txHash": "", "isContract": false, "amount": "" } ], "toDetails": [ { "address": "0x000000000000000000000000000000000000006e", "voutIndex": "", "isContract": false, "amount": "" } ], "internalTransactionDetails": [ { "from": "0x0000000000000000000000000000000000000000", "to": "0xd297fa914353c44b2e33ebe05f21846f1048cfeb", "isFromContract": false, "isToContract": false, "amount": "0.02", "txStatus": "success" }, { "from": "0xd297fa914353c44b2e33ebe05f21846f1048cfeb", "to": "0x428ab2ba90eba0a4be7af34c9ac451ab061ac010", "isFromContract": false, "isToContract": false, "amount": "0.00998", "txStatus": "success" }, { "from": "0xd297fa914353c44b2e33ebe05f21846f1048cfeb", "to": "0x428ab2ba90eba0a4be7af34c9ac451ab061ac010", "isFromContract": false, "isToContract": false, "amount": "0.009977946366846017", "txStatus": "success" } ], "tokenTransferDetails": [] } ] } ``` - [Error Codes](https://web3pre.okex.org/onchainos/dev-docs/market/tx-history-error-code.md) # Error Codes | Code | HTTP status | Message | |-------|-------------|-----------------------------------------------------------------------------------------| | 81001 | 200 | Incorrect parameter | - [Support](https://web3pre.okex.org/onchainos/dev-docs/market/support.md) # Support If you have any questions or feedback regarding the Market API, please feel free to contact us through the following support channels. ## Technical Support - Technical inquiries: [Discord Developer Community](https://discord.gg/mUqMWaFGyW). - Developers are encouraged to join the real-time technical discussion channel. ## Business Support - Business cooperation: dexapi@okx.com - For enterprise service requests, please include your company name and contact information. - [X Layer Developer Documentation](https://web3pre.okex.org/onchainos/dev-docs/xlayer/developer/build-on-xlayer/about-xlayer.md) # X Layer Developer Documentation X Layer is an Ethereum Layer 2 (L2) network, built by OKX on an enhanced Optimism Stack, designed to provide developers with a superior environment for scaling applications. **Key Developer Advantages** - **Full EVM Equivalence:** Deploy your existing Ethereum applications without any code modifications. - **Exceptional Performance:** Achieve massive scalability with support for up to 20,000 TPS and negligible gas fees. - **Battle-Tested Security:** X Layer leverages the robust optimistic rollup architecture, inheriting the security guarantees of Ethereum, but with a simpler, more efficient operational model than ZK rollups. - **Enterprise-Grade Reliability:** Features like the Conductor high-availability cluster ensure sequencer redundancy, offering 99.9% uptime for your production-ready dapps. ## X Layer architecture The major components of X Layer are: - **Virtual Machine**: EVM‑equivalent - **Sequencer**: Trusted (implemented by op-node in sequencer mode, coordinating with op-reth via Engine API) - **Gas token**: OKB (fixed supply at 21M post-burns/upgrades; L1 OKB phased out) ## Background X Layer has evolved to adopt the Optimism Stack (OP Stack) framework, a battle-tested and widely adopted Layer 2 scaling solution. In this architecture, L2 operates with optimistic assumptions where transactions are considered valid by default, with a 7-day challenge period for fraud proofs. This provides a more efficient and cost-effective solution while maintaining Ethereum's security guarantees through cryptographic fraud proofs when needed. ## Architecture flow (OP Stack + AggLayer mode) **Phase 1: From L1 to L2** Process of bridging assets from ETH to X Layer | Step | Action | Description | |------|--------|-------------| | 1.1 | User Deposit | The user sends assets to the L1 bridge contract. | | 1.2 | Event Sync | The **Bridge Service** monitors (ingests) the L1 contract events. | | 1.3 | L2 Claim/Mint | The Bridge Service sends an L2 transaction (via RPCs) to claim/mint the asset on X Layer. | | 1.4 | Block Inclusion | The **Sequencer** includes this transaction in an L2 block. | | 1.5 | User Update | RPCs expose the updated balance/status to the user. | **Phase 2: Execution and withdrawal back to L1** Standard L2 operations and process of initiating withdrawal back to L1 | Step | Action | Description | |------|--------|-------------| | 2.1 | Withdrawal Tx | The user sends an L2 withdrawal transaction via RPCs. | | 2.2 | Block Generation | The Sequencer continues to generate blocks. | | 2.3 | Data Persistence | The `L2BridgeSyncer` and `L1InfoTreeSyncer` persist chain data and L1 info updates needed for the Pessimistic Proof (PP). | **Phase 3: Cross-Chain Settlement & Proof (AggLayer)** This phase involves proving and finalizing the withdrawal on L1 using the AggLayer. | Step | Action | Description | |------|--------|-------------| | 3.1 | Certificate Prep | The `aggsender` fetches blocks, stores certificate metadata, and performs double-checks. | | 3.2 | Certificate Submission | The `aggsender` submits the certificate to the **AggLayer**. | | 3.3 | ZK Proof Generation | The agglayer-prover generates the ZK proof; the AggLayer submits the certificate proof and public inputs to L1. | | 3.4 | L1 Finality | After **L1 verification**, withdrawals and messages achieve L1 finality (PP is verified). | **Phase 4: Continuous System Synchronization** | Step | Action | Description | |------|--------|-------------| | 4.1 - 4.2 | Continuous Sync | The Bridge Service continuously synchronizes both L2 and L1 contract events to maintain state consistency. | Outcome: Fast execution happens on L2 with 1-second block times. All L2 data is published to L1, ensuring the system is fully trustless and censorship-resistant. This flow ensures immediate transaction finality on L2 for most operations while providing cryptographic security for cross-chain operations through the optimistic rollup model. - [Network information](https://web3pre.okex.org/onchainos/dev-docs/xlayer/developer/build-on-xlayer/network-information.md) # Network information Welcome to X Layer developer documentation. ## Connecting to X Layer (Mainnet) You can add X Layer mainnet by inputting the following network info: |Properties|Network details| |:----|:----| |Network name|X Layer mainnet| |RPC URL|https://rpc.xlayer.tech, https://xlayerrpc.okx.com| |Chain ID|196| |Token symbol|OKB| |Block explorer URL|https://www.okx.com/web3/explorer/xlayer| ## Connecting to X Layer (Testnet) You can add X Layer testnet by inputting the following network info: |Properties|Network details| |:----|:----| |Network name|X Layer testnet| |RPC URL|https://testrpc.xlayer.tech/terigon, https://xlayertestrpc.okx.com/terigon| |Chain ID|1952| |Token symbol|OKB| |Block explorer URL|https://www.okx.com/web3/explorer/xlayer-test| - [Contracts](https://web3pre.okex.org/onchainos/dev-docs/xlayer/developer/build-on-xlayer/contracts.md) # Contracts ## X Layer contracts These smart contracts facilitate operation on Ethereum Mainnet and Sepolia Testnet. ### Ethereum Layer 1 |Name|Detail|Mainnet address|Testnet address| |:----|:--|:--|:--| |SystemConfig|Manages OP Stack network configuration, stores network parameters and other contract addresses|[0x5065809Af286321a05fBF85713B5D5De7C8f0433](https://etherscan.io/address/0x5065809Af286321a05fBF85713B5D5De7C8f0433)|[0x06BE4b4A9a28fF8EED6da09447Bc5DAA676efac3](https://sepolia.etherscan.io/address/0x06BE4b4A9a28fF8EED6da09447Bc5DAA676efac3)| |L1CrossDomainMessenger|High-level message passing interface between L1 and L2|[0xF94B553F3602a03931e5D10CaB343C0968D793e3](https://etherscan.io/address/0xF94B553F3602a03931e5D10CaB343C0968D793e3)|[0xEf40d5432D37B3935a11710c73F395e2c9921295](https://sepolia.etherscan.io/address/0xEf40d5432D37B3935a11710c73F395e2c9921295)| |OptimismPortal|Entry point for message passing|[0x64057ad1DdAc804d0D26A7275b193D9DACa19993](https://etherscan.io/address/0x64057ad1DdAc804d0D26A7275b193D9DACa19993)|[0x1529a34331D7d85C8868Fc88EC730aE56d3Ec9c0](https://sepolia.etherscan.io/address/0x1529a34331D7d85C8868Fc88EC730aE56d3Ec9c0)| |DisputeGameFactory|Deploys dispute game instances to resolve state disputes|[0x9D4c8FAEadDdDeeE1Ed0c92dAbAD815c2484f675](https://etherscan.io/address/0x9D4c8FAEadDdDeeE1Ed0c92dAbAD815c2484f675)|[0x80388586ab4580936BCb409Cc2dC6BC0221e1B6F](https://sepolia.etherscan.io/address/0x80388586ab4580936BCb409Cc2dC6BC0221e1B6F)| |FaultDisputeGame|Resolves disputes about L2 state through interactive fault proofs|Not deployed (0x0000...)|Not deployed (0x0000...)| |PermissionedDisputeGame|Dispute game with permission restrictions for authorized challengers|[0xEeDa796a23bc98726e47934ca9B54fDDa5a608e8](https://etherscan.io/address/0xEeDa796a23bc98726e47934ca9B54fDDa5a608e8)|[0x6d5610D86Dba85226146715B5c2b2addDAdE18c0](https://sepolia.etherscan.io/address/0x6d5610D86Dba85226146715B5c2b2addDAdE18c0)| |AnchorStateRegistry|Stores the latest anchored state for each dispute game type|[0x000590BB65ab1864a7AD46d6B957cC9a4F2C149d](https://etherscan.io/address/0x000590BB65ab1864a7AD46d6B957cC9a4F2C149d)|[0x1A8DFc1d6ccfB3bE886b2539823539a9DC0956a5](https://sepolia.etherscan.io/address/0x1A8DFc1d6ccfB3bE886b2539823539a9DC0956a5)| |DelayedWETH|Manages participant bonds during dispute periods with withdrawal delays|[0x1B8A252A71bC8997d3871aF420895B5845212fC6](https://etherscan.io/address/0x1B8A252A71bC8997d3871aF420895B5845212fC6)|[0xc8e876aD7E2e47017107D335132Bf7e3Efdd6B7b](https://sepolia.etherscan.io/address/0xc8e876aD7E2e47017107D335132Bf7e3Efdd6B7b)| |MIPS|MIPS32 virtual machine for executing fault proofs|[0x305D1C0EED9a0291686f3BfDf1F5E54aaeeF80e4](https://etherscan.io/address/0x305D1C0EED9a0291686f3BfDf1F5E54aaeeF80e4)|[0x4B55e1782E96762a457896Dff2B17Cd2477ab57c](https://sepolia.etherscan.io/address/0x4B55e1782E96762a457896Dff2B17Cd2477ab57c)| |PreimageOracle|Maps hashes to their corresponding preimages for fault proof verification|[0x1fb8cdFc6831fc866Ed9C51aF8817Da5c287aDD3](https://etherscan.io/address/0x1fb8cdFc6831fc866Ed9C51aF8817Da5c287aDD3)|[0xD59BB1D50DfeaDc2cC3a7BED43c3bc4065B0ed4B](https://sepolia.etherscan.io/address/0xD59BB1D50DfeaDc2cC3a7BED43c3bc4065B0ed4B)| |SuperchainConfig|Manages superchain global configuration values|[0x6a95D7aaC3d41761426761Af031C5034B7b347d4](https://etherscan.io/address/0x6a95D7aaC3d41761426761Af031C5034B7b347d4)|[0x307F426f725Dc6B2C49D489E1133aA5f5F400960](https://sepolia.etherscan.io/address/0x307F426f725Dc6B2C49D489E1133aA5f5F400960)| |ProtocolVersions|Manages superchain protocol version information|[0xC1Fb115d8249a7e6b27c8Bc6914Cab7eDF0b0F7E](https://etherscan.io/address/0xC1Fb115d8249a7e6b27c8Bc6914Cab7eDF0b0F7E)|[0x4e753a62Ad7Da17508DBC54A58E1e231C152baA2](https://sepolia.etherscan.io/address/0x4e753a62Ad7Da17508DBC54A58E1e231C152baA2)| |AddressManager|Legacy contract for managing string name to address registry, required by L1CrossDomainMessenger|[0xE88CfA9D4a4fae1413914baD9796A72D13d035b9](https://etherscan.io/address/0xE88CfA9D4a4fae1413914baD9796A72D13d035b9)|[0x6A09ED5B36dD48904551498f0020cD62cc315907](https://sepolia.etherscan.io/address/0x6A09ED5B36dD48904551498f0020cD62cc315907)| ### X Layer Layer 2 (Predeploys) |Name|Detail|L2 Address| |:----|:--|:--| |L2CrossDomainMessenger|L2 side cross-domain message passing interface|0x4200000000000000000000000000000000000007| |L2ToL1MessagePasser|Stores messages sent from L2 to L1 (with customGasToken support)|0x4200000000000000000000000000000000000016| |L1Block|Provides access to latest known L1 block information|0x4200000000000000000000000000000000000015| |GasPriceOracle|Provides L1 fee calculation and offline gas estimation|0x420000000000000000000000000000000000000F| |BeaconBlockRoot|Provides access to L1 beacon block roots (EIP-4788)|0x000F3df6D732807Ef1319fB7B8bB8522d0Beac02| |SequencerFeeVault|Collects sequencer fees|0x4200000000000000000000000000000000000011| |BaseFeeVault|Collects L2 base fees|0x4200000000000000000000000000000000000019| |L1FeeVault|Collects L1 fee portion|0x420000000000000000000000000000000000001a| |SchemaRegistry|Global authentication schema for Ethereum Attestation Service|0x4200000000000000000000000000000000000020| |EAS|Ethereum Attestation Service|0x4200000000000000000000000000000000000021| |ProxyAdmin|Owner of all predeploy proxy contracts|0x4200000000000000000000000000000000000018| ### Token Addresses |Name|Detail|Mainnet address|Testnet address| |:----|:--|:--|:--| |[WOKB](https://www.okx.com/web3/explorer/xlayer/token/0xe538905cf8410324e03A5A23C1c177a474D59b2b "WOKB")|WOKB Token Address|[0xe538905cf8410324e03A5A23C1c177a474D59b2b](https://www.okx.com/web3/explorer/xlayer/token/0xe538905cf8410324e03A5A23C1c177a474D59b2b "0xe538905cf8410324e03A5A23C1c177a474D59b2b")|-| |[WETH](https://www.okx.com/web3/explorer/xlayer/token/0x5A77f1443D16ee5761d310e38b62f77f726bC71c "WETH")|WETH Token Address|[0x5A77f1443D16ee5761d310e38b62f77f726bC71c](https://www.okx.com/web3/explorer/xlayer/token/0x5A77f1443D16ee5761d310e38b62f77f726bC71c "0x5A77f1443D16ee5761d310e38b62f77f726bC71c")|[0xBec7859BC3d0603BeC454F7194173E36BF2Aa5C8](https://www.okx.com/web3/explorer/xlayer-test/token/0xBec7859BC3d0603BeC454F7194173E36BF2Aa5C8 "0xBec7859BC3d0603BeC454F7194173E36BF2Aa5C8")| |[USDT](https://www.okx.com/web3/explorer/xlayer/token/0x1E4a5963aBFD975d8c9021ce480b42188849D41d "USDT")|USDT Token Address|[0x1E4a5963aBFD975d8c9021ce480b42188849D41d](https://www.okx.com/web3/explorer/xlayer/token/0x1E4a5963aBFD975d8c9021ce480b42188849D41d "0x1E4a5963aBFD975d8c9021ce480b42188849D41d")|-| |[USDT0](https://www.okx.com/web3/explorer/xlayer/token/0x779Ded0c9e1022225f8E0630b35a9b54bE713736 "USDT0")|USDT0 Token Address|[0x779Ded0c9e1022225f8E0630b35a9b54bE713736](https://www.okx.com/web3/explorer/xlayer/token/0x779Ded0c9e1022225f8E0630b35a9b54bE713736 "0x779Ded0c9e1022225f8E0630b35a9b54bE713736")|-| |[USDC](https://www.okx.com/web3/explorer/xlayer/token/0x74b7F16337b8972027F6196A17a631aC6dE26d22 "USDC")|USDC Token Address|[0x74b7F16337b8972027F6196A17a631aC6dE26d22](https://www.okx.com/web3/explorer/xlayer/token/0x74b7F16337b8972027F6196A17a631aC6dE26d22 "0x74b7F16337b8972027F6196A17a631aC6dE26d22")|-| |[USDC.e](https://www.okx.com/web3/explorer/xlayer/token/0xA8CE8aee21bC2A48a5EF670afCc9274C7bbbC035 "USDC.e")|USDC.e Token Address|[0xA8CE8aee21bC2A48a5EF670afCc9274C7bbbC035](https://www.okx.com/web3/explorer/xlayer/token/0xA8CE8aee21bC2A48a5EF670afCc9274C7bbbC035 "0xA8CE8aee21bC2A48a5EF670afCc9274C7bbbC035")|-| |[WBTC](https://www.okx.com/web3/explorer/xlayer/token/0xEA034fb02eB1808C2cc3adbC15f447B93CbE08e1 "WBTC")|WBTC Token Address|[0xEA034fb02eB1808C2cc3adbC15f447B93CbE08e1](https://www.okx.com/web3/explorer/xlayer/token/0xEA034fb02eB1808C2cc3adbC15f447B93CbE08e1 "0xEA034fb02eB1808C2cc3adbC15f447B93CbE08e1")|-| |[DAI](https://www.okx.com/web3/explorer/xlayer/token/0xC5015b9d9161Dca7e18e32f6f25C4aD850731Fd4 "DAI")|DAI Token Address|[0xC5015b9d9161Dca7e18e32f6f25C4aD850731Fd4](https://www.okx.com/web3/explorer/xlayer/token/0xC5015b9d9161Dca7e18e32f6f25C4aD850731Fd4 "0xC5015b9d9161Dca7e18e32f6f25C4aD850731Fd4")|-| |[xBTC](https://www.okx.com/web3/explorer/xlayer/token/0xb7C00000bcDEeF966b20B3D884B98E64d2b06b4f "xBTC")|xBTC Token Address|[0xb7C00000bcDEeF966b20B3D884B98E64d2b06b4f](https://www.okx.com/web3/explorer/xlayer/token/0xb7C00000bcDEeF966b20B3D884B98E64d2b06b4f "0xb7C00000bcDEeF966b20B3D884B98E64d2b06b4f")|-| |[USDG](https://www.okx.com/web3/explorer/xlayer/token/0x4ae46a509F6b1D9056937BA4500cb143933D2dc8 "USDG")|USDG Token Address|[0x4ae46a509F6b1D9056937BA4500cb143933D2dc8](https://www.okx.com/web3/explorer/xlayer/token/0x4ae46a509F6b1D9056937BA4500cb143933D2dc8 "0x4ae46a509F6b1D9056937BA4500cb143933D2dc8")|-| - [Address Format](https://web3pre.okex.org/onchainos/dev-docs/xlayer/developer/build-on-xlayer/address-format.md) # Address Format X Layer is an EVM-compatible blockchain network that supports two address formats: Standard EVM Address Format and XKO Prefix Address Format. ## Supported Address Formats ### Standard EVM Address Format - **Format**: `0x` + 40 hexadecimal characters - **Example**: `0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625` - **Features**: - Complies with EIP-55 checksum standard (mixed case) - Fully compatible with all Ethereum tools and wallets ### XKO Prefix Address Format - **Format**: `XKO` + 40 hexadecimal characters - **Example**: `XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625` - **Features**: - X Layer proprietary address format - Case-insensitive prefix (XKO, xko, Xko all valid) - Preserves EIP-55 checksum casing - Easy identification of X Layer ecosystem addresses ### Address Equivalence The same account can be represented in both formats, pointing to the same on-chain account: ``` Standard EVM: 0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 XKO address: XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 xko70586beeb7b7aa2e7966df9c8493c6cbfd75c625 ✓ Valid Xko70586beeb7b7aa2e7966df9c8493c6cbfd75c625 ✓ Valid ``` **Invalid format examples**: ``` XKO0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 ✗ Cannot have both XKO and 0x ``` --- ## XKO Prefix Address Design XKO address is essentially an alternative representation of a standard EVM address: 1. **Address Core**: 40 hexadecimal characters (same as EVM address) 2. **Prefix Replacement**: `XKO` replaces `0x` prefix 3. **Checksum Preservation**: Maintains Keccak-256 hash-based case checksum 4. **On-Chain Storage**: Stored as standard 20-byte address on-chain --- ## SDK Integration Guide X Layer provides multi-language SDKs for address format conversion, supporting: - JavaScript - TypeScript - Python - Go - Rust - Java ### Core APIs All SDKs provide two core functions: | Function | Purpose | Input | Output | |----------|---------|-------|--------| | `toEvmAddress` | Convert to standard EVM address | `0x...` / `XKO...` / bare address | `0x` + 40 chars (EIP-55 checksum) | | `fromEvmAddress` | Convert to XKO address | `0x...` / bare address | `XKO` + 40 chars (preserves checksum) | Some SDKs also provide utility functions: | Function | Purpose | Available In | |----------|---------|--------------| | `isXlayerAddress` | Check if address is XKO format | Java | --- ### JavaScript SDK **Installation**: ```bash npm install js-sha3 ``` **Usage Example**: ```javascript const { toEvmAddress, fromEvmAddress } = require('./multiAddress.js'); // XKO to standard EVM address const evmAddr = toEvmAddress('XKO70586beeb7b7aa2e7966df9c8493c6cbfd75c625'); console.log(evmAddr); // Output: 0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 // Standard EVM to XKO address const xkoAddr = fromEvmAddress('0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625'); console.log(xkoAddr); // Output: XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 // Supports multiple input formats toEvmAddress('0x70586beeb7b7aa2e7966df9c8493c6cbfd75c625'); // ✓ toEvmAddress('70586beeb7b7aa2e7966df9c8493c6cbfd75c625'); // ✓ toEvmAddress('XKO70586beeb7b7aa2e7966df9c8493c6cbfd75c625'); // ✓ ``` **Error Handling**: ```javascript try { toEvmAddress('invalid'); } catch (error) { console.error(error.message); // Output: Invalid address length: expected 40 hex chars, got 7 } ``` --- ### TypeScript SDK **Installation**: ```bash npm install js-sha3 ``` **Usage Example**: ```typescript import { toEvmAddress, fromEvmAddress } from './multiAddress'; // Type-safe address conversion const evmAddr: string = toEvmAddress('XKO70586beeb7b7aa2e7966df9c8493c6cbfd75c625'); const xkoAddr: string = fromEvmAddress('0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625'); // Type checking toEvmAddress(123); // TypeScript compile error ``` --- ### Python SDK **Installation**: ```bash pip install eth-utils ``` **Usage Example**: ```python from multi_address import to_evm_address, from_evm_address # XKO to EVM evm_addr = to_evm_address('XKO70586beeb7b7aa2e7966df9c8493c6cbfd75c625') print(evm_addr) # Output: 0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 # EVM to XKO xko_addr = from_evm_address('0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625') print(xko_addr) # Output: XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 # Error handling try: to_evm_address('invalid') except ValueError as e: print(e) # Output: Invalid address length: expected 40 hex chars, got 7 ``` --- ### Go SDK **Installation**: ```bash go get golang.org/x/crypto/sha3 ``` **Usage Example**: ```go package main import ( "fmt" "log" address "your-module/multi_address" ) func main() { // XKO to EVM evmAddr, err := address.ToEvmAddress("XKO70586beeb7b7aa2e7966df9c8493c6cbfd75c625") if err != nil { log.Fatal(err) } fmt.Println(evmAddr) // Output: 0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 // EVM to XKO xkoAddr, err := address.FromEvmAddress("0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625") if err != nil { log.Fatal(err) } fmt.Println(xkoAddr) // Output: XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 } ``` --- ### Rust SDK **Add Dependency** (Cargo.toml): ```toml [dependencies] multi_address = { path = "path/to/address/rust" } ``` **Usage Example**: ```rust use multi_address::{to_evm_address, from_evm_address}; fn main() { // XKO to EVM match to_evm_address("XKO70586beeb7b7aa2e7966df9c8493c6cbfd75c625") { Ok(evm_addr) => println!("{}", evm_addr), // Output: 0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 Err(e) => eprintln!("Error: {}", e), } // EVM to XKO match from_evm_address("0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625") { Ok(xko_addr) => println!("{}", xko_addr), // Output: XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 Err(e) => eprintln!("Error: {}", e), } } ``` --- ### Java SDK **Maven Dependency**: ```xml com.okcoin xlayer-sdk 0.2.1 ``` **Usage Example**: ```java import com.okcoin.MultiAddress; public class Example { public static void main(String[] args) { // XKO to EVM String evmAddr = MultiAddress.toEvmAddress("XKO70586beeb7b7aa2e7966df9c8493c6cbfd75c625"); System.out.println(evmAddr); // Output: 0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 // EVM to XKO String xkoAddr = MultiAddress.fromEvmAddress("0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625"); System.out.println(xkoAddr); // Output: XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625 // Check if XKO address boolean isXko = MultiAddress.isXlayerAddress("XKO70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625"); System.out.println(isXko); // true boolean isNotXko = MultiAddress.isXlayerAddress("0x70586BeEB7b7Aa2e7966DF9c8493C6CbFd75C625"); System.out.println(isNotXko); // false // Error handling try { MultiAddress.toEvmAddress("invalid"); } catch (IllegalArgumentException e) { System.err.println(e.getMessage()); // Output: Invalid address length: expected 40 hex chars, got 7 } } } ``` --- ## Security Considerations **Important**: XKO addresses are only for off-chain interactions (UI display, etc.) In transaction RLP encoding: - ❌ **Cannot** use XKO format addresses - ✅ **Must** use standard 20-byte address format - The chain automatically rejects transactions containing XKO format addresses SDKs handle this conversion automatically, but if manually constructing transactions, use the standard format. --- ## Frequently Asked Questions (FAQ) ### Q1: What's the difference between XKO and EVM addresses? A: They are completely equivalent on-chain, differing only in prefix. XKO addresses use `XKO` prefix, while EVM addresses use `0x` prefix. ### Q2: Can I use XKO addresses directly in transactions? A: No. When constructing RLP-encoded transactions, you must use the standard 20-byte address. XKO format is only for off-chain interactions (RPC queries, UI display). ### Q3: Is case sensitivity important? A: The XKO prefix is case-insensitive (XKO, xko, Xko all valid). However, the address body preserves EIP-55 checksum casing for error detection. ### Q4: How do I validate address format? A: Use the SDK conversion functions. They will throw exceptions if the address format is invalid. --- ## Resources - **GitHub Repository**: [xlayer-sdk](https://github.com/okx/xlayer-sdk) ## License This SDK is released under the MIT License. ## Support For issues and questions: - GitHub Issues: [Create an issue](https://github.com/okx/xlayer-sdk/issues) - [UnTitled Doc](https://web3pre.okex.org/onchainos/dev-docs/xlayer/developer/deploy-a-smart-contract/deploying-contract.md) - [Deploying with Hardhat](https://web3pre.okex.org/onchainos/dev-docs/xlayer/developer/deploy-a-smart-contract/deploy-with-hardhat.md) # Deploying with Hardhat In this tutorial, we explain step-by-step how to create, compile and deploy a simple smart contract on the X Layer testnet using Hardhat. ## What is Hardhat Hardhat is a development environment to compile, deploy, test, and debug your smart contract. ## Setting up the development environment Prerequisites: - [Node.js v18+ LTS and npm](https://nodejs.org/en "Node.js v18+ LTS and npm") (comes with Node) - [Git](https://git-scm.com/ "Git") To install Hardhat, you need to create an npm project by going to an empty folder, running `npm init`, and following its instructions. You can use another package manager, like yarn, but we recommend you use npm 7 or later, as it makes installing Hardhat plugins simpler. Once your project is ready, you should run `npm install --save-dev hardhat` , install Hardhat toolbox `npm install @nomicfoundation/hardhat-toolbox` . In order to use your local installation of Hardhat, you need to use `npx` to run it (i.e., `npx hardhat`). ## Creating your contract To create the sample project, run `npx hardhat` in your project folder: ```shell $ npx hardhat 888 888 888 888 888 888 888 888 888 888 888 888 888 888 888 8888888888 8888b. 888d888 .d88888 88888b. 8888b. 888888 888 888 "88b 888P" d88" 888 888 "88b "88b 888 888 888 .d888888 888 888 888 888 888 .d888888 888 888 888 888 888 888 Y88b 888 888 888 888 888 Y88b. 888 888 "Y888888 888 "Y88888 888 888 "Y888888 "Y888 👷 Welcome to Hardhat v2.9.9 👷 ? What do you want to do? … ❯ Create a JavaScript project Create a TypeScript project Create an empty hardhat.config.js Quit ``` ## Compiling your contract Next, if you take a look at the `contracts/` folder, you will see `Lock.sol`: ```shell // SPDX-License-Identifier: UNLICENSED pragma solidity ^0.8.9; // Uncomment this line to use console.log // import "hardhat/console.sol"; contract Lock { uint public unlockTime; address payable public owner; event Withdrawal(uint amount, uint when); constructor(uint _unlockTime) payable { require( block.timestamp < _unlockTime, "Unlock time should be in the future" ); unlockTime = _unlockTime; owner = payable(msg.sender); } function withdraw() public { // Uncomment this line, and the import of "hardhat/console.sol", to print a log in your terminal // console.log("Unlock time is %o and block timestamp is %o", unlockTime, block.timestamp); require(block.timestamp >= unlockTime, "You can't withdraw yet"); require(msg.sender == owner, "You aren't the owner"); emit Withdrawal(address(this).balance, block.timestamp); owner.transfer(address(this).balance); } } ``` To compile it, simply run `npx hardhat compile` ## Setting configuration file In order to connect to the X Layer network, we need to configure the corresponding network. To set up your config, you have to export an object from `hardhat.config.js`: ```javascript module.exports = { defaultNetwork: "hardhat", networks: { hardhat: { }, xlayer: { url: "https://testrpc.xlayer.tech/terigon", accounts: [privateKey1, privateKey2, ...] } } } ``` ## Deploying your contract Next, to deploy the contract, we will use a Hardhat script. Inside the `scripts/` folder you will find a file with the following code: ```javascript // We require the Hardhat Runtime Environment explicitly here. This is optional // but useful for running the script in a standalone fashion through `node