NAV
中文

Introduction

The OKLink Explorer APIs are a set of highly scalable APIs that enable Web3 developers to access the most comprehensive blockchain data across all leading L1/L2 networks. OKLink Explorer indexes block-by-block data for 40+ mainstream L1/L2 public blockchain networks, and tracks transactions and market data for 200+ blockchain networks, encompassing 7 million+ tokens and NFTs. Serving as an infrastructure layer, the OKLink Explorer APIs play a pivotal role in significantly reducing development time, infrastructure costs, and time to market.

The OKLink Explorer APIs are a collection of RESTful APIs that meet OpenAPI specifications, and they incorporate webhooks services for real-time data updates. Our APIs can help you build whatever you are creating, providing data on blocks, transactions, tokens, NFTs, markets, and more across all the leading L1/L2 blockchain networks.

The following functional data modules are what we currently support:

In addition, we provide APIs to query the interfaces supported by the public chain, the public chains supported by the interface, subscription information, and call statistics, which can enhance your experience and management of the OKLink Explorer APIs.

Quickstart Guide

Getting Started

Quickstart guide to OKLink Explorer API. Learn how to create an account, create API keys, authenticate, and get ready to make your first API request to start building!

  1. Visit the OKLink official website and register using your email or phone number.
    sign up

  2. After successful registration, log in using your email or phone number.
    log in

  3. Go to the API management page and create your API keys.
    key

  4. With your API keys, start your on-chain data exploration journey using the OKLink Explorer APIs!

Authentication and Invocation Example

An API key is the unique identifier used for accessing API endpoints. All OpenAPI endpoints require API key authentication for access.
You can create up to 5 API keys based on your needs. For your data security, please don't share the keys with anyone.

Root URL for API:

How to use API Key:

Example of API interface invocation:

cURL

curl -X GET 'https://www.oklink.com/api/v5/explorer/blockchain/summary' \
  --header 'Ok-Access-Key:Your APIkey' \
  --header 'Content-type: application/json'

Python

import requests

url = "https://www.oklink.com/api/v5/explorer/blockchain/summary?chainShortName=ETH"

payload = ""
headers = {
  # apiKey
  'Ok-Access-Key': 'apiKey'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

JavaScript - jQuery

var settings = {
  "url": "https://www.oklink.com/api/v5/explorer/blockchain/summary?chainShortName=ETH",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Accept": "*/*",
    "Ok-Access-Key": "apiKey",
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://www.oklink.com/api/v5/explorer/blockchain/summary?chainShortName=ETH"
  method := "GET"
  apiKey := "apiKey"


  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Ok-Access-Key", apiKey)

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Java - OkHttp

package com.oklink.demo;

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import java.io.IOException;

public class JavaDemo {
    public static void main(String[] args) {
        try {
            String url = "https://www.oklink.com/api/v5/explorer/blockchain/summary?chainShortName=ETH";
            String apiKey = "apiKey";
            OkHttpClient client = new OkHttpClient.Builder().build();
            Request request = new Request.Builder()
                    .url(url)
                    .addHeader("Ok-Access-Key", apiKey)
                    .build();
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        }catch (IOException e){
            e.printStackTrace();
        }
    }
}

PHP

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://www.oklink.com/api/v5/explorer/blockchain/summary?chainShortName=ETH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');


$headers = array();
$headers[] = 'Ok-Access-Key: apiKey';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Rust

extern crate reqwest;
use reqwest::header;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut headers = header::HeaderMap::new();
    headers.insert("Ok-Access-Key", "apiKey".parse().unwrap());

    let res = reqwest::Client::new()
        .get("https://www.oklink.com/api/v5/explorer/blockchain/summary?chainShortName=ETH")
        .headers(headers)
        .send()?
        .text()?;
    println!("{}", res);

    Ok(())
}

Supported Chains

The OKLink Explorer APIs currently support a total of 41 mainstream L1/L2 chains with block-by-block data:

Chain Full Name Chain Short Name Chain ID
Bitcoin BTC 0
Bitcoin Cash BCH 145
Litecoin LTC 2
DASH DASH 5
Dogecoin DOGE 3
Ethereum ETH 1
OKT Chain OKTC 66
BNB Chain BSC 56
Ethereum Classic ETC 61
Polygon POLYGON 137
Avalanche-C AVAXC 43114
EthereumPoW ETHW 10001
Dis Chain (EthereumFair) DIS (ETHF) 513100
Fantom FTM 250
OP Mainnet OP 10
Arbitrum One ARBITRUM 42161
KLAYTN KLAYTN 8217
zkSync Era ZKSYNC 324
Gnosis GNOSIS 100
Ronin RONIN 2020
LINEA LINEA 59144
Beacon BEACON 70000040
StarkNet STARKNET 9004
Polygon zkEVM POLYGON_ZKEVM 1101
Base BASE 8453
Scroll SCROLL 534352
Omega OMEGA 408
Manta Pacific MANTA 169
opBNB Mainnet OPBNB 204
X1 Test X1_TEST 19500
Sepolia Testnet SEPOLIA_TESTNET 11155111
Goerli Testnet GOERLI_TESTNET 70000030
Mumbai Testnet MUMBAI_TESTNET 80001
Amoy Testnet AMOY_TESTNET 80002
Polygon zkEVM Testnet POLYGON_ZKEVM_TESTNET 1442
Aptos APT 637
Sui SUI 784
TRON TRON 195
Cosmos Hub COSMOS 118
Kava KAVA 459
Evmos EVMOS 710

For token price data, we support 200+ public chains.

As part of ongoing enhancements, the OKLink Explorer APIs will be expanded to include support for additional public blockchains. If the blockchain you wish to integrate isn't currently listed, please reach out to us via email at [email protected]. We'll assess your request and proceed accordingly.

Rate Limit

We've put rate limits on API calls to prevent API overload, ensuring optimal processing speed, response time, and enhancing the overall security of both OKLink Explorer APIs and the retrieved data. Different access limits apply to free and paid users:

To learn more about paid subscription plans, log in to your account and go to the API management page > My subscription > Check out more API plans. Here, you can learn the specific details of the available plans.

Support

FAQ

1. How many public chains are supported by the OKLink Explorer APIs?
The OKLink Explorer APIs currently support a total of 41 mainstream L1 and L2 chains with block-by-block data. You can check the list here.
For token price data, the OKLink Explorer APIs currently support over 200 public chains, you can get the list of public chains supported in this module by Supported chains.
We are expanding our support to include more public blockchains. If the blockchain you wish to integrate isn't currently listed, please reach out to us via email at [email protected]. We'll assess your request and proceed accordingly.

2. Do the OKLink Explorer APIs have an SDK?
We provide invocation examples in different programming languages, including cURL, Python, JavaScript —jQuery, Go, Java — OkHttp, PHP, and Rust to help you get started quickly. You can find more details here.

3. What is the OKLink Explorer APIs pricing scheme?
For pricing details, please log in and go to the API management page > My subscription > Check out more API plans. (You can check out specific plans in the pop-up window.)

4. How can I check which public chains are supported by different APIs?
You can find the supported public chains for each API endpoint in the API descriptions or by Query chain supported APIs and Query API supported chains.

5. How can I view my API usage?
You can check your total calls, remaining calls, and expiration date on the API management page > My subscription.
Additionally, you can check the above data through the Subscription info. This link can also be used to set up your expiration monitoring reminder.
Furthermore, in this module, you can use the Call history and Top 10 calls to check your historical call consumption and the most consumed interfaces, which enables you to personalize API interface management.

Errors and API status

The server responds to a user's request by issuing HTTP codes and error codes when the request is made to the server. Please refer to the table below to further understand the error codes when indicating the success or failure of an API call.

Response Example

{
    "code": "50038",
    "msg": "This chain does not currently support.",
    "data": []
}

Here are the error codes and messages we used:

General Class

Error Message HTTP Status Code Error Code
Succeeded. 200 0
Body can not be empty. 400 50000
Service temporarily unavailable, please try again later. 503 50001
Json data format error. 400 50002
Endpoint request timeout (does not mean that the request was successful or failed,
please check the request result).
400 50004
API is offline or unavailable. 410 50005
Invalid Content_Type, please use "application/json" format. 400 50006
Account blocked. 200 50007
User does not exist. 200 50008
Account is suspended due to ongoing liquidation. 200 50009
User ID can not be empty. 200 50010
Requests too frequent. 429 50011
Account status invalid. 200 50012
System is busy, please try again later. 200 50013
Parameter {0} can not be empty. 400 50014
Either parameter {0} or {1} is required. 400 50015
Parameter {0} does not match parameter {1}. 400 50016
Parameter {0} and {1} can not exist at the same time. 200 50024
Parameter {0} count exceeds the limit {1}. 200 50025
System error. 500 50026
No permission to use this API. You need to upgrade your account's payment level. 403 50030
Parameter %s error. 400 50036
Token does not exist. 200 50037
This chain does not currently support. 200 50038
This alert has no history of processing. 200 50039
No data is displayed for this block height. 200 50040
The historical balance of this token is not currently supported. 200 50041
This token protocol type does not support scanning. 200 50042
Your account behavior triggered risk control, and the API function has been frozen.
Please contact us by email [email protected]
200 50043
Data already exists. 400 50044
Client operation error. 400 50045

API Class

Error Message HTTP Status Code Error Code
API frozen, please contact customer service. 400 50100
Timestamp request expired. 401 50102
Request header "OK_ACCESS_KEY" can not be empty. 401 50103
Request header "OK_ACCESS_PASSPHRASE" can not be empty. 401 50104
Request header "OK_ACCESS_PASSPHRASE" incorrect. 401 50105
Request header "OK_ACCESS_SIGN" can not be empty. 401 50106
Request header "OK_ACCESS_TIMESTAMP" can not be empty. 401 50107
Exchange ID does not exist. 401 50108
Exchange domain does not exist. 401 50109
Invalid IP. 401 50110
Invalid OK_ACCESS_KEY. 401 50111
Invalid OK_ACCESS_TIMESTAMP. 401 50112
Invalid signature. 401 50113
Invalid authorization. 401 50114
Invalid request method. 405 50115
Exceeds the range of historical data queries. 400 50117

Trade Class

Error Message HTTP Status code Error Code
Parameter {0} error. 404 51000
The outputAddress you filled in was not found in this transaction. 200 51001
The outputAddress specified by this index does not exist in this transaction. 200 51002
Detail information with this transaction hash has not been found on the blockchain network, and risk status is pending for this transaction. 200 51003

Contact Us

If you have any questions regarding the OKLink Explorer APIs, please contact us via:

Blockchain General API

The Blockchain General API module interface retrieve fundamental data such as blockchain information, block data, address data, pool data, transaction data, token data, and more for various public blockchains.

Chain Info

These endpoints from this module retrieve data for supported networks, including network details, optimal gas fees, number of addresses, and transaction counts.

Query the list of chains

This endpoint retrieves the list of crypto networks supported by Network module.

HTTP Request

GET /api/v5/explorer/blockchain/summary

Consumption per query 0

Request Example

GET /api/v5/explorer/blockchain/summary

Request Parameters

Parameter Type Required Description
chainShortName String No The blockchain network symbol, e.g. BTC. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "symbol": "BTC",
            "lastHeight": "812740",
            "lastBlockTime": "1697622753000",
            "circulatingSupply": "19517050",
            "circulatingSupplyProportion": "0.9294",
            "transactions": "913669129"
        },
        {
            "chainFullName": "Bitcoin Cash",
            "chainShortName": "BCH",
            "symbol": "BCH",
            "lastHeight": "815586",
            "lastBlockTime": "1697622060000",
            "circulatingSupply": "19534862.5",
            "circulatingSupplyProportion": "0.9302",
            "transactions": "376125240"
        },
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "lastHeight": "18376498",
            "lastBlockTime": "1697623103000",
            "circulatingSupply": "120262264.05",
            "circulatingSupplyProportion": "1",
            "transactions": "2127824775"
        },
        {
            "chainFullName": "OKT Chain",
            "chainShortName": "OKTC",
            "symbol": "OKT",
            "lastHeight": "22989718",
            "lastBlockTime": "1697623102000",
            "circulatingSupply": "20077976.25",
            "circulatingSupplyProportion": "0.9560941071428571",
            "transactions": "167592112"
        },
        {
            "chainFullName": "X1_TEST",
            "chainShortName": "X1_TEST",
            "symbol": "OKB",
            "lastHeight": "26938",
            "lastBlockTime": "1700031881000",
            "circulatingSupply": "",
            "circulatingSupplyProportion": "",
            "transactions": "26801.0"
        },
        {
            "chainFullName": "BNB Chain",
            "chainShortName": "BSC",
            "symbol": "BNB",
            "lastHeight": "32707931",
            "lastBlockTime": "1697623106000",
            "circulatingSupply": "151705624.6",
            "circulatingSupplyProportion": "1",
            "transactions": "3584346166"
        },
        {
            "chainFullName": "Ethereum Classic",
            "chainShortName": "ETC",
            "symbol": "ETC",
            "lastHeight": "18541162",
            "lastBlockTime": "1697623087000",
            "circulatingSupply": "143564715.29",
            "circulatingSupplyProportion": "1",
            "transactions": "115483536"
        },
        {
            "chainFullName": "Litecoin",
            "chainShortName": "LTC",
            "symbol": "LTC",
            "lastHeight": "2564279",
            "lastBlockTime": "1697622845000",
            "circulatingSupply": "73774507.97",
            "circulatingSupplyProportion": "0.8783",
            "transactions": "181126166"
        },
        {
            "chainFullName": "DASH",
            "chainShortName": "DASH",
            "symbol": "DASH",
            "lastHeight": "1956330",
            "lastBlockTime": "1697623059000",
            "circulatingSupply": "11499070.93",
            "circulatingSupplyProportion": "0.6087",
            "transactions": "49535771"
        },
        {
            "chainFullName": "TRON",
            "chainShortName": "TRON",
            "symbol": "TRX",
            "lastHeight": "55663883",
            "lastBlockTime": "1697623107000",
            "circulatingSupply": "90580932915.58",
            "circulatingSupplyProportion": "1",
            "transactions": "6.56881736E+9"
        },
        {
            "chainFullName": "Polygon",
            "chainShortName": "POLYGON",
            "symbol": "MATIC",
            "lastHeight": "48859754",
            "lastBlockTime": "1697623104000",
            "circulatingSupply": "9299803030.72",
            "circulatingSupplyProportion": "",
            "transactions": "3071306297"
        },
        {
            "chainFullName": "Avalanche-C",
            "chainShortName": "AVAXC",
            "symbol": "AVAX",
            "lastHeight": "36601091",
            "lastBlockTime": "1697623102000",
            "circulatingSupply": "354811879.38",
            "circulatingSupplyProportion": "",
            "transactions": "257890662"
        },
        {
            "chainFullName": "Aptos",
            "chainShortName": "APT",
            "symbol": "APT",
            "lastHeight": "104439850",
            "lastBlockTime": "1697623100438",
            "circulatingSupply": "245335823.53",
            "circulatingSupplyProportion": "0",
            "transactions": "289582063"
        },
        {
            "chainFullName": "EthereumPoW",
            "chainShortName": "ETHW",
            "symbol": "ETHW",
            "lastHeight": "18110977",
            "lastBlockTime": "1697623090000",
            "circulatingSupply": "107818999.05",
            "circulatingSupplyProportion": "1",
            "transactions": "1688548041"
        },
        {
            "chainFullName": "DIS CHAIN",
            "chainShortName": "DIS",
            "symbol": "DIS",
            "lastHeight": "18144023",
            "lastBlockTime": "1697623083000",
            "circulatingSupply": "",
            "circulatingSupplyProportion": "",
            "transactions": "1660726868"
        },
        {
            "chainFullName": "Fantom",
            "chainShortName": "FTM",
            "symbol": "FTM",
            "lastHeight": "69463847",
            "lastBlockTime": "1697623104000",
            "circulatingSupply": "2803634835.53",
            "circulatingSupplyProportion": "0.883035",
            "transactions": "446638938"
        },
        {
            "chainFullName": "OP Mainnet",
            "chainShortName": "OP",
            "symbol": "ETH",
            "lastHeight": "111012162",
            "lastBlockTime": "1697623101000",
            "circulatingSupply": "120262264.05",
            "circulatingSupplyProportion": "1",
            "transactions": "168183124"
        },
        {
            "chainFullName": "Arbitrum One",
            "chainShortName": "ARBITRUM",
            "symbol": "ETH",
            "lastHeight": "141661625",
            "lastBlockTime": "1697623108000",
            "circulatingSupply": "120262264.05",
            "circulatingSupplyProportion": "1",
            "transactions": "373814666"
        },
        {
            "chainFullName": "Dogecoin",
            "chainShortName": "DOGE",
            "symbol": "DOGE",
            "lastHeight": "4928818",
            "lastBlockTime": "1697622845000",
            "circulatingSupply": "141459666383.71",
            "circulatingSupplyProportion": "",
            "transactions": ""
        },
        {
            "chainFullName": "Sui",
            "chainShortName": "SUI",
            "symbol": "SUI",
            "lastHeight": "15891997",
            "lastBlockTime": "1697623099245",
            "circulatingSupply": "860392959.69",
            "circulatingSupplyProportion": "0.08603929596900001",
            "transactions": "821855364"
        },
        {
            "chainFullName": "KLAYTN",
            "chainShortName": "KLAYTN",
            "symbol": "KLAY",
            "lastHeight": "135657958",
            "lastBlockTime": "1697623108000",
            "circulatingSupply": "3234951226.08",
            "circulatingSupplyProportion": "",
            "transactions": ""
        },
        {
            "chainFullName": "zkSync Era",
            "chainShortName": "ZKSYNC",
            "symbol": "ETH",
            "lastHeight": "16684962",
            "lastBlockTime": "1697623105000",
            "circulatingSupply": "120262264.05",
            "circulatingSupplyProportion": "1",
            "transactions": "140220679"
        },
        {
            "chainFullName": "Gnosis",
            "chainShortName": "GNOSIS",
            "symbol": "ETH",
            "lastHeight": "30516833",
            "lastBlockTime": "1697623100000",
            "circulatingSupply": "",
            "circulatingSupplyProportion": "",
            "transactions": ""
        },
        {
            "chainFullName": "Ronin",
            "chainShortName": "RONIN",
            "symbol": "RONIN",
            "lastHeight": "28598542",
            "lastBlockTime": "1697623106000",
            "circulatingSupply": "251442247.22",
            "circulatingSupplyProportion": "",
            "transactions": ""
        },
        {
            "chainFullName": "LINEA",
            "chainShortName": "LINEA",
            "symbol": "LINEA",
            "lastHeight": "659835",
            "lastBlockTime": "1697623102000",
            "circulatingSupply": "",
            "circulatingSupplyProportion": "",
            "transactions": "2127828200"
        },
        {
            "chainFullName": "POLYGON_ZKEVM",
            "chainShortName": "POLYGON_ZKEVM",
            "symbol": "ETH",
            "lastHeight": "6371025",
            "lastBlockTime": "1697623096000",
            "circulatingSupply": "",
            "circulatingSupplyProportion": "",
            "transactions": "5236188.0"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
symbol String The native token symbol, e.g. btc.
lastHeight String The latest block height
lastBlockTime String Last block time; Unix timestamp format in milliseconds, e.g. 1597026383085
circulatingSupply String Circulating supply
circulatingSupplyProportion String The ratio of the circulating quantity to the total supply, displayed in decimals, e.g.: 0.85 equals 85%
transactions String Total number of transactions

Query public chain details

Get the details of the public chains currently supported by OKLink, the supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/blockchain/info

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/info?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "symbol": "BTC",
            "rank": "1",
            "mineable": true,
            "algorithm": "SHA-256",
            "consensus": "PoW",
            "diffEstimation": "65.70T",
            "currentDiff": "61.03T",
            "diffAdjustTime": "1698582329000",
            "circulatingSupply": "19517050",
            "totalSupply": "21000000",
            "tps": "3.16",
            "lastHeight": "812742",
            "lastBlockTime": "1697623175000",
            "issueDate": "1231006505000"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain Short name, e.g. BTC
symbol String Chain native tokens, e.g. btc
rank String Rank
mineable Bol Whether to support mining
true
false
algorithm String The core algorithm, e.g. SHA-256
consensus String Consensus algorithm, e.g. PoW
diffEstimation String Prediction of next mining difficulty, BTC unit: T
currentDiff String The current mining difficulty of the whole network
diffAdjustTime String The next mining difficulty adjustment time
circulatingSupply String Circulating supply
totalSupply String Max total supply
tps String Transactions per second
lastHeight String The latest block height
lastBlockTime String Last block time; Unix timestamp format in milliseconds, e.g. 1597026383085
issueDate String Issue date; Unix timestamp format in milliseconds, e.g. 1597026383085

Query block basic information

Obtain the basic information of the detailed blocks of the chains, the supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/blockchain/block

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/block?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "symbol": "BTC",
            "lastHeight": "812742",
            "firstExchangeHistoricalTime": "1231006505000",
            "firstBlockTime": "1231006505000",
            "firstBlockHeight": "0",
            "avgBlockInterval": "573.2926587301587",
            "avgBlockSize24h": "1565974.456375839",
            "avgBlockSize24hPercent": "-0.10001506153712443",
            "mediaBlockSize": "1575044.942857143",
            "halveTime": "1712805881000"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain Short name, e.g. BTC
symbol String Chain native tokens, e.g. btc
lastHeight String The latest block height
firstExchangeHistoricalTime String First transaction time; Unix timestamp format in milliseconds, e.g. 1597026383085
firstBlockTime String First block time; Unix timestamp format in milliseconds, e.g. 1597026383085
firstBlockHeight String First block height
avgBlockInterval String Average block time (nearly a week), ETH unit is s
avgBlockSize24h String Average block size (24 hours)
avgBlockSize24hPercent String Average block size change
mediaBlockSize String Median block size (last week)
halveTime String halving time;Unix timestamp format in milliseconds, e.g. 1597026383085

Query address overview

Get the basic information of the currency holding addresses of the public chains, the supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA.

HTTP Request

GET /api/v5/explorer/blockchain/address

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/address?chainShortName=eth

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "validAddressCount": "107721078",
            "newAddressCount24h": "47093",
            "totalAddresses": "305937721",
            "newTotalAddresses24h": "109599",
            "contractAddresses": "64007840",
            "newContractAddresses24h": "19582",
            "externalAddresses": "241929881",
            "newExternalAddresses24h": "90017",
            "activeAddresses": "714816",
            "newActiveAddresses": "19728"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
symbol String Chain native tokens, e.g. btc
validAddressCount String The number of addresses holding the native token of the blockchain.
newAddressCount24h String Increment / decrement of the past 24-hour period comparing to the previous one of holding addresses
totalAddresses String Total number of addresses on the blockchain
newTotalAddresses24h String Increment / decrement of the past 24-hour period comparing to the previous one of total addresses
contractAddresses String Contract addresses
newContractAddresses24h String Increment / decrement of the past 24-hour period comparing to the previous one of contract addresses
externalAddresses String External addresses
newExternalAddresses24h String Increment / decrement of the past 24-hour period comparing to the previous one of external addresses
activeAddresses String Active addresses
newActiveAddresses String Increment / decrement of the past 24-hour period comparing to the previous one of active addresses

Query the best handling fee or gas fee

Get the basic information of the gas fee of the public chains, the supported chains are BTC, BCH, LTC, DASH, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, GNOSIS, LINEA, POLYGON_ZKEVM, BASE, SCROLL, OPBNB, MANTA, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/blockchain/fee

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/fee?chainShortName=eth

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "bestTransactionFee": "",
            "bestTransactionFeeSat": "",
            "recommendedGasPrice": "34.843994267",
            "rapidGasPrice": "35.043994267",
            "standardGasPrice": "34.793994267",
            "slowGasPrice": "34.743994267",
            "baseFee": "34.057663431",
            "gasUsedRatio": "0.4781578,0.420984233333333333,0.5279502,0.485460466666666667,0.434564833333333333"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain Short name, e.g. BTC
symbol String Chain native tokens, e.g. btc
bestTransactionFee String Best transaction fee
bestTransactionFeeSat String Best transaction fee (Sat)
recommendedGasPrice String Recommended gas fee. ETH unit: Gwei
rapidGasPrice String Extremely fast Gas fee, estimated transaction confirmation within 15s
standardGasPrice String General Gas fee, estimated 3 minutes to complete the transaction confirmation
slowGasPrice String Slow Gas fee, estimated greater than 15 minutes to complete transaction confirmation
baseFee String Base fee per Gas
gasUsedRatio String Gas used ratio of the latest 5 blocks(i.e., Gas consumed / Gas limit), separated by a comma

Query on-chain transaction information

Get the basic transaction information on the public chains, the supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OPBNB, MANTA.

HTTP Request

GET /api/v5/explorer/blockchain/transaction

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/transaction?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g:BTC、ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "symbol": "BTC",
            "pendingTransactionCount": "22597",
            "transactionValue24h": "34410716804875",
            "totalTransactionCount": "913670420",
            "tranRate": "3.16",
            "avgTransactionCount24h": "1936.8523489932886",
            "avgTransactionCount24hPercent": "0.0211",
            "pendingTransactionSize": "164205183"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
symbol String Chain native tokens, e.g. btc
pendingTransactionCount String Pending transaction count
transactionValue24h String Transaction value 24h
totalTransactionCount String Total transaction count
tranRate String The average TPS for 50 blocks
avgTransactionCount24h String Avg number of transactions in 24h
avgTransactionCount24hPercent String Changing percent of the avg number of transactions in 24h
pendingTransactionSize String Pending transaction size

Query the basic information of computing power

Get the basic information of the public chain computing power, the supported chains are BTC, BCH, LTC, DASH, ETH, ETC.

HTTP Request

GET /api/v5/explorer/blockchain/hashes

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/hashes?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "symbol": "BTC",
            "hashRate": "437.58EH",
            "hashRateChange24h": "-0.0074"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
symbol String Chain native tokens, e.g. btc
hashrate String The total network hash rate in the past week
hashrateChange24h String The 24-hour rise and fall of the computing power of the entire network,
For example: a positive number means an increase; 0.02, which means an increase of 2%
For example: a negative number means a decline: -0.02, which means a decline of 2%

Query basic mining information

Obtain the basic mining information of the public chains, the supported chains are BTC, BCH, LTC, DASH, ETH.

HTTP Request

GET /api/v5/explorer/blockchain/mine

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/mine?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "symbol": "BTC",
            "avgMineReward24h": "6.37771195",
            "minerIncomePerUnit": "0.000002082802405598016",
            "minerIncomePerUnitCoin": "0.000002060056106572138"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
symbol String Chain native tokens, e.g. btc
avgMineReward24h String 24-hour average block reward
minerIncomePerUnit String Revenue per unit of computing power
minerIncomePerUnitCoin String The number of coins earned per unit of computing power

Block

These endpoints from this module retrieve data for a specific block such as block details, block lists, transaction lists within blocks and historical block heights.

Query block header details

Get the block details of the public chains, the supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/block/block-fills

Consumption per query 1

Request Example

GET /api/v5/explorer/block/block-fills?chainShortName=eth&height=735732

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
height String Yes Block height
netWork String No Chain name, required for USDT

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "hash": "0x545f02750b8fffe8354140b8ec2414fd72fa34a5ca93c58fe25f94c07ebb44ff",
            "height": "735732",
            "validator": "NanoPool",
            "blockTime": "1450873643000",
            "txnCount": "4",
            "amount": "12.950329114",
            "blockSize": "1509",
            "mineReward": "5.012841864",
            "totalFee": "0.012841864",
            "feeSymbol": "ETH",
            "ommerBlock": "0",
            "merkleRootHash": "0xcfb7cc8bc5f11bb9c3e05a9fec1a17b63b0899a75624038a762ce800bda588b3",
            "gasUsed": "249382",
            "gasLimit": "3141592",
            "gasAvgPrice": "0.000000051494751025",
            "state": "",
            "burnt": "",
            "netWork": "",
            "txnInternal": "0",
            "miner": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5",
            "difficuity": "8518354788907",
            "nonce": "e246c1795e5cc38f",
            "tips": "",
            "confirm": "17640838",
            "baseFeePerGas": ""
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
hash String Block hash
height String Block height
validator String Validator
blockTime String Generate block time;Unix timestamp format in milliseconds, e.g. 1597026383085
amount String Amount of the transaction
txnCount String The number of normal transactions contained in the block
txnInternal String The number of internal transactions contained in the block
blockSize String Block size. The unit is: bytes
mineReward String Block reward, block revenue is equal to mineReward + totalFee
totalFee String The sum of all fees in the block, in the currency of the fee
feeSymbol String Fee currency
ommerBlock String The number of ommer blocks
merkleRootHash String Merkle root hash
gasUsed String Actual amount of gas used
gasLimit String Gas limit
gasAvgPrice String Gas avg price, in ETH
state String Block state
pending
done
burnt String Destruction fee amount
netWork String The name of the chain, showing the chainFullName of the corresponding public chain, e.g. TRON
miner String The miner's address Hash that packs the block
difficulty String Difficulty when packing the block
nonce String In PoW blockchains, nonce is used to describe mining difficulty
confirm String Confirmed block count
tips String The maximum gas price that the transaction initiator is willing to pay to prioritize their transaction for inclusion in a block by miners
baseFeePerGas String Basic fee per Gas, in ETH

Query block list

Get the block list information of the public chains, and only return nearly 10,000 block list data, the supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/block/block-list

Consumption per query 1

Request Example

GET /api/v5/explorer/block/block-list?chainShortName=eth&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
height String No Height
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "blockList": [
                {
                    "hash": "0x68888279454c3a5e20b7f1b814d9b09c42ba13b6ee6e773a8d78dcc0a4bbcaf0",
                    "height": "18376580",
                    "validator": "unknown",
                    "blockTime": "1697624087000",
                    "txnCount": "134",
                    "blockSize": "159565",
                    "mineReward": "0.022295016661867617",
                    "totalFee": "0.09549692314174378",
                    "feeSymbol": "ETH",
                    "avgFee": "0.0007",
                    "ommerBlock": "0",
                    "gasUsed": "11074005",
                    "gasLimit": "30000000",
                    "gasAvgPrice": "0.000000008623521765",
                    "state": "",
                    "burnt": "0.07320190647987616",
                    "netWork": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
blockList Array Block list
> hash String Block hash
> height String Block height
> validator String Validator
> blockTime String Generate block time;Unix timestamp format in milliseconds, e.g. 1597026383085
> txnCount String The number of transactions contained in the block
> blockSize String Block size. The unit is: bytes
> mineReward String Block reward, block revenue is equal to mineReward + totalFee
> totalFee String The sum of all fees in the block, in the currency of the fee
> feeSymbol String Fee currency
> avgFee String Average transaction fee
> ommerBlock String The number of ommer blocks
> gasUsed String Actual amount of gas used
> gasLimit String Gas limit
> gasAvgPrice String Gas avg price
> state String Block state
pending
done
> burnt String Destruction fee amount
> netWork String The name of the chain, showing the chainFullName of the corresponding public chain, e.g. TRON

Query block transaction list

Get the list of transactions in a block under the blockchain, the supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/block/transaction-list

Consumption per query 1

Request Example

GET /api/v5/explorer/block/transaction-list?chainShortName=eth&height=18126560&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
height String Yes Height
protocolType String No Protocol type
transaction: normal transaction
internal: internal transaction
token_20
token_721
token_1155
token_10
The default is transaction
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "635",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "blockList": [
                {
                    "txid": "0x5a597e627d67a4e9daa9b710bf217c6690a2ac09521b45ffbb0b82b0f6d84245",
                    "methodId": "0x771d503f",
                    "blockHash": "0xadaed44b8d75332a8627a490cdd49e8aab227c901859f7918aea2b7f6d54e297",
                    "height": "18126560",
                    "transactionTime": "1694598095000",
                    "from": "0x104da4efb22a7e560e6df9c813e5eb54ca038737",
                    "isFromContract": false,
                    "isToContract": true,
                    "to": "0x51c72848c68a965f66fa7a88855f9f7784502a7f",
                    "amount": "0",
                    "transactionSymbol": "ETH",
                    "txfee": "0.004454715411444375",
                    "state": "success",
                    "tokenId": "",
                    "tokenContractAddress": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
blockList Array Block transaction list
> txid String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time;Unix timestamp format in milliseconds, e.g. 1597026383085
> from String Sender address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> to String Funds arrival address
> amount String Number of transactions
> transactionSymbol String Symbol
> txfee String Transaction Fees
> state String Transaction status
success
fail
pending
> tokenContractAddress String Token Contract Address
> tokenId String NFT token Id
> methodId String method Id

Batch query block transaction list

Batch query the transaction list for certain blocks on a blockchain, and only return the latest 10,000 transaction data. The supported chains are ETH, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

HTTP Request

GET /api/v5/explorer/block/transaction-list-multi

Consumption per query 3

Request Example

GET /api/v5/explorer/block/transaction-list-multi?chainShortName=eth&startBlockHeight=18809970&endBlockHeight=18809972&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
startBlockHeight String Yes The height of the start block
endBlockHeight String Yes The height of the end block
protocolType String No Protocol type
transaction: normal transaction
internal: internal transaction
token_20
token_721
token_1155
The default is transaction
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "724",
            "transactionList": [
                {
                    "height": "18809972",
                    "txId": "0xb86c039478b97be1e4de569ffa227dd57c0aeb793955328d7d17674f9ec0cee1",
                    "blockHash": "0x5248621464bded6029e20a0b2da1e103bb31bc4048d8623619b82eb6c2da25ce",
                    "transactionTime": "1702867319000",
                    "from": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
                    "isFromContract": false,
                    "isToContract": false,
                    "to": "0x5c8d0eed35a9e632bb8c0abe4662b6ab3326850b",
                    "amount": "0.150851832900380503",
                    "transactionSymbol": "ETH",
                    "txFee": "0.000926296864164",
                    "state": "success",
                    "tokenId": "",
                    "tokenContractAddress": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
transactionList Array Block transaction list
> txId String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time;Unix timestamp format in milliseconds, e.g. 1597026383085
> from String Sender address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> to String Funds arrival address
> amount String Number of transactions
> transactionSymbol String Symbol
> txFee String Transaction Fees
> state String Transaction status
success
fail
pending
> tokenContractAddress String Token Contract Address
> tokenId String NFT token Id
> methodId String method Id

Query block height by time

Query the block height that was validated at a certain timestamp, the supported chains are ETH, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, OMEGA, OPBNB, MANTA, TRON, OKTC, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

HTTP Request

GET /api/v5/explorer/block/block-height-by-time

Consumption per query 1

Request Example

GET /api/v5/explorer/block/block-height-by-time?chainShortName=eth&time=1702366480000

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
time String Yes The specific time you want to query, Unix timestamp in millisecond format, e.g. 1597026383085
closest String Yes before: the most recent block that was validated before (including) the given timestamp
after: the most recent block that was validated after (including) the given timestamp
The default ia before

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "height": "18768649",
            "blockTime": "1702366475000"
        }
    ]
}

Response Parameters

Parameter Type Description
height String Block height
blockTime String The actual time when the block was validated, Unix timestamp in millisecond format, e.g. 1597026383085

Query estimated block countdown time

Query the estimated time remaining, in seconds, until a certain block is validated, the supported chains are ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, GNOSIS

HTTP Request

GET /api/v5/explorer/block/block-count-down

Consumption per query 1

Request Example

GET /api/v5/explorer/block/block-count-down?chainShortName=eth&countDownBlockHeight=18812000

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
countDownBlockHeight String Yes The specific block height you want to query

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "currentBlockHeight": "18810144",
            "countDownBlockHeight": "18812000",
            "remainingBlock": "1856",
            "estimateTime": "22405.632"
        }
    ]
}

Response Parameters

Parameter Type Description
currentBlockHeight String The current latest block height
countDownBlockHeight String The block height you want to query
remainingBlock String Remaining number of blocks
estimateTime String Estimated remaining time for block verification to be completed, the unit is second

Query blocks validated by address

Get the list of blocks validated by an address, and only return the latest 10,000 data. The supported chains are ETH, BSC, POLYGON

HTTP Request

GET /api/v5/explorer/block/mined-block-list

Consumption per query 1

Request Example

GET /api/v5/explorer/block/mined-block-list?chainShortName=eth&address=0x4838b106fce9647bdf1e7877bf73ce8b0bad5f97&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Validator address
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "blockList": [
                {
                    "height": "18811110",
                    "blockTime": "1702881083000",
                    "mineReward": "0.028655772120729006"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
blockList Array The block list validated by the address
> height String Block height
> blockTime String Block time; Unix timestamp format in milliseconds, e.g. 1597026383085
> blockReward String Block reward, the unit is the native token of the chain

Address

These endpoints from this module retrieve the blockchain address data such as address balance, top whale address, and address details.

Query address information

To obtain the balance information of an address, you can obtain information such as the balance of the public chain address and the balance of the supported public chain smart contract tokens. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/address/address-summary

Consumption per query 1

Request Example

GET /api/v5/explorer/address/address-summary?chainShortName=eth&address=0x85c6627c4ed773cb7c32644b041f58a058b00d30

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "address": "0x85c6627c4ed773cb7c32644b041f58a058b00d30",
            "contractAddress": "",
            "balance": "0",
            "balanceSymbol": "ETH",
            "transactionCount": "3",
            "verifying": "0",
            "sendAmount": "0.00144563982877912",
            "receiveAmount": "0.00144563982877912",
            "tokenAmount": "0",
            "totalTokenValue": "",
            "createContractAddress": "",
            "createContractTransactionHash": "",
            "firstTransactionTime": "1649936533000",
            "lastTransactionTime": "1673174795000",
            "token": "",
            "bandwidth": "",
            "energy": "",
            "votingRights": "",
            "unclaimedVotingRewards": "",
            "isAaAddress": false
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
address String Ordinary address
contractAddress String Smart contract address
isProducerAddress Bol Whether it is the contract validator address
true
false
balance String Balance of the address
balanceSymbol String Balance Symbol
transactionCount String Number of transactions for this address
verifying String Amount under confirmation
sendAmount String Send amount
receiveAmount String Received amount
tokenAmount String Total types of tokens
totalTokenValue String Total token value
createContractAddress String Contract creator
createContractTransactionHash String The transaction hash that created the smart contract
firstTransactionTime String The time when the first transaction occurred at this address
lastTransactionTime String The last transaction time for this address
token String Corresponding token
bandwidth String As one of the resources in the TRON network, users need to consume bandwidth for sending transactions. Each user is eligible for a certain amount of free bandwidth every day, and also obtain extra bandwidth by staking TRX(Applicable to TRON)
energy String The execution of each instruction of smart contract consume a certain amount of energy while running, so contracts of different complexity consume different amounts of energy. When the contract is executed, energy is calculated and deducted according to instruction one by one. When the available energy of the account is insufficient, TRX needs to be burned to pay for the corresponding energy(Applicable to TRON)
votingRights String Each user in the TRON network is eligible to participate in the elections by staking their TRX to claim for the voting rights. Inversely, withdrawing their TRX under these processes would loss the voting rights(Applicable to TRON)
unclaimedVotingRewards String During the validator election, uses can received certain rewards if successfully voted for the validators. After each round of elections,the voting rewards distributed by validators need to be collected manually(Applicable to TRON)
isAaAddress Bol Whether it is an AA address

Query EVM address information

Get the information of an address, you can get the detail information such as balance, token balance, number of contract calls, contract corresponding tokens. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/information-evm

Request Example

GET /api/v5/explorer/address/information-evm?chainShortName=eth&address=0xdac17f958d2ee523a2206206994597c13d831ec7

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "balance": "0.000000000000000001",
            "balanceSymbol": "ETH",
            "transactionCount": "183337245",
            "firstTransactionTime": "1511831234000",
            "lastTransactionTime": "1697624363000",
            "contractAddress": true,
            "createContractAddress": "0x36928500bc1dcd7af6a2b4008875cc336b927d57",
            "createContractTransactionHash": "0x2f1c5c2b44f771e942a8506148e256f94f1a464babc938ae0690c6e34cd79190",
            "contractCorrespondingToken": "USDT",
            "contractCalls": "5132287",
            "contractCallingAddresses": "897673"
        }
    ]
}

Response Parameters

Parameter Type Description
address String Ordinary address
balance String Native token balance of the address
balanceSymbol String Symbol of native token
transactionCount String The transaction amount of the address
firstTransactionTime String The time when the first transaction occurred of this address
lastTransactionTime String The last transaction time of this address
contractAddress Bol Whether it is the contract validator address
createContractAddress String Contract creator address
createContractTransactionHash String The transaction hash that created the smart contract
contractCorrespondingToken String Corresponding token
contractCalls String The number of times the contract was called in the last 30 days. External and internal transactions are counted.
contractCallingAddresses String The number od addresses that called the contract in the last 30 days.

Query address active chain

Query the public chains where EVM-based addresses are active (i.e., have transactions). The supported chains are ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL.

Consumption per query 0

HTTP Request

GET /api/v5/explorer/address/address-active-chain

Request Example

GET /api/v5/explorer/address/address-active-chain?address=0xC098B2a3Aa256D2140208C3de6543aAEf5cd3A94

Request Parameters

Parameter Type Required Description
address String Yes Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Avalanche-C",
            "chainShortName": "AVAXC",
            "isContractAddress": true
        },
        {
            "chainFullName": "BNB Chain",
            "chainShortName": "BSC",
            "isContractAddress": false
        },
        {
            "chainFullName": "Polygon",
            "chainShortName": "POLYGON",
            "isContractAddress": false
        },
        {
            "chainFullName": "EthereumPoW",
            "chainShortName": "ETHW",
            "isContractAddress": false
        },
        {
            "chainFullName": "Fantom",
            "chainShortName": "FTM",
            "isContractAddress": false
        },
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "isContractAddress": false
        },
        {
            "chainFullName": "Gnosis",
            "chainShortName": "GNOSIS",
            "isContractAddress": false
        },
        {
            "chainFullName": "DIS CHAIN",
            "chainShortName": "DIS",
            "isContractAddress": false
        },
        {
            "chainFullName": "OP Mainnet",
            "chainShortName": "OP",
            "isContractAddress": false
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name
chainShortName String Chain short name
isContractAddress Bol Whether it is the contract validator address

Query address token balance

Get Token Balance Detail for an address to get information about the balance of all tokens on that address. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/token-balance

Request Example

GET /api/v5/explorer/address/token-balance?chainShortName=eth&address=0xdac17f958d2ee523a2206206994597c13d831ec7&protocolType=token_20&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address
protocolType String Yes Contract protocol Type
token_20
token_721
token_1155
tokenContractAddress String No Token Contract Address
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "limit": "1",
            "page": "1",
            "totalPage": "308",
            "tokenList": [
                {
                    "symbol": "FNK",
                    "tokenContractAddress": "0xb5fe099475d3030dde498c3bb6f3854f762a48ad",
                    "holdingAmount": "115.71687581",
                    "priceUsd": "",
                    "valueUsd": "34.25416242664877",
                    "tokenId": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenList Array Token list
> symbol String Symbol of the token
> tokenContractAddress String Token Contract Address
> holdingAmount String The holding amount of the token
> priceUsd String Token price in USD
> valueUsd String Total token value in USD
> tokenId String NFT token ID

Query address balance details

Get the balance details of an address, you can get other large balance information on the address. The supported chains are ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

This is an old interface. It is recommended to use the "Query address token balance" under this module.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/address-balance-fills

Request Example

GET /api/v5/explorer/address/address-balance-fills?chainShortName=eth&address=0xdac17f958d2ee523a2206206994597c13d831ec7&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address
protocolType String Yes Contract protocol Type
token_20
token_721
token_1155
token_10
tokenContractAddress String No Token Contract Address
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "308",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "tokenList": [
                {
                    "token": "USDT",
                    "tokenId": "",
                    "holdingAmount": "406275.909624",
                    "totalTokenValue": "257.29075982",
                    "change24h": "0.00010996",
                    "priceUsd": "1.00046",
                    "valueUsd": "406462.79654242704",
                    "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
tokenList Array Token List
> token String Token name
> tokenContractAddress String Token contract address
> holdingAmount String Token holding amount
> totalTokenValue String Total token value
> change24h String 24-hour change in token price
> priceUsd String Token USD price
> valueUsd String Total USD value of tokens
> tokenId String NFT token ID

Query address history balance

The interface updates the height of searchable blocks on an hourly basis. The supported chains are BTC, ETH, POLYGON,POLYGON_ZKEVM , AVAXC , OP, ARBITRUM, TRON.

HTTP Request

GET /api/v5/explorer/block/address-balance-history

Consumption per query 1

Request Example

GET /api/v5/explorer/block/address-balance-history?chainShortName=eth&height=18376634&address=0xd275e5cb559d6dc236a5f8002a5f0b4c8e610701

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
height String Yes Block height
address String Yes Address to check historical balance
tokenContractAddress String No Token contract address, if not filled in, check the balance of this chain tokens, if filled in, check the historical balance of the specified tokens

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "address": "0xd275e5cb559d6dc236a5f8002a5f0b4c8e610701",
            "height": "18376634",
            "balance": "5.895934930980364414",
            "balanceSymbol": "ETH",
            "tokenContractAddress": "",
            "blockTime": "1697624735000"
        }
    ]
}

Response Parameters

Parameter Type Description
address String Address
height String Block height
balance String Balance
blockTime String Generate block time; Unix timestamp format in milliseconds, e.g. 1597026383085
tokenContractAddress String Token contract address, if the query is for this chain coin, returns ""
balanceSymbol String The balance currency, if it is the local chain coin, is the name of the local chain token, if it is the specified token, is the abbreviated name of the token

Query address transaction list information

Get the transaction list of the public chains currently supported by OKLink, and only return nearly 10,000 transaction data. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/address/transaction-list

Consumption per query 1

Request Example

GET /api/v5/explorer/address/transaction-list?chainShortName=eth&address=0x85c6627c4ed773cb7c32644b041f58a058b00d30&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address
protocolType String No Contract protocol type
transaction
internal
token_20
token_721
token_1155
token_10
trx The default is transaction
symbol String No Symbol of the token
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "3",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "transactionLists": [
                {
                    "txId": "0x18714d659c9022eecd29bff3cd05cb78adc6c0b9522b04d713bfb2cc7a2f62f0",
                    "methodId": "",
                    "blockHash": "0xea0ee963034d87aeaccd6a0513725bec2a604b6a890e85d96289bfcd547154db",
                    "height": "16361564",
                    "transactionTime": "1673174795000",
                    "from": "0x85c6627c4ed773cb7c32644b041f58a058b00d30",
                    "to": "0xcffad3200574698b78f32232aa9d63eabd290703",
                    "isFromContract": false,
                    "isToContract": false,
                    "amount": "0.000567475798167289",
                    "transactionSymbol": "ETH",
                    "txFee": "0.000430211335176",
                    "state": "success",
                    "tokenId": "",
                    "tokenContractAddress": "",
                    "challengeStatus": "",
                    "l1OriginHash": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
transactionList Array Transaction list
> txId String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Broadcasting time for pending transactions. Unix timestamp format in milliseconds, e.g. 1597026383085
> from String Funds source address
> to String Funds arrival address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> amount String Transaction amount, for blockchains utilizing the UTXO model, the returned value represents the balance change prompted by this transaction for the specified address
> transactionSymbol String Transaction currency
> txFee String Transaction Fees
> state String Trading state
success
fail
pending
> tokenContractAddress String Token Contract Address
> challengeStatus String Challenge period status
> l1OriginHash String L1 executed transaction hash

Query address normal transaction list

Get a list of common transactions associated with an address and return only the last year or one year back from the time of the last transaction. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/normal-transaction-list

Request Example

GET /api/v5/explorer/address/normal-transaction-list?chainShortName=eth&address=0xdac17f958d2ee523a2206206994597c13d831ec7&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "limit": "1",
            "page": "1",
            "totalPage": "10000",
            "transactionList": [
                {
                    "txId": "0xac39ce204486c83fa1aef285456a7e0d76f4a76976ab5ab65bcea98d97ee8508",
                    "methodId": "0xa9059cbb",
                    "nonce": "0",
                    "gasPrice": "8438956495",
                    "gasLimit": "94813",
                    "gasUsed": "63209",
                    "blockHash": "0x62a73bc006e481f6f6da53c3d71ea7a8f20c78de4b12a8eaa89d59d68501eefc",
                    "height": "18383240",
                    "transactionTime": "1697704715000",
                    "from": "0xf284512f225b350bf6e71d5a327891fcd26f640c",
                    "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "isFromContract": false,
                    "isToContract": true,
                    "amount": "0",
                    "symbol": "ETH",
                    "txFee": "0.000533418001092455",
                    "state": "success",
                    "transactionType": "2"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txId String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time;Unix timestamp format in milliseconds, e.g. 1597026383085
> from String Funds source address
> to String Funds arrival address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> amount String Transaction amount
> state String trading state
success
fail
pending
> methodId String Method ID
> symbol String Symbol of the token
> nonce String The number of transactions initiated by the sender's address
> gasUsed String Actual amount of gas used
> gasLimit String Gas limit
> gasPrice String Gas price
> txFee String Transaction fees
> state String Transaction status
success
fail
pending
> transactionType String Transaction type
0:original transaction
1:EIP2930
2:EIP1559
Transaction type for Tron is also supported

Query address internal transaction list

Get a list of internal transactions associated with an address. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/internal-transaction-list

Request Example

GET /api/v5/explorer/address/internal-transaction-list?chainShortName=eth&address=0xdac17f958d2ee523a2206206994597c13d831ec7&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "limit": "1",
            "page": "1",
            "totalPage": "10000",
            "transactionList": [
                {
                    "txId": "0x34d5bd0c44da0864cfb8b9d7f3311d5eb598a4093b26dd5df5d25ec0e9df4942",
                    "operation": "call",
                    "blockHash": "0xee4e80ebc8a4b8071b07abd63906a4201bcf76d66100369a39148a0f529d098c",
                    "height": "18376673",
                    "transactionTime": "1697625227000",
                    "from": "0x3a5cc8689d1b0cef2c317bc5c0ad6ce88b27d597",
                    "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "isFromContract": true,
                    "isToContract": true,
                    "amount": "0",
                    "symbol": "ETH"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txid String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> from String Funds source address
> to String Funds arrival address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> operation String Operation type
> amount String Transaction amount
> symbol String Symbol of the token

Query address token transaction list

Get a list of token trading transactions associated with the address. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/token-transaction-list

Request Example

GET /api/v5/explorer/address/token-transaction-list?chainShortName=eth&address=0xdac17f958d2ee523a2206206994597c13d831ec7&protocolType=token_20&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g. ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
address String Yes Address
protocolType String Yes Token protocol Type
token_20
token_721
token_1155
token_10
The default is token_20
tokenContractAddress String No Token contract address
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "limit": "1",
            "page": "1",
            "totalPage": "10000",
            "transactionList": [
                {
                    "txId": "0x66e4b648d6b82c5e2cfdd2121af896a11618c69a356c307e2403a885a8503c88",
                    "blockHash": "0x6199c61f711a797e7bc88b213a5ae71374898a413e5e20f9f8ad420189088e82",
                    "height": "18376245",
                    "transactionTime": "1697620043000",
                    "from": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "to": "0xce7a837e1717301cb30d668ec6fcc9f4d312f30f",
                    "tokenContractAddress": "0xd8daa146dc3d7f2e5a7df7074164b6ad99bed260",
                    "tokenId": "",
                    "amount": "1450000000",
                    "symbol": "",
                    "isFromContract": true,
                    "isToContract": false
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txId String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> from String Funds source address
> to String Funds arrival address
> tokenContractAddress String Token contract address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> amount String Transaction amount
> symbol String Token symbol
> tokenId String NFT token ID

Batch query address entity labels

Batch query the entity labels for a maximum of 20 addresses on a specific chain, only returning the addresses with exchange big address labels and project labels. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, STARKNET, BASE, SCROLL, OMEGA, OPBNB.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/address/entity-label

Request Example

GET /api/v5/explorer/address/entity-label?chainShortName=eth&address=0x539C92186f7C6CC4CbF443F26eF84C595baBBcA1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH.
address String Yes Address, up to 20 addresses separated by a comma.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "label": "OKX.Cold Wallet",
            "address": "0x539c92186f7c6cc4cbf443f26ef84c595babbca1"
        }
    ]
}

Response Parameters

Parameter Type Description
label String The entity labels for the address, such as "Binance.Deposit". If an address has multiple entity labels, they will be separated by commas.
address String Address

Batch query balances

This API allows for the batch querying of native token balances for up to 100 addresses. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 10

HTTP Request

GET /api/v5/explorer/address/balance-multi

Request Example

GET /api/v5/explorer/address/balance-multi?chainShortName=eth&address=0x85c6627c4ed773cb7c32644b041f58a058b00d30,0xb13a8883d5116b418066c379bc3b3f40d087b8d8

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name
address String Yes Addresses, up to 100 addresses separated by a comma.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "symbol": "ETH",
            "balanceList": [
                {
                    "address": "0x85c6627c4ed773cb7c32644b041f58a058b00d30",
                    "balance": "0"
                },
                {
                    "address": "0xb13a8883d5116b418066c379bc3b3f40d087b8d8",
                    "balance": "0.00019330554147975"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
symbol String Native token of the chain
balanceList Array Balance list
> address String Address
> balance String Native token balance of the address

Batch query token balances

This API allows for the batch querying of token balances for up to 50 addresses. The supported chains are LTC, ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/address/token-balance-multi

Request Example

GET /api/v5/explorer/address/token-balance-multi?chainShortName=eth&address=0x85c6627c4ed773cb7c32644b041f58a058b00d30,0xb13a8883d5116b418066c379bc3b3f40d087b8d8

Request Example

Parameter Type Required Description
chainShortName String Yes Chain abbreviation
address String Yes Addresses, up to 50 addresses separated by commas.
protocolType String No Different token types, for ERC-20 tokens: token_20, for ERC-721 tokens: token_721, for ERC-1155 tokens: token_1155
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "2",
            "totalPage": "686",
            "balanceList": [
                {
                    "address": "0xf977814e90da44bfa03b6295a0616a897441acec",
                    "holdingAmount": "400",
                    "tokenContractAddress": "0x7379cbce70bba5a9871f97d33b391afba377e885"
                },
                {
                    "address": "0xf977814e90da44bfa03b6295a0616a897441acec",
                    "holdingAmount": "123101078.45198849",
                    "tokenContractAddress": "0x5c885be435a9b5b55bcfc992d8c085e4e549661e"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of records per page, default minimum 20 records, up to 100
totalPage String Total number of pages
balanceList Array List of token balances
> address String Address
> holdingAmount String Token balance of the address
> tokenContractAddress String Contract address of the token

Batch query normal transactions

This allows for querying ordinary transactions of up to 20 addresses at once. It is necessary to limit the starting block height and the ending block height, the difference between which cannot exceed 10,000 blocks. The supported chains are LTC, ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/address/normal-transaction-list-multi

Example Request

GET /api/v5/explorer/address/normal-transaction-list-multi?chainShortName=eth&address=00x533a7ae90fee4cafbc00e6a551cfb39a954cbf48,0xc0a3465b50a47848b7d04e145df61565d3e10566&endBlockHeight=18374343&startBlockHeight=18374341

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain abbreviation
address String Yes Addresses, up to 20 addresses separated by ,
startBlockHeight String Yes Starting block number for the search
endBlockHeight String Yes Ending block number for the search
page String No Page number
limit String No Number of records per page, default min 20, max 100

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "transactionList": [
                {
                    "txId": "0x76e650150abadac6c781c9c90a0fcda69fce6e69f0fbbfb08d8cadc26076802a",
                    "methodId": "",
                    "blockHash": "0x58c6a91b0b5ff04bb7ea9b9f264c547472a96dafbdb069acc1e2e8d63792db16",
                    "height": "18374343",
                    "transactionTime": "1697597087000",
                    "from": "0x533a7ae90fee4cafbc00e6a551cfb39a954cbf48",
                    "to": "0xc0a3465b50a47848b7d04e145df61565d3e10566",
                    "isFromContract": false,
                    "isToContract": false,
                    "amount": "15296",
                    "symbol": "ETH",
                    "txFee": "0.000139810264818",
                    "gasLimit": "21000",
                    "gasUsed": "21000",
                    "gasPrice": "6657631658",
                    "nonce": "",
                    "transactionType": "2"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Page number
limit String Number of records per page, default min 20, max 100
totalPage String Total number of pages
transactionList Array List of transactions
> txId String Transaction hash
> methodId String Short hash identifying the smart contract function
> nonce String The number of transactions initiated by the sender's address
> blockHash String Block hash
> height String Block height of the transaction
> transactionTime String Transaction times; in milliseconds format of Unix timestamp, e.g., 1597026383085
> from String Transaction sender's address, multiple addresses separated by ,
> to String Transaction receiver's address, multiple addresses separated by ,
> isFromContract Bool Whether the from address is a contract address
> isToContract Bool Whether the to address is a contract address
> amount String Token amount
> symbol String Symbol of the transaction token
> txFee String Transaction fee (in ETH)
> gasLimit String Maximum gas amount
> gasUsed String Actual amount of gas used (in Wei)
> gasPrice String Gas price (in Wei)
> transactionType String Transaction type
0:original transaction
1:EIP2930
2:EIP1559
Transaction type for Tron is also supported

Batch query internal transactions

You can perform a batch query for up to 20 addresses' regular transactions. You need to limit the query to a starting and ending block height, and the difference between the two cannot exceed 10,000 blocks. The supported chains are LTC, ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/address/internal-transaction-list-multi

Request Example

GET /api/v5/explorer/address/internal-transaction-list-multi?chainShortName=eth&address=0xd501520326d41aead2a70d4b5bf0c4646c0c9bd8,0xd275e5cb559d6dc236a5f8002a5f0b4c8e610701&endBlockHeight=18374470&startBlockHeight=18370000&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Addresses, up to 20 can be entered, separated by commas
startBlockHeight String Yes The start block height for the search
endBlockHeight String Yes The end block height for the search
page String No Page number
limit String No Number of results per page. The default minimum is 20 and the maximum is 100

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "7",
            "transactionList": [
                {
                    "txId": "0xfcc0b4d18791f5932ba7e3563012a176ef0d9f959e0beefc34f6956a0d0043b6",
                    "blockHash": "0x6eab9220138600d0cd66b73737aec77c016c18c91e13e93a938b7477e1e18865",
                    "height": "18373050",
                    "transactionTime": "1697581427000",
                    "operation": "call",
                    "from": "0x09fa0d3154363036ea406f254808c53f5f975518",
                    "to": "0xd275e5cb559d6dc236a5f8002a5f0b4c8e610701",
                    "isFromContract": true,
                    "isToContract": false,
                    "amount": "2450"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of results per page. The default minimum is 20 and the maximum is 100
totalPage String Total number of pages
transactionList Array List of transactions
> txId String Transaction hash
> blockHash String Block hash
> height String Block height where the transaction occurred
> operation String Operation type (e.g., staticcall)
> from String Transaction origin addresses, multiple addresses can be separated by commas
> to String Transaction destination addresses, multiple addresses can be separated by commas
> isFromContract Bool Whether the 'from' address is a contract address
> isToContract Bool Whether the 'to' address is a contract address
> amount String Amount of tokens involved in the transaction

Batch query token transactions

This API allows for the batch querying of transactions for up to 20 addresses. It is required to set both the starting block height and the ending block height, with the difference between the two not exceeding 10,000 blocks. The supported chains are LTC, ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/address/token-transaction-list-multi

Request Example

GET /api/v5/explorer/address/token-transaction-list-multi?chainShortName=eth&address=0xd501520326d41aead2a70d4b5bf0c4646c0c9bd8,0xd275e5cb559d6dc236a5f8002a5f0b4c8e610701&endBlockHeight=18374470&startBlockHeight=18370000&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain abbreviation
address String Yes Addresses, up to 20 addresses separated by a comma.
startBlockHeight String Yes Starting block height for the search.
endBlockHeight String Yes Ending block height for the search.
page String No Page number.
limit String No Number of results per page; default is a minimum of 20 and a maximum of 100.
protocolType String No Token protocol Type
token_20
token_721
token_1155
token_10
The default is token_20
tokenContractAddress String No Token contract address, up to 20 addresses separated by a comma.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "88",
            "transactionList": [
                {
                    "txId": "0x644fe2fbc53316c3146760ecdb1405fc2dcb4893ac19552ad0898ea669176300",
                    "blockHash": "0xd027f203664d2911cb2bf2f73134539e6f7b5ac20be6ca998b7ea3691acfcd3d",
                    "height": "18373112",
                    "transactionTime": "1697582183000",
                    "from": "0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae",
                    "to": "0xd275e5cb559d6dc236a5f8002a5f0b4c8e610701",
                    "isFromContract": true,
                    "isToContract": false,
                    "amount": "1",
                    "tokenId": "1",
                    "symbol": "Airdrop",
                    "tokenContractAddress": "0xf7b24c63fe941f2caadaee49f10e565d850be067"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Page number.
limit String Number of results per page; default is a minimum of 20 and a maximum of 100.
totalPage String Total number of pages.
transactionList Array List of transactions.
> txId String Transaction hash.
> blockHash String Block hash.
> height String Block height at which the transaction occurred.
> transactionTime String Time of the transaction; in Unix timestamp format in milliseconds, e.g., 1597026383085.
> from String Sending address(es) of the transaction, separated by a comma if multiple.
> to String Receiving address(es) of the transaction, separated by a comma if multiple.
> isFromContract Bool Whether the sending address is a contract address.
> isToContract Bool Whether the receiving address is a contract address.
> amount String Token amount.
> tokenId String Token ID, applicable for ERC721 and ERC1155 tokens.
> symbol String Symbol of the token.
> tokenContractAddress String Contract address of the token.

Top 100 richest addresses

Get the details of the top 100 addresses with the address balance of a public chain or contract. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/address/rich-list

Consumption per query 1

Request Example

GET /api/v5/explorer/address/rich-list?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String No Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "symbol": "BTC",
            "rank": "1",
            "address": "34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo",
            "amount": "248597.39163733",
            "transactionCount": "842",
            "holdRatio": "0.0118",
            "netWork": ""
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
symbol String Symbol of the token held
rank String Rank of the token balance
address String Holding address
amount String Holding amount
transactionCount String The number of transactions
holdRatio String Holding percentage
netWork String The name of the chain, showing the chainFullName of the corresponding public chain, e.g. TRON

Native token position ranking

Get the native token position ranking of a public chain, and only return the address with a balance of top 10000. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, X1_TEST, BSC, ETC, POLYGON, AVAXC, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET

HTTP Request

GET /api/v5/explorer/address/native-token-position-list

Consumption per query 1

Request Example

GET /api/v5/explorer/address/native-token-position-list?chainShortName=ETH

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
page String No Page number
limit String No Number of results per page, default is a minimum of 20 and a maximum of 100.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "3",
            "totalPage": "3334",
            "positionList": [
                {
                    "rank": "1",
                    "symbol": "ETH",
                    "holderAddress": "0x00000000219ab540356cbb839cbe05303d7705fa",
                    "amount": "35312968.32606823"
                },
                {
                    "rank": "2",
                    "symbol": "ETH",
                    "holderAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "amount": "3234638.2256898033"
                },
                {
                    "rank": "3",
                    "symbol": "ETH",
                    "holderAddress": "0xbe0eb53f46cd790cd13851d5eff43d12404d33e8",
                    "amount": "1996008.379796362"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Page number.
limit String Number of results per page; default is a minimum of 20 and a maximum of 100.
totalPage String Total number of pages.
positionList Array Position list
> rank String Rank of the token balance
> symbol String Symbol of the token held
> address String Holding address
> amount String Holding amount

Pool

These endpoints from this module retrieve data related to specific mining pools such as mining hash rate rankings and lists of validators.

Query the mining pool share

Get the estimated share of each mining pool. The supported chains are BTC, BCH, LTC, DASH, ETH.

HTTP Request

GET /api/v5/explorer/pool/estimated-pool-share

Consumption per query 1

Request Example

GET /api/v5/explorer/pool/estimated-pool-share?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g. BTC、ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
period String No Date
1D; 3D; 1W; 1M; 3M; 1Y; All
Default is 1D

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "rank": "1",
            "poolName": "AntPool",
            "hashrate": "0",
            "ratio": "0.2933",
            "blockCount": "44",
            "emptyBlockCount": "0",
            "ommerBlockCount": "0",
            "avgBlockSize": "",
            "avgFee": "0.12343160636363637",
            "minerFeeRatio": "0.0197"
        },
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "rank": "2",
            "poolName": "Foundry USA",
            "hashrate": "0",
            "ratio": "0.28",
            "blockCount": "42",
            "emptyBlockCount": "0",
            "ommerBlockCount": "0",
            "avgBlockSize": "",
            "avgFee": "0.14027478785714284",
            "minerFeeRatio": "0.0224"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
rank String The rank of block production quantity
poolName String Pool name
hashrate String Hash rate
ratio String The percentage of block production share, displayed as a decimal with precision to four decimal places
blockCount String The number of blocks
emptyBlockCount String The number of empty blocks
ommerBlockCount String The number of ommer blocks
avgBlockSize String Average block size, in Bytes
avgFee String Average transaction fee
minerFeeRatio String Miner fee percentage

Get the mining pool hashrate ranking

Get the computing power ranking of a public chain mining pool. The supported chains are BTC, BCH, LTC, DASH, ETH.

HTTP Request

GET /api/v5/explorer/pool/pool-hashrate-rank

Consumption per query 1

Request Example

GET /api/v5/explorer/pool/pool-hashrate-rank?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g. BTC、ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
category String No Category
real
estimated
Defaults to real

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "rank": "1",
            "poolName": "Foundry USA",
            "hashrate": "127637910960000010000",
            "change24h": "0.0174",
            "luckyRatio": "1.0347"
        },
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "rank": "2",
            "poolName": "AntPool",
            "hashrate": "115000000000000000000",
            "change24h": "0.0000",
            "luckyRatio": "1.0785"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
rank String The rank of hash rate
poolName String Pool name
hashrate String Hash rate
change24h String 24-hour change in computing power
luckyRatio String Lucky ratio

Validator

Get the list of supernodes or validators of the public chains currently supported by OKLink, suitable for chains such as OKC and BSC for pledge mining. The supported chains are OKTC, X1_TEST, BSC, TRON.

HTTP Request

GET /api/v5/explorer/pool/validator-list

Consumption per query 1

Request Example

GET /api/v5/explorer/pool/validator-list?chainShortName=bsc&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name. e.g. BTC、ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
period period No Date
1D; 1W; 3M; 1Y; All
Default is 1D
validatorName String No Validator name
limit String No Number of results per request. The maximum is 50. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "33",
        "validatorList": [
            {
                "rank": "1",
                "validatorName": "Fuji",
                "validatorAddress": "0x7ae2f5b9e386cd1b50a4550696d957cb4900f03a",
                "weightRatio": "0.05",
                "weight": "",
                "blocks": "1323",
                "staked": "1118400.13217862",
                "stakedSymbol": "BNB",
                "reward": "-0.07670620656615305",
                "rewardSymbol": "BNB",
                "state": "-1",
                "firstHeight": "48",
                "latestHeight": "32710953",
                "type": ""
            }
        ]
    }
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
validatorList Array Validator list
> rank String The rank of the validator
> validatorName String Validator name
> validatorAddress String Validator address
> weightRatio String Weight ratio
> weight String Weight
> blocks String Number of blocks generated
> staked String Amount of pledge (estimated value)
> stakedSymbol String Staked token name
> reward String Reward
> rewardSymbol String Reward token
> state String Validator Status
> firstHeight String First block height
> latestHeight String Last block height
> type String Tron node type
SUPER, Super representative
SUPERPARTNER, SR partner
SUPERCANDIDATE, SR candidates

Transaction

These endpoints from this module retrieve transaction data such as a list of large transactions, transaction details, and unconfirmed transactions.

Query transaction list information

Get the transaction list of the public chains, and only return nearly 10,000 transaction data. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/transaction/transaction-list

Consumption per query 1

Request Example

GET /api/v5/explorer/transaction/transaction-list?chainShortName=btc&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
blockHash String No Block hash
height String No Block height
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "transactionList": [
                {
                    "txid": "8b09dcbc5604284aa88e171e75d717557d9668d4f5499a0db2a7522e478ac3dc",
                    "blockHash": "000000000000000000021a5bdbd89b086bf6932db2751cf7a01ca873317b3231",
                    "height": "812753",
                    "transactionTime": "1697632271000",
                    "input": "bc1qr2kugnsttnjkcawhpltw4nsh3z6vuxxguk0z3d,bc1qr2kugnsttnjkcawhpltw4nsh3z6vuxxguk0z3d,bc1qr2kugnsttnjkcawhpltw4nsh3z6vuxxguk0z3d,bc1qr2kugnsttnjkcawhpltw4nsh3z6vuxxguk0z3d,bc1qr2kugnsttnjkcawhpltw4nsh3z6vuxxguk0z3d,bc1qr2kugnsttnjkcawhpltw4nsh3z6vuxxguk0z3d",
                    "output": "bc1qlavjjmxghslxj6qrcjy2rs5mv7pugy3mzawt80,bc1qr2kugnsttnjkcawhpltw4nsh3z6vuxxguk0z3d",
                    "isInputContract": false,
                    "isOutputContract": false,
                    "amount": "0.00499015",
                    "transactionSymbol": "BTC",
                    "txfee": "0.0007215",
                    "methodId": "",
                    "transactionType": "",
                    "state": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
transactionList Array Transaction list
> txid String Transaction hash
> blockHash String Block hash
> height String Block height of the transaction
> transactionTime String Transaction time;Unix timestamp format in milliseconds, e.g. 1597026383085
> input String Token arrival address
> output String Token transfer out address
> isFromContract Bol Is the input address a contract address
> isToContract Bol Is the output address a contract address
> amount String Transaction amount
> transactionSymbol String Token symbol of the transaction
> txfee String Transaction fee
> methodId String Method id
> transactionType String Transaction type
0:original transaction type
1:EIP2930
2:EIP1559
> state String Transaction state
success
fail
pending

Query the list of large value transactions

Get the list of large-value transactions on the public chains. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/transaction/large-transaction-list

Consumption per query 1

Request Example

GET /api/v5/explorer/transaction/large-transaction-list?chainShortName=btc&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
type String No Query transactions with amount more than this value, with a minimum threshold of 100. The default is 100.
height String No Block height
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "transactionList": [
                {
                    "txid": "bca066292115784d9e83263df6b520794d43b8a8ac8622b03fc7ef6803331710",
                    "blockHash": "000000000000000000003549b3b7fcdff3a6328021eeabdae70c57e0fd3776c5",
                    "height": "812747",
                    "transactionTime": "1697627155000",
                    "input": "3D68UNbZVkaxZHGeXZ553xudqGfGjcF5y2",
                    "output": "3MNZCAW6C8rGQKzS39tARXnKVUcRyFF379,3JFudoNxai4Mg9TTB97PZ1i5kZHZ1EzJPT",
                    "isInputContract": false,
                    "isOutputContract": false,
                    "amount": "5119.9088941",
                    "transactionSymbol": "BTC",
                    "txfee": "0.0000498",
                    "methodId": "",
                    "transactionType": "",
                    "state": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
transactionList Array Transaction list
> txid String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> input String Input address
> output String Output address
> isInputContract Bol Is the input address a contract address
> isOutputContract Bol Is the output address a contract address
> amount String Transaction amount
> transactionSymbol String Transaction symbol
> txfee String Transaction fee
> methodId String Method id
> transactionType String Transaction type
0:original transaction
1:EIP2930
2:EIP1559
> state String Transaction status
success
fail
pending

Query the list of unconfirmed transactions

Get the list of unconfirmed transactions on the public chains, and only return nearly 10,000 transaction data. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/transaction/unconfirmed-transaction-list

Consumption per query 1

Request Example

GET /api/v5/explorer/transaction/unconfirmed-transaction-list?chainShortName=btc&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "transactionList": [
                {
                    "txid": "e41a58a47d2f9220c367780acd8fc9ee8461b964f1b6ffb3dd610302681b7656",
                    "height": "",
                    "transactionTime": "",
                    "input": "bc1qxx76udl8kjahmlvd8xktaflxgyg0gn664ucw00",
                    "output": "3GzPyo2eJJgjRB3C3e6w2SfX1heuiPnixo",
                    "isInputContract": false,
                    "isOutputContract": false,
                    "amount": "0.002321",
                    "transactionSymbol": "BTC",
                    "txfee": "2220",
                    "methodId": "",
                    "transactionType": "",
                    "randomNumber": "",
                    "status": "pending"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
transactionList Array Transaction list
> txid String Transaction hash
> height String Block height
> transactionTime String Transaction time;Unix timestamp format in milliseconds, e.g. 1597026383085
> isInputContract Bol Is the input address a contract address
> isOutputContract Bol Is the output address a contract address
> input String Token arrival address
> output String Token transfer out address
> amount String Transaction amount
> transactionSymbol String Token symbol
> txfee String Transaction fee
> methodId String Method id
> transactionType String Transaction type
0:original transaction type
1:EIP2930
2:EIP1559
> state String Transaction state
success
fail
pending
> randomNumber String RandomNumber

Query internal transaction detail

Query for internal transaction detail by transaction hash. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/transaction/internal-transaction-detail

Request Example

GET /api/v5/explorer/transaction/internal-transaction-detail?chainShortName=eth&txId=0x06d35ea1b5ec75fa9f66bb0d481102aad6236a8e70427cd91a1b1c3e754244dc&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
txId String Yes Transaction hash
page String No Page
limit String No Number of results per request

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10",
            "internalTransactionDetails": [
                {
                    "txId": "0x06d35ea1b5ec75fa9f66bb0d481102aad6236a8e70427cd91a1b1c3e754244dc",
                    "from": "0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad",
                    "to": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "height": "18076803",
                    "transactionTime": "1693995971000",
                    "isFromContract": true,
                    "isToContract": true,
                    "operation": "call",
                    "amount": "0.002",
                    "state": "success"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
internalTransactionDetails Array Internal transaction details
> txId String Transaction hash
> height String Block height of the transaction
> transactionTime String Transaction time
> from String Funds source address
> to String Funds arrival address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> operation String Operation type
> amount String Transaction amount
> state String Trading state

Query token transaction detail

Query for token transfer detail by transaction hash. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/transaction/token-transaction-detail

Request Example

GET /api/v5/explorer/transaction/token-transaction-detail?chainShortName=eth&txId=0x06d35ea1b5ec75fa9f66bb0d481102aad6236a8e70427cd91a1b1c3e754244dc&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
txId String Yes Transaction hash
protocolType String No Contract protocol Type
page String No Page
limit String No Number of results per request

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "tokenTransferDetails": [
                {
                    "txId": "0x06d35ea1b5ec75fa9f66bb0d481102aad6236a8e70427cd91a1b1c3e754244dc",
                    "from": "0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad",
                    "to": "0xf66369997ae562bc9eec2ab9541581252f9ca383",
                    "height": "18076803",
                    "transactionTime": "1693995971000",
                    "isFromContract": true,
                    "isToContract": true,
                    "tokenContractAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "symbol": "WETH",
                    "amount": "0.002"
                },
                {
                    "txId": "0x06d35ea1b5ec75fa9f66bb0d481102aad6236a8e70427cd91a1b1c3e754244dc",
                    "from": "0xf66369997ae562bc9eec2ab9541581252f9ca383",
                    "to": "0xb59ac29fadba6818628a6cb0060a4b57fc4a7126",
                    "height": "18076803",
                    "transactionTime": "1693995971000",
                    "isFromContract": true,
                    "isToContract": false,
                    "tokenContractAddress": "0xbc396689893d065f41bc2c6ecbee5e0085233447",
                    "symbol": "PERP",
                    "amount": "4.23951772020582"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenTransferDetails Array Token transfer detail
> txId String Transaction hash
> height String Block height
> transactionTime String Transaction time
> from String Funds source address
> to String Funds arrival address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> tokenContractAddress String Contract address of the token
> amount String Transaction amount
> symbol String Token symbol

Query transaction details

Get the basic transaction information on the public chains. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, APT, SUI, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

This is an old interface. We recommend using other interfaces under this module to query detailed transaction information.

HTTP Request

GET /api/v5/explorer/transaction/transaction-fills

Consumption per query 1

Request Example

GET /api/v5/explorer/transaction/transaction-fills?chainShortName=eth&txid=0x3ae59abf714df29a15bb8ecadfbe3068aff20693bb91c7e7c9d34ce245d56def

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
txid String Yes Transaction hash, batch query up to 20 transactions, separated by English commas.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "txid": "0x3ae59abf714df29a15bb8ecadfbe3068aff20693bb91c7e7c9d34ce245d56def",
            "height": "18126676",
            "transactionTime": "1694599499000",
            "amount": "0.1",
            "transactionSymbol": "ETH",
            "txfee": "0.000491371954353",
            "index": "576",
            "confirm": "250634",
            "inputDetails": [
                {
                    "inputHash": "0xe61771cd810d82e6ef302f69c76fbaf0538818c7",
                    "isContract": false,
                    "amount": ""
                }
            ],
            "outputDetails": [
                {
                    "outputHash": "0x095624a01088cca5aae036c128cc9ac8032b9a3c",
                    "isContract": false,
                    "amount": ""
                }
            ],
            "state": "success",
            "gasLimit": "21000",
            "gasUsed": "21000",
            "gasPrice": "0.000000023398664493",
            "totalTransactionSize": "",
            "virtualSize": "0",
            "weight": "",
            "nonce": "1365",
            "transactionType": "2",
            "methodId": "",
            "errorLog": "",
            "inputData": "0x",
            "isAaTransaction": false,
            "tokenTransferDetails": [],
            "contractDetails": []
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
txid String Transaction hash
height String Block height of the transaction
transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
transactionType String Transaction type
0:original transaction
1:EIP2930
2:EIP1559
amount String Transaction amount
methodId String Method Id
errorLog String Transaction failure logs
inputData String Input data
transactionSymbol String Token symbol of the transaction
txfee String Transaction fee
index String The position index of the transaction in the block
confirm String Confirmed block count
inputDetails Array Input details
> inputHash String The hash address that initiated the transaction
> isContract Bol Contract address
true
false
> amount String Transaction amount
outputDetails Array Output details
> outputHash String The hash address to receive the transaction
> isContract Bol Contract address
true
false
> amount String Transaction amount
state String Transaction state
success
fail
pending
gasLimit String Gas limit
gasUsed String Actual amount of gas used
gasPrice String Gas price
totalTransactionSize String Total transaction size
virtualSize String Virtual size
weight String Weight
nonce String The number of transactions initiated by the sender's address
isAaTransaction Bol Whether it is an AA transaction
tokenTransferDetails Array Token transfer details. Request the new interface GET /api/v5/explorer/transaction/internal-transaction-detail and GET /api/v5/explorer/transaction/token-transaction-detail to query more transaction data
> index String The positional index of the transaction in the block
> token String Token name
> tokenContractAddress String Token contract address
> symbol String Token symbol
> from String Token transfer out address
> to String Token arrival address
> isFromContract Bol Is the transfer out token address a contract address
> isToContract Bol Whether the receiving token address is a contract address
> tokenId String NFT token id
> amount String Token transfer amount
contractDetails Array Contract call transfer details
> index String The positional index of the transaction in the block
> from String Token transfer out address
> to String Token arrival address
> isFromContract Bol Is the transfer out token address a contract address
> isToContract Bol Is the receiving token address a contract address
> amount String Transaction amount
> gasLimit String Gas limit

Batch query transaction detail

This allows for querying transactions of up to 20 transaction at once. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/transaction/transaction-multi

Request Example

GET /api/v5/explorer/transaction/transaction-multi?chainShortName=eth&txId=0x9a6eca1a9f4cc9b8d338bba2ad50d71be42ceb6aac50059cb8b1fac7e8a37d74

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
txId String Yes Transaction hash

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "txId": "0x9a6eca1a9f4cc9b8d338bba2ad50d71be42ceb6aac50059cb8b1fac7e8a37d74",
            "methodId": "",
            "blockHash": "0x7b9f40bb135a93a9638d30aa6e4ad97deba89542a975468eede129fad9f5e8df",
            "height": "18362555",
            "transactionTime": "1697454719000",
            "from": "0x4838b106fce9647bdf1e7877bf73ce8b0bad5f97",
            "to": "0xd87cba5b88ca8c937792a564a60afc0d0683e731",
            "isFromContract": false,
            "isToContract": false,
            "amount": "0.030891615623385848",
            "symbol": "ETH",
            "nonce": "97806",
            "txFee": "0.000194151615588",
            "gasPrice": "9245315028",
            "gasLimit": "21000",
            "gasUsed": "21000",
            "state": "success",
            "transactionType": ""
        }
    ]
}

Response Parameters

Parameter Type Description
txId String Transaction hash
blockHash String Block hash
height String Block height
transactionTime String Transaction time;Unix timestamp format in milliseconds
from String Funds source address
to String Funds arrival address
isFromContract Bol Is the From address a contract address
isToContract Bol Is the To address a contract address
amount String Transaction amount
symbol String Token symbol
nonce String The number of transactions initiated by the sender's address
gasLimit String Gas limit
gasUsed String Actual amount of gas used
gasPrice String Gas price
txFee String Transaction Fees
state String Trading state
transactionType String Transaction type
0:original transaction
1:EIP2930
2:EIP1559
methodId String Method id
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> amount String Transaction amount
> state String trading state
success
fail
pending
> method String Method ID
> symbol String Symbol
> nonce String Nonce
> gasUsed String Gas
> gasLimit String Gas limit
> gasPrice String Gas avg price
> txFee String Transaction Fees
> state String Transaction status
success
fail
pending

Batch query internal transaction

This allows for querying internal transactions of up to 20 transaction at once. The supported chains are ETH, OKTC, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/transaction/internal-transaction-multi

Request Example

GET /api/v5/explorer/transaction/internal-transaction-multi?chainShortName=eth&txId=0x633989939634e27ca69e784476a6e06766357ededc42b81b1e112a0180f3b03b

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
txId String Yes Transaction hash
page String No Page
limit String No Number of results per request

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "transactionList": [
                {
                    "txId": "0x633989939634e27ca69e784476a6e06766357ededc42b81b1e112a0180f3b03b",
                    "blockHash": "0x469ae737291639f3137d3d4e9649c56489e5d19e272248781f8869220900f809",
                    "height": "18368538",
                    "transactionTime": "1697526923000",
                    "operation": "delegatecall",
                    "from": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
                    "to": "0xa2327a938febf5fec13bacfb16ae10ecbc4cbdcf",
                    "isFromContract": true,
                    "isToContract": true,
                    "amount": "0"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
internalTransactionDetails Array Internal transaction details
> txId String Transaction hash
> height String Block height of the transaction
> transactionTime String Transaction time
> operation String Operation type
> from String Funds source address
> to String Funds arrival address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> amount String Transaction amount

Batch query token transaction

This allows for querying token transactions of up to 20 transaction at once. The supported chains are ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/transaction/token-transfer-multi

Request Example

GET /api/v5/explorer/transaction/token-transfer-multi?chainShortName=eth&txId=0x633989939634e27ca69e784476a6e06766357ededc42b81b1e112a0180f3b03b

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
txId String Yes Transaction hash
protocolType String No Contract protocol Type
page String No Page
limit String No Number of results per request

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "transactionList": [
                {
                    "txId": "0x633989939634e27ca69e784476a6e06766357ededc42b81b1e112a0180f3b03b",
                    "blockHash": "0x469ae737291639f3137d3d4e9649c56489e5d19e272248781f8869220900f809",
                    "height": "18368538",
                    "transactionTime": "1697526923000",
                    "from": "0xc94ebb328ac25b95db0e0aa968371885fa516215",
                    "to": "0x3275311fde369a68ef90bc25de9d462e1d5c8bb7",
                    "isFromContract": false,
                    "isToContract": false,
                    "amount": "554",
                    "tokenId": "",
                    "symbol": "USDC",
                    "tokenContractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenTransferDetails Array Token transfer detail
> txId String Transaction hash
> blockHash String Block hash of the transaction
> height String Block height
> transactionTime String Transaction time
> from String Funds source address
> to String Funds arrival address
> isFromContract Bol Is the From address a contract address
> isToContract Bol Is the To address a contract address
> tokenContractAddress String Contract address of the token.
> amount String Transaction amount
> tokenId String NFT token ID
> symbol String Token symbol

Token

The endpoints from this module retrieve data for a specified token detail. You can query the token price data on 200+ public chains via the endpoints in Market Data module.

Query token list information

Get basic information about a token on a chain, you can filter tokens by their issue date to search for the latest issued tokens, and the maximum filtering time span is one year.
The supported chains are ETH, OKTC, X1_TEST, BSC, POLYGON, AVAXC, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/token/token-list

Consumption per query 1

Request Example

GET /api/v5/explorer/token/token-list?chainShortName=eth&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
protocolType String No Contract protocol type
token_20
token_721
token_1155
token_10 Default is token_20
tokenContractAddress String No Token contract address
startTime String No Retrieve tokens with issue dates later than this time. It should be in Unix timestamp format in milliseconds, e.g., 1597026383085. The time difference between startTime and endTime should not exceed one year.
endTime String No Retrieve tokens with issue dates earlier than this time. It should be in Unix timestamp format in milliseconds, e.g., 1597026383085. The time difference between startTime and endTime should not exceed one year.
orderBy String No Return the results in descending order based on different criteria. Only applicable to 20 tokens.
totalMarketCap: Sort by total market capitalization in descending order.
transactionAmount24h: Sort by 24-hour transaction amount in descending order.
By default, the results are sorted by market capitalization in descending order.
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "tokenList": [
                {
                    "tokenFullName": "Tether USD",
                    "token": "USDT",
                    "precision": "6",
                    "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "protocolType": "ERC20",
                    "addressCount": "4908191",
                    "totalSupply": "87625667476.7",
                    "circulatingSupply": "84605973812.99",
                    "price": "1.00026",
                    "website": "https://tether.to/",
                    "totalMarketCap": "84650814979.11",
                    "issueDate": "1511883490000",
                    "transactionAmount24h": "6781719762.427729",
                    "tvl": "293170014.5685352"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
tokenList Array Token list
> tokenFullName String Token full name
> token String Token name
> precision String Precision
> tokenContractAddress String Token contract address
> protocolType String Protocol type
> addressCount String Address count
> totalSupply String Total supply
> circulatingSupply String The total circulating supply of this token on all chains
> price String Price, the unit is USD
> website String Website
> totalMarketCap String The total market cap of this token on all chains
> issueDate String Issue Date
> transactionAmount24h String Transaction amount in the past 24 hours, the unit is USD, only for ERC-20 token
> tvl String Total value locked

Query token position list details

Get the list of positions of a token under a public chain, return only the address with a balance of top10000. The supported chains are ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, Base, Scroll, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/token/position-list

Consumption per query 1

Request Example

GET /api/v5/explorer/token/position-list?chainShortName=eth&tokenContractAddress=0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH.
tokenContractAddress String Yes Token Contract Address
holderAddress String No Holder address
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "circulatingSupply": "977631.04",
            "positionList": [
                {
                    "holderAddress": "0x0a3f6849f78076aefadf113f5bed87720274ddc0",
                    "amount": "165544.6846010534",
                    "valueUsd": "231029494.33741083165440853217918",
                    "positionChange24h": "-0.000030241911044021",
                    "rank": "1"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
circulatingSupply String Circulating Supply
positionList Array Position List
> holderAddress String Holder Address
> amount String Holding amount
> valueUsd String Value of positions, Unit: USD
> positionChange24h String 24 hour position changes
> rank String Position ranking

Query token position statistics

Get the holding addresses' total purchase amount, purchase quantity, holding cost, and unrealized profit of a specific token on a particular public blockchain. The interface only considers addresses that have purchased the token on a DEX and still hold the token at present. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, ETHW, FTM, OP, ARBITRUM, ZKSYNC, LINEA, POLYGON_ZKEVM, BASE, SCROLL, TRON, and the data is updated every hour.

HTTP Request

GET /api/v5/explorer/token/position-stats

Consumption per query 1

Request Example

GET /api/v5/explorer/token/position-stats?chainShortName=eth&tokenContractAddress=0xdac17f958d2ee523a2206206994597c13d831ec7&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH.
tokenContractAddress String Yes Token contract address
holderAddress String No Holder address
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "500",
            "positionList": [
                {
                    "holderAddress": "0xcee284f754e854890e311e3280b767f80797180d",
                    "amount": "1432683907.127544",
                    "totalTxnAmount": "949071.1488562819",
                    "totalTxnQuantity": "948975.819459",
                    "holdingCost": "1.000100455033023",
                    "unrealizedProfit": "-244208.182700946177592885512"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
positionList Array Position list
> holderAddress String Holder address
> amount String Holding amount
> totalTxnAmount String Total transaction amount in USD for purchases on DEX by the address
> totalTxnQuantity String Total quantity of the token purchased on DEX by the address
> holdingCost String Holding cost of the address, calculated as totalTxnAmount / totalTxnQuantity. Unit: USD
> unrealizedProfit String Unrealized profit of the token held by the address, calculated as (current token price - position cost) * holding amount

Query token transfer details

Get details of a specified token transfer from a specified chain. The supported chains are ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

HTTP Request

GET /api/v5/explorer/token/transaction-list

Consumption per query 1

Request Example

GET /api/v5/explorer/token/transaction-list?chainShortName=eth&tokenContractAddress=0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
tokenContractAddress String Yes Token contract address
maxAmount String No Transaction quantity range, maximum amount
minAmount String No Transaction quantity range, minimum amount
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "totalTransfer": "2005176",
            "transactionList": [
                {
                    "txid": "0x784c42f0dee87a0e83ed29d69df6ab2af0a13792f2c266a4fe3f6f2b1f4c59ae",
                    "blockHash": "0x907077f5157ee31a5665f37f5589170fad2450857fea8d5d99a91ed02f908f1d",
                    "height": "18377320",
                    "transactionTime": "1697633099000",
                    "from": "0xaafb85ad4a412dd8adc49611496a7695a22f4aeb",
                    "to": "0x7913005b548839da13765020ddb9bf74a151b327",
                    "isToContract": false,
                    "isFromContract": true,
                    "amount": "0",
                    "transactionSymbol": "MKR",
                    "methodId": "0x8a179be4",
                    "tokenContractAddress": "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2",
                    "protocolType": "ERC20",
                    "state": "success",
                    "tokenId": ""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
totalTransfer String Total transfer
transactionList Array Transaction List
> txid String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> to String Token arrival address
> from String Token transfer out address
> isFromContract Bol Is the transfer out token address a contract address
> isToContract Bol Is the receiving token address a contract address
> amount String Transaction amount
> transactionSymbol String Token symbol of the transaction
> methodId String Method id
> tokenContractAddress String Token Contract Address
> protocolType String Protocol Type
> state String Status
success
fail
pending
> tokenId String NFT token ID for 721 and 1155 tokens

Batch query token transaction

Batch query transactions of up to 20 contracts' tokens, with a maximum search of 10,000 blocks. The supported chains are LTC, ETH, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, TRON, BASE, SCROLL, OMEGA, OPBNB, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/token/token-transaction-list-multi

Request Example

GET /api/v5/explorer/token/token-transaction-list-multi?chainShortName=eth&tokenContractAddress=0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2&endBlockHeight=17925814&startBlockHeight=17916100&limit=1

Request Parameters

Parameter Name Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Query via GET /api/v5/explorer/blockchain/summary.
tokenContractAddress String Yes Token contract address, can input up to 20 addresses, separated by ','.
startBlockHeight String Yes Starting block number for the search.
endBlockHeight String Yes Ending block number for the search.
page String No Page number.
limit String No Number of items to return per page. Defaults to a minimum of 20 and a maximum of 100.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "712",
            "transactionList": [
                {
                    "txId": "0x3512b39be2705de69c45b94d08068dd9ff8d932b8cf163650e97154136dca9b3",
                    "blockHash": "0x7a6dc63e2f04cc40013f4359771038fbaebe9895568c93df122eb0c1aa2f0b32",
                    "height": "17925812",
                    "transactionTime": "1692169811000",
                    "from": "0x2e52f794dec462be6a05c7291b5d80326f953668",
                    "to": "0x5bea21c54bbb549c1c5fc3e451955878ed152dac",
                    "isFromContract": false,
                    "isToContract": false,
                    "amount": "0.9971",
                    "tokenId": "",
                    "symbol": "MKR",
                    "tokenContractAddress": "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Name Type Description
page String The page number
limit String Number of cases returned per page,a default minimum of 20 to a maximum of 100
totalPage String Total number of pages
transactionList Array List of transactions
> txId String Transaction hash
> blockHash String Block hash
> height String The integer block number where the transaction occurred
> transactionTime String Transaction time, in Unix timestamp format with milliseconds, e.g., 1597026383085.
> from String Sender's address, multiple addresses separated by ,
> to String Receiver's address, multiple addresses separated by ,
> isFromContract Bol Indicates if the sender's address is a contract address
> isToContract Bol Indicates if the receiver's address is a contract address
> amount String Token amount
> tokenId String NFT token ID, applicable for 721 and 1155 tokens
> symbol String Cryptocurrency symbol corresponding to the amount
> tokenContractAddress String Token contract address

Query token supply history

The API can be used to query historical supply of a token at specified block heights across various supported blockchains, including ETH, POLYGON, POLYGON_ZKEVM.

5 API calls per query

HTTP request

GET /api/v5/explorer/token/supply-history

Request Example

GET /api/v5/explorer/token/supply-history?chainShortName=polygon_zkevm&tokenContractAddress=0x1e4a5963abfd975d8c9021ce480b42188849d41d&height=946117

Request parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
tokenContractAddress String Yes The token contract address
height String Yes The block height

Response parameters

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "supply": "2495333.838249"
        }
    ]
}

返回参数

Parameter Type Description
supply String The token supply at this block height

Log

Query log data by block and address, address and topic, address, and transaction.

Query log by block and address

Query the transaction event logs by block height and address, only returns nearly 1000 results. The supported chains are ETH, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 1

HTTP Request

GET /api/v5/explorer/log/by-block-and-address

Request Example

GET /api/v5/explorer/log/by-block-and-address?chainShortName=ETH&startBlockHeight=18827085&endBlockHeight=18827085&address=0xa2e3356610840701bdf5611a53974510ae27e2e1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
startBlockHeight String Yes The start block height for the search
endBlockHeight String Yes The end block height for the search
address String Yes The smart contract address that triggered the event log

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "height": "18827085",
            "address": "0xa2e3356610840701bdf5611a53974510ae27e2e1",
            "topics": [
                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "0x00000000000000000000000000000000003b3cc22af3ae1eac0440bcee416b40",
                "0x000000000000000000000000402b2bceb1415f48b413752cc0e27d76ff34ddeb"
            ],
            "data": "0x00000000000000000000000000000000000000000000000a8f4e545c96c74dfd",
            "methodId": "0x04b7962c",
            "blockHash": "0xdbeab8d3ffb13f4dd738940388349c7cbf062d98da40f90066d9d59d794a9bff",
            "transactionTime": "1703074871000",
            "logIndex": "10",
            "txId": "0xda476a00e3a22360ef8fdd1be6cfe9da1b97dc0af086ce9229ffefa24fae31d9"
        }
    ]
}

Response Parameters

Parameter Type Description
height String Block height
address String The smart contract address that triggered the event log
topics Array The topics of the event log
data String The non-indexed parameter of the event
blockHash String Block hash
methodId String Method id
transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
logIndex String The location index of the event log in the block
txId String Transaction hash

Query log by address and topic

Query the transaction event logs by address and topic0, only returns nearly 1000 results. The supported chains are ETH, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 1

HTTP Request

GET /api/v5/explorer/log/by-address-and-topic

Request Example

GET /api/v5/explorer/log/by-address-and-topic?chainShortName=ETH&address=0xa2e3356610840701bdf5611a53974510ae27e2e1&topic0=0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes The smart contract address that triggered the event log
topic0 String Yes The topic0 of the event log

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "height": "18827085",
            "address": "0xa2e3356610840701bdf5611a53974510ae27e2e1",
            "topics": [
                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "0x00000000000000000000000000000000003b3cc22af3ae1eac0440bcee416b40",
                "0x000000000000000000000000402b2bceb1415f48b413752cc0e27d76ff34ddeb"
            ],
            "data": "0x00000000000000000000000000000000000000000000000a8f4e545c96c74dfd",
            "methodId": "0x04b7962c",
            "blockHash": "0xdbeab8d3ffb13f4dd738940388349c7cbf062d98da40f90066d9d59d794a9bff",
            "transactionTime": "1703074871000",
            "logIndex": "10",
            "txId": "0xda476a00e3a22360ef8fdd1be6cfe9da1b97dc0af086ce9229ffefa24fae31d9"
        }
    ]
}

Response Parameters

Parameter Type Description
height String Block height
address String The smart contract address that triggered the event log
topics Array The topics of the event log
data String The non-indexed parameter of the event
blockHash String Block hash
methodId String Method id
transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
logIndex String The location index of the event log in the block
txId String Transaction hash

Query log by address

Query the transaction event logs by address, only returns nearly 1000 results. The supported chains are ETH, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 1

HTTP Request

GET /api/v5/explorer/log/by-address

Request Example

GET /api/v5/explorer/log/by-address?chainShortName=ETH&address=0xa2e3356610840701bdf5611a53974510ae27e2e1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes The smart contract address that triggered the event log

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "height": "18827085",
            "address": "0xa2e3356610840701bdf5611a53974510ae27e2e1",
            "topics": [
                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "0x00000000000000000000000000000000003b3cc22af3ae1eac0440bcee416b40",
                "0x000000000000000000000000402b2bceb1415f48b413752cc0e27d76ff34ddeb"
            ],
            "data": "0x00000000000000000000000000000000000000000000000a8f4e545c96c74dfd",
            "methodId": "0x04b7962c",
            "blockHash": "0xdbeab8d3ffb13f4dd738940388349c7cbf062d98da40f90066d9d59d794a9bff",
            "transactionTime": "1703074871000",
            "logIndex": "10",
            "txId": "0xda476a00e3a22360ef8fdd1be6cfe9da1b97dc0af086ce9229ffefa24fae31d9"
        }
    ]
}

Response Parameters

Parameter Type Description
height String Block height
address String The smart contract address that triggered the event log
topics Array The topics of the event log
data String The non-indexed parameter of the event
blockHash String Block hash
methodId String Method id
transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
logIndex String The location index of the event log in the block
txId String Transaction hash

Query log by transaction

Query the transaction event logs by transaction hash, only returns nearly 1000 results. The supported chains are ETH, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, BASE, SCROLL, MANTA, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 1

HTTP Request

GET /api/v5/explorer/log/by-transaction

Request Example

GET /api/v5/explorer/log/by-transaction?chainShortName=ETH&txId=0x74e2d0404b073d043d5c9aac574fe6b354ca92c43bebfdb169e5136f4ff4393e

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
txId String Yes Transaction hash

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "height": "18827085",
            "address": "0xa2e3356610840701bdf5611a53974510ae27e2e1",
            "topics": [
                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "0x00000000000000000000000000000000003b3cc22af3ae1eac0440bcee416b40",
                "0x000000000000000000000000402b2bceb1415f48b413752cc0e27d76ff34ddeb"
            ],
            "data": "0x00000000000000000000000000000000000000000000000a8f4e545c96c74dfd",
            "methodId": "0x04b7962c",
            "blockHash": "0xdbeab8d3ffb13f4dd738940388349c7cbf062d98da40f90066d9d59d794a9bff",
            "transactionTime": "1703074871000",
            "logIndex": "10",
            "txId": "0xda476a00e3a22360ef8fdd1be6cfe9da1b97dc0af086ce9229ffefa24fae31d9"
        }
    ]
}

Response Parameters

Parameter Type Description
height String Block height
address String The smart contract address that triggered the event log
topics Array The topics of the event log
data String The non-indexed parameter of the event
blockHash String Block hash
methodId String Method id
transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
logIndex String The location index of the event log in the block
txId String Transaction hash

Stats

Access on-chain data, block information, and gas statistics across a wide range of public chains, including access to comprehensive historical data.

Query blockchain stats

The API can be used to query daily new addresses, overall transactions, contract calls, transaction fees, and network utilization across various supported blockchains, including ETH, POLYGON, POLYGON_ZKEVM, BSC, AVAXC, FTM, ARBITRUM, OP, BASE, TRON, X1_TEST, BTC.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/blockchain/stats

Request Example

GET /api/v5/explorer/blockchain/stats?chainShortName=eth

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
startTime String No The Unix timestamp marking the start of data querying, in milliseconds format e.g., 1597026383085
endTime String No The Unix timestamp marking the end of data querying, in milliseconds format e.g., 1597026383085
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "3110",
            "statsHistoryList": [
                {
                    "time": "1706832000000",
                    "newAddressCount": "104106",
                    "totalTransactionCount": "1108185",
                    "totalContractCalls": "5065734",
                    "transactionFee": "2657.1239669484817",
                    "networkUtilization": "0.5048832665557917"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The number of results returned per page
totalPage String Total number of pages
statsHistoryList Array List of historical statistical data
> time String Date, unix timestamp format in milliseconds, e.g. 1597026383085
> newAddressCount String The daily number of new addresses
> totalTransactionCount String Total transaction count
> totalContractCalls String The total number of contract calls on the blockchain per day
> transactionFee String The total transaction fee paid to validators per day, measured in the chain's native token
> networkUtilization String Daily network utilization rate, calculated based on the daily total gas consumption divided by the daily total gas limit

Query block stats

Query information such as daily number of blocks produced, block size, mining rewards, and average block interval across a range of supported blockchains, including ETH, POLYGON, POLYGON_ZKEVM, BSC, AVAXC, FTM, ARBITRUM, OP, BASE, TRON, X1_TEST, BTC.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/block/block-stats

Request Example

GET /api/v5/explorer/block/block-stats?chainShortName=eth

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
startTime String No The Unix timestamp marking the start of data querying, in milliseconds format e.g., 1597026383085
endTime String No The Unix timestamp marking the end of data querying, in milliseconds format e.g., 1597026383085
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "3110",
            "blockHistoryList": [
                {
                    "time": "1706832000000",
                    "blockCount": "7132",
                    "blockSize": "149949.05300056085",
                    "mineReward": "489.8858503788926",
                    "rewardSymbol": "ETH",
                    "avgBlockInterval": "12.114413909141895"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The number of results returned per page
totalPage String Total number of pages
blockHistoryList Array List of historical block data
> time String Date, unix timestamp format in milliseconds, e.g. 1597026383085
> blockCount String The total number of blocks produced per day
> blockSize String The daily average block size, measured in bytes
> mineReward String The total block rewards received per day
> rewardSymbol String The crypto type for the block reward
> avgBlockInterval String The daily average block production time, measured in seconds

Query gas stats

Retrieve information such as daily average gas limit, total gas consumption, average gas price, and maximum/minimum gas prices for supported blockchains, including ETH, POLYGON, POLYGON_ZKEVM, BSC, AVAXC, FTM, ARBITRUM, OP, BASE, X1_TEST.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/block/block-stats

Request Example

GET /api/v5/explorer/gas/stats?chainShortName=eth

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
startTime String No The Unix timestamp marking the start of data querying, in milliseconds format e.g., 1597026383085
endTime String No The Unix timestamp marking the end of data querying, in milliseconds format e.g., 1597026383085
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "3110",
            "gasHistoryList": [
                {
                    "time": "1706832000000",
                    "avgGasLimit": "29999675",
                    "totalGasUsed": "103886992668",
                    "avgGasPrice": "24498721911",
                    "maxGasPrice": "21010266430914",
                    "minGasPrice": "11688300977"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The number of results returned per page
totalPage String Total number of pages
gasHistoryList Array List of historical gas data
> time String Date, unix timestamp format in milliseconds, e.g. 1597026383085
> avgGasLimit String The daily average gas limit across all blocks
> totalGasUsed String The total gas consumption per day
> avgGasPrice String The daily average gas price, measured in wei
> maxGasPrice String The daily maximum gas price, measured in wei
> minGasPrice String The daily minimum gas price, measured in wei

UTXO

These endpoints from this module retrieve UTXO chain data and BRC20 data. The UTXO chains include BTC, BCH, LTC, DASH, and DOGE.

Query address UTXO transaction

Get UTXO transaction information on an address, only for chains with UTXO models including BTC, BCH, LTC, DASH, DOGE.

HTTP Request

GET /api/v5/explorer/address/unspent

Consumption per query 1

Request Example

GET /api/v5/explorer/address/unspent?chainShortName=btc&address=bc1ql49ydapnjafl5t2cp9zqpjwe6pdgmxy98859v2

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
address String Yes Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Bitcoin",
            "chainShortName": "BTC",
            "txId": "26270302d90b41ee6a7ac4521d520eb27ee7471cc946a229a07f2dd2c1a610dc",
            "height": "812718",
            "amount": "0.00011918",
            "address": "bc1ql49ydapnjafl5t2cp9zqpjwe6pdgmxy98859v2",
            "confirm": "",
            "index": "1831",
            "transactionIndex": "",
            "balance": "118300.20301158",
            "symbol": "BTC",
            "unspent": ""
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
txid String Transaction hash
height String Block height
amount String Number of transactions
address String Address
unspent String Unspent transaction output
confirm String Confirm
index String The position index of the transaction in the block
transactionIndex String The positional index of the UTXO in the transaction
balance String Address balance
symbol String Token symbol

Query address remaining UTXO

Get a breakdown of each UTXO remaining at the address, only for chains with UTXO models including BTC, BCH, LTC, DASH, DOGE.

HTTP Request

GET /api/v5/explorer/address/utxo

Consumption per query 1

Request Example

GET /api/v5/explorer/address/utxo?chainShortName=btc&address=bc1ql49ydapnjafl5t2cp9zqpjwe6pdgmxy98859v2&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g, BTC, ETH. Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
address String Yes Address
page String No Page
limit String No Number of results per request. The maximum is 100. The default is 50.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "172",
            "utxoList": [
                {
                    "txid": "d11638ea2cf68c4b49c1d97ef681a9e7e4658ba6cb7290dd73d476db371b9037",
                    "height": "796599",
                    "blockTime": "1688150365",
                    "address": "bc1ql49ydapnjafl5t2cp9zqpjwe6pdgmxy98859v2",
                    "unspentAmount": "0.0003",
                    "index": "0"
                }
            ]
        }
    ]
}

Response Parameters

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
utxoList Array Remaining UTXO list
> txid String Transaction hash
> height String Block height
> blockTime String Block time
> address String Address
> unspentAmount String Unspent transaction output
> index String The position index of the transaction in the block

BRC20

These endpoints from this module retrieve BRC20 data such as token lists, token inscriptions, token details, and token balance.

Query inscriptions list

Get the list of inscriptions for the BTC chain

HTTP Request

GET /api/v5/explorer/btc/inscriptions-list

Consumption per query 1

Request Example

GET /api/v5/explorer/btc/inscriptions-list

Request Parameters

Parameter Type Required Description
token String No Token name, tick
inscriptionId String No Inscription ID
inscriptionNumber String No Inscription Number
state String No State
success, fail. Default returns success
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "totalInscription": "31126135",
            "inscriptionsList": [
                {
                    "inscriptionId": "92780ef845a5190a1027724c24b5adbe6713abdaa43c5f273ff8a87d41f6cc8ci0",
                    "inscriptionNumber": "9999999",
                    "location": "92780ef845a5190a1027724c24b5adbe6713abdaa43c5f273ff8a87d41f6cc8c:0:0",
                    "token": "10MM",
                    "state": "success",
                    "msg": "",
                    "tokenType": "BRC20",
                    "actionType": "mint",
                    "logoUrl": "",
                    "ownerAddress": "bc1p53rrfs7l3fdyd60wzsk9gphnjm6y9hr4vhfrp207tsltyxjatfqqj9ly8k",
                    "txId": "92780ef845a5190a1027724c24b5adbe6713abdaa43c5f273ff8a87d41f6cc8c",
                    "blockHeight": "792013",
                    "contentSize": "",
                    "time": "1685401405000"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
totalInscription String Total number of inscriptions
inscriptionsList Array Inscriptions list
> inscriptionId String Inscription id
> inscriptionNumber String Inscription number
> token String Token name, tick
> state String State, success, fail
> msg String Transaction prompt: Error message for failures, and other messages for prompts
> tokenType String Token type, BRC20
> actionType String Action Type; deploy, mint, inscribeTransfer, transfer
> logoUrl String Logo URL
> ownerAddress String Address of the owner of the inscription
> txId String Latest transaction hash
> location String Location, in the format txid: out: offset
> blockHeight String Block height
> contentSize String The size of the stored information. Unit: Bytes
> time String Inscription creation time

Query token list

Get a list of BRC20 tokens for the BTC chain

HTTP Request

GET /api/v5/explorer/btc/token-list

Consumption per query 1

Request Example

GET /api/v5/explorer/btc/token-list

Request Parameters

Parameter Type Required Description
token String No Token name, tick
orderBy String No deployTimeAsc: Return in ascending order of deployTime, from far to near
deployTimeDesc: Return in descending order of deployTime, from near to far
The default is deployTimeAsc
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "tokenList": [
                {
                    "token": "ordi",
                    "deployTime": "1678248991000",
                    "inscriptionId": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0",
                    "inscriptionNumber": "348020",
                    "totalSupply": "21000000",
                    "mintAmount": "21000000",
                    "transactionCount": "484169",
                    "holder": "13080",
                    "mintRate": "1"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
> token String Token name, tick
> deployTime String Deploy Time
> inscriptionId String Inscription id
> inscriptionNumber String Inscription number
> totalSupply String Total supply
> mintAmount String Mint amount
> transactionCount String Number of transactions
> holder String THe number of holders
> mintRate String Mint ratio, displayed as a decimal, e.g. 0.9543; retains four decimal places

Query token details

Get token details, including number of holder addresses, number of minted, etc.

HTTP Request

GET /api/v5/explorer/btc/token-details

Consumption per query 1

Request Example

GET /api/v5/explorer/btc/token-details?token=sats

Request Parameters

Parameter Type Required Description
token String Yes Tick

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "token": "sats",
            "precision": "18",
            "totalSupply": "2100000000000000",
            "mintAmount": "2100000000000000",
            "limitPerMint": "100000000",
            "holder": "35825",
            "deployAddress": "bc1prtawdt82wfgrujx6d0heu0smxt4yykq440t447wan88csf3mc7csm3ulcn",
            "logoUrl": "https://static.oklink.com/cdn/web3/currency/token/btc-sats-9b664bdd6f5ed80d8d88957b63364c41f3ad4efb8eee11366aa16435974d9333i0.png/type=png_350_0",
            "txId": "9b664bdd6f5ed80d8d88957b63364c41f3ad4efb8eee11366aa16435974d9333",
            "inscriptionId": "9b664bdd6f5ed80d8d88957b63364c41f3ad4efb8eee11366aa16435974d9333i0",
            "deployHeight": "779971",
            "deployTime": "1678339934000",
            "inscriptionNumber": "357097",
            "state": "success",
            "tokenType": "BRC20",
            "msg": ""
        }
    ]
}

Response Parameters

Parameter Type Description
token String Token name, tick
precision String Precision
totalSupply String Total supply
mintAmount String Mint amount
limitPerMint String Maximum number of casts per time
holder String Number of token addresses held
deployAddress String Deploy address
logoUrl String Logo url
txId String Transaction hash
inscriptionId String Inscription id
deployHeight String Deployment block height
deployTime String Deploy time
inscriptionNumber String Inscription number
state String State: success、fail
tokenType String Token type, BRC20
msg String Msg

Query token position Address List

Get a list of token holding addresses and view token distribution details.

HTTP Request

GET /api/v5/explorer/btc/position-list

Consumption per query 1

Request Example

GET /api/v5/explorer/btc/position-list?token=sats&limit=2

Request Parameters

Parameter Type Required Description
token String Yes Token name, tick
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "2",
            "totalPage": "5000",
            "positionList": [
                {
                    "holderAddress": "bc1plff0sqm6ym55eak9vjljghd55h7hkheg22c84w55w646l857elqsfzmfdv",
                    "amount": "31740686608926",
                    "rank": "1"
                },
                {
                    "holderAddress": "bc1pun3whtlzac75f2vcznxmpfc09dnzyp0luw8tpfwc7wrruwav30pqsu6l9u",
                    "amount": "22651199774504",
                    "rank": "2"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
positionList Array List of addresses for token positions
> holderAddress String Holder address
> amount String Holding amount
> rank String Holding rank

Query token transfer list

Query transfer list by address, transaction hash, block height. No data on pending transactions.

HTTP Request

GET /api/v5/explorer/btc/transaction-list

Consumption per query 1

Request Example

GET /api/v5/explorer/btc/transaction-list

Request Parameters

Parameter Type Required Description
address String No BTC Address
token String No Token name, tick
inscriptionNumber String No Inscription number
actionType String No Action type:deploy, mint、inscribeTransfer、transfer
toAddress String No Sender BTC address
fromAddress String No Receiver BTC address
txId String No Transaction hash
blockHeight String No Block height
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "totalTransaction": "31124061",
            "inscriptionsList": [
                {
                    "txId": "af6bb18c64c57296ae07b8f4b1857c655160402a8d332fdb523915d7887476e2",
                    "blockHeight": "812873",
                    "state": "fail",
                    "tokenType": "BRC20",
                    "actionType": "mint",
                    "fromAddress": "",
                    "toAddress": "bc1qx2l6pzt7aknazsgdnvf5vnhp8ezx38ykg2wvfz",
                    "amount": "",
                    "token": "$ORC",
                    "inscriptionId": "af6bb18c64c57296ae07b8f4b1857c655160402a8d332fdb523915d7887476e2i0",
                    "inscriptionNumber": "35346117",
                    "index": "0",
                    "location": "af6bb18c64c57296ae07b8f4b1857c655160402a8d332fdb523915d7887476e2:0:0",
                    "msg": "tick: $ORC has been minted",
                    "time": "1697695573000"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
totalTransaction String Total number of transactions
transactionList Array Transaction list
> txid String Transaction hash
> blockHeight String Block height
> state String State: success, fail
> tokenType String Token Type, BRC20
> actionType String Action Type:deploy, mint, inscribeTransfer, transfer
> fromAddress String Sender BTC address
> toAddress String Receiver BTC address
> amount String Transaction amount
> index String The index of vout. When the type is coinbase, this field has no numerical value
> location String Location, in the format txid: out: offset; When the type is coinbase, this field has no numerical value
> token String Token name, tick
> inscriptionId String Inscription id
> inscriptionNumber String Inscription number
> msg String Transaction prompt: Error message for failures, and other messages for prompts
> time String Transaction time

Query address balance list

Query the balance of BRC20 tokens held by BTC address, transferable balance, available balance.

HTTP Request

GET /api/v5/explorer/btc/address-balance-list

Consumption per query 1

Request Example

GET /api/v5/explorer/btc/address-balance-list?address=bc1ph0057nc25ka94z8ydg43j8tnnp38u3hxpadutnt4n3jyfrmjzmcqw99mk2

Request Parameters

Parameter Type Required Description
address String Yes BTC Chain Address
token String No Token name, tick
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "12",
            "balanceList": [
                {
                    "token": "sats",
                    "tokenType": "BRC20",
                    "balance": "1350000000000",
                    "availableBalance": "1350000000000",
                    "transferBalance": "0"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
balanceList Array List of token balances held by BTC address
> token String Token name, tick
> tokenType String Token type, BRC20
> balance String Token balance
> availableBalance String Available balance
> transferBalance String Transfer balance

Query address balance details

Query the detailed list of the transferable balance of a token at an address.

HTTP Request

GET /api/v5/explorer/btc/address-balance-details

Consumption per query 1

Request Example

GET /api/v5/explorer/btc/address-balance-details?address=bc1ph0057nc25ka94z8ydg43j8tnnp38u3hxpadutnt4n3jyfrmjzmcqw99mk2&token=meme

Request Parameters

Parameter Type Required Description
address String Yes BTC chain address
token String Yes Token name, tick
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "6",
            "token": "meme",
            "tokenType": "BRC20",
            "balance": "18",
            "availableBalance": "0",
            "transferBalance": "18",
            "transferBalanceList": [
                {
                    "inscriptionId": "a1002519472f9a1d45db5a3df30ea521ecd5425e546a63a79f3a4a9ff4e6e582i0",
                    "inscriptionNumber": "4615101",
                    "amount": "3"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
token String Token name, tick
tokenType String Token type, BRC20
balance String Token balance
availableBalance String Available balance
transferBalance String Transfer balance
transferBalanceList Array Transfer balance list
> inscriptionId String Inscription id
> inscriptionNumber String Inscription Number
> amount String Token amount

EVM

These endpoints from this module retrieve data on ETH deflation, beacon chain data, StarkNet data, and more.

ETH Deflation

These endpoints from this module retrieve ETH data such as circulating supply, staking and gas consumption.

Query the ETH supply change overview

Check the latest deflation data overview of ETH

HTTP Request

GET /api/v5/explorer/deflation/supply

Consumption per query 5

Request Example

GET /api/v5/explorer/deflation/supply

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "circulatingSupply": "120404650.2518",
            "totalBurnt": "3640484.712",
            "inflationRate": "0.004",
            "stakingAmount": "30739208",
            "stakingApy": "0.027"
        }
    ]
}

Response Parameters

Parameter Type Description
circulatingSupply String Circulation supply of ETH
totalBurnt String Total amount of ETH burned
stakingApy String Annual percentage yield for staking ETH
stakingAmount String Total staking amount of ETH
inflationRate String Current annual inflation rate, displayed as a decimal, example: 0.1 = 10%

Query the ETH supply and burn

Historical data on the daily supply and destruction of Eth through this interface.

HTTP Request

GET /api/v5/explorer/deflation/supply-burn

Consumption per query 5

Request Example

GET /api/v5/explorer/deflation/supply-burn

Request Parameters

Parameter Type Required Description
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "2246",
            "inflationHistoryList": [
                {
                    "supply": "2328.5755",
                    "burnt": "992.0577",
                    "netInflation": "1336.5177",
                    "circulatingSupply": "120404650.2518",
                    "inflationRate": "0.004",
                    "time": "1697558400000"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
inflationHistoryList Array Inflation history list
> circulatingSupply String Eth circulating supply
> burnt String Daily amount of ETH burnt
> netInflation String Daily net inflation of ETH quantity, positive value indicates an increase, negative value indicates a decrease
> supply String Daily amount of ETH supplied
> inflationRate String Current annualized inflation rate of ETH, displayed as a decimal, example: 0.1 = 10%
> time String Update time. Unix timestamp format in milliseconds, e.g. 1597026383085

Query the ETH staking

Get ETH pledge history details

HTTP Request

GET /api/v5/explorer/deflation/pos-staking

Consumption per query 5

Request Example

GET /api/v5/explorer/deflation/pos-staking

Request Parameters

Parameter Type Required Description
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "1052",
            "stakingHistoryList": [
                {
                    "time": "1697558400000",
                    "totalValidator": "979417",
                    "totalStaked": "30739208",
                    "stakingRatio": "0.2588",
                    "validatorDailyIncome": "2328.5755",
                    "apy": "0.027",
                    "nonEip1559Fee": "58.5716",
                    "baseRewards": "992.0577",
                    "priorityFee": "294.1105"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
stakingHistoryList Array ETH staking history list
> apy String Annual percentage yield
> baseRewards String Base rewards
> priorityFee String Priority fee
> totalStaked String Total amount of ETH staked
> stakingRatio String ETH staking ratio
> nonEip1559Fee String Non eip1559 fee
> totalValidator String Total number of validators
> validatorDailyIncome String Validator daily income
> time String Update time. Unix timestamp format in milliseconds, e.g. 1597026383085

Query the gas consumption

Get ETH historical gas data through this interface

HTTP Request

GET /api/v5/explorer/deflation/gas

Consumption per query 5

Request Example

GET /api/v5/explorer/deflation/gas

Request Parameters

Parameter Type Required Description
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "805",
            "gasHistoryList": [
                {
                    "nonEip1559Fee": "58.5716",
                    "eip1559BaseFee": "992.0577",
                    "eip1559Tip": "294.1105",
                    "totalTransactionCount": "994388",
                    "maxGasPrice": "101",
                    "minGasPrice": "4.7883",
                    "avgGasPrice": "9.9651",
                    "time": "1697558400000"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
gasHistoryList Array Gas historical data
> avgGasPrice String Avg gas price
> maxGasPrice String Max gas price
> minGasPrice String Min gas price
> eip1559BaseFee String Eip1559 base fee
> eip1559Tip String Eip1559 tip
> totalTransactionCount String Total number of transactions
> nonEip1559Fee String Non eip1559 fee
> time String Update time. Unix timestamp format in milliseconds, e.g. 1597026383085

Beacon

The Beacon data module supports querying data related to withdrawals and staking on the beacon chain.

Beacon chain basic information

Retrieve the basic information of the beacon chain, including an overview of the validators and staking data.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/beacon/beacon-summary

Sample Request

GET /api/v5/explorer/beacon/beacon-summary

Response Sample

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Beacon Chain",
            "chainShortName": "BEACON",
            "issueDate": "1606824023000",
            "consensus": "PoS",
            "finalizedEpoch": "236649",
            "finalizedSlot": "7572768",
            "lastCheckpoint": "7572833",
            "validators": {
                "totalValidators": "980088",
                "newTotalValidators": "1808",
                "activeValidators": "862463",
                "newActiveValidators": "-1473",
                "pendingValidators": "696",
                "newPendingValidators": "620",
                "exitedValidators": "3749",
                "newExitedValidators": "1234",
                "totalValidatorIncome": "1498841.462357212"
            },
            "staking": {
                "totalDeposits": "31414348",
                "newTotalDeposits": "37458",
                "beaconDepositsReceived": "31433146",
                "newBeaconDepositsReceived": "57143",
                "depositAddresses": "981304",
                "newDepositAddresses": "1157",
                "beaconDepositsPubKeys": "980093",
                "newBeaconDepositsPubKeys": "1808",
                "votedStakes": "27538741",
                "effectiveStakes": "27598587"
            }
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g., Beacon Chain
chainShortName String Chain short name, e.g., BEACON
issueDate String Issue date
consensus String Consensus algorithm, e.g., PoS
finalizedEpoch String Final epoch
finalizedSlot String Final slot
lastCheckpoint String Latest checkpoint slot
validators Array Validator overview
> totalValidators String Total number of validators
> newTotalValidators String Number of new validators, positive for increase, negative for decrease
> activeValidators String Number of active validators
> newActiveValidators String Number of new active validators, positive for increase, negative for decrease
> pendingValidators String Number of validators pending review
> newPendingValidators String Number of new validators pending review, positive for increase, negative for decrease
> exitedValidators String Number of validators that have exited
> newExitedValidators String Number of new exited validators, positive for increase, negative for decrease
> totalValidatorIncome String Cumulative income of validators
staking Array Staking overview
> totalDeposits String Number of ETH staked on the ETH1.0 chain
> newTotalDeposits String New amount of ETH staked on the ETH1.0 chain, positive for increase, negative for decrease
> beaconDepositsReceived String Total staked amount received by the beacon chain
> newBeaconDepositsReceived String New staked amount received by the beacon chain, positive for increase, negative for decrease
> depositAddresses String Address list for ETH staked on the ETH1.0 chain
> newDepositAddresses String New addresses for ETH staked on the ETH1.0 chain, positive for increase, negative for decrease
> beaconDepositsPubKeys String Number of public keys for staking on the beacon chain
> newBeaconDepositsPubKeys String Number of new public keys for staking on the beacon chain, positive for increase, negative for decrease
> votedStakes String Active staked amount, valid ETH staked on the beacon chain for voting or block production, updated every hour
> effectiveStakes String Effective staked amount, ETH deposits visible and accepted by beacon chain nodes, updated every hour

Beacon chain slot list

Retrieve the validator details of the Beacon Chain.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/beacon/beacon-slot-list

Request Example

GET /api/v5/explorer/beacon/beacon-slot-list

Request Parameters

Parameter Type Required Description
slot String no Slot number, if none are filled in, default to slot order, with the latest at the top
epoch String no Epoch number
index String no Index of the validator
limit String no Number of results per request. The maximum is 100. The default is 20.
page String no Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "slotList": [
                {
                    "epoch": "236651",
                    "slot": "7572839",
                    "state": "proposed",
                    "index": "960171",
                    "time": "1697698091000",
                    "slotIndex": "8",
                    "attestationCount": "128",
                    "parentRoot": "0xab67fff2294a6a76e1dda77d0cc65dd183bd3574ff58ea4ffede84e4fc81fabd",
                    "root": "0xf8a24b30de4f066fcca8a423c619cff5c3217501cbc8e82f68a5934674bcbed4",
                    "signature": "0x8e103c3f3c8c9453d7c1aa89eed7b20808f78097ac4607db0877fee91db39126ff10e07d4dacfa34fb5adc9764fa3027064d1377ada3055074b2f1dc26c5bb4fc40e63bd080bf5ae39278908fd9ece292339108dd619ecc2fbf440c1939983c2",
                    "randaoReveal": "0x904c3f03c7ca03750168d362f57f7ea58d32ee57d7d8a53a035dddd37cb3790c94d3a5f332823f069116386750b788d3133e6aedc92354db0d865b1b6d42bb9f4068407cbee4a0a6276c379ba5e561b720a5edd67b01fd7ef5e7f1b63371d041",
                    "graffiti": "0x0000000000000000000000000000000000000000000000000000000000000000",
                    "voluntaryExitsCount": "0",
                    "attesterSlashingCount": "0",
                    "l1BlockHash": "0xe06cf95360ff87f350b2681a93d7220239a218da2edff3dca4732d72cd856446",
                    "l1DepositCount": "1011590",
                    "l1DepositRoot": "0xcc10e96d2ef785919c78bd249ff0af6d93c83919595f63b57ac101c9352ea905",
                    "pubkey": "0x80b3fae29e4ea97d81f97578453f44b2a30b54eb1c8e176c3c0b933a797510f123a70457301cb967f070e2ef173d51d3"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of data items on the current page
totalPage String Total number of pages
slotList Array List of slot
> epoch String Epoch to which the slot belongs
> slot String Slot number
> state String Status; proposed, skipped, forked
> index String Corresponding validator number
> pubkey String Public key of the corresponding validator
> time String Start time of this slot
> slotIndex String Position of the current slot in the epoch; slotIndex/32
> attestations String Verifications provided by the designated validator committee for the slot
> parentRoot String Root of the previous slot
> root String Root hash
> signature String Signature
> randaoReveal String Random number
> graffiti String Signature
> voluntaryExitsCount String Number of validator exits
> attestationCount String Verification count
> attesterSlashingCount String Number of penalties for validators
> l1BlockHash String ETH chain block height hash for this proposal
> l1DepositCount String Number of ETH staked
> l1DepositRoot String Root of the ETH stake

Beacon chain validator list query

Retrieve the validator list from the Beacon Chain, including active validators, validators pending for approval, and those who have exited. The data is updated every hour.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/beacon/beacon-validator-list

Sample Request

GET /api/v5/explorer/beacon/beacon-validator-list

Request Parameters

Parameter Type Required Description
type String No Types of validators:
Active: active
Pending: pending
Exited: exited
All: all
Defaults to All if not specified
limit String No Number of records returned. Default is the most recent 20 entries, with a maximum of 100.
page String No Page number

Sample Response

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "validatorList": [
                {
                    "index": "21958",
                    "pubkey": "0x91104f28e17de8c6bec26c5a8e64a149ba3ed2a35273197c33ed2f2bc74b8dbda96f9098517a6e946247c169c89deb34",
                    "holdingAmount": "68.7918",
                    "state": "online",
                    "totalIncome": "4.7918",
                    "proposals": "27",
                    "activationEpoch": "268",
                    "exitEpoch": "",
                    "withdrawalAmountEpoch": "",
                    "isSlashed": false
                }
            ]
        }
    ]
}

Response Parameters

Parameter Name Type Description
page String Current page number
limit String Number of records on the current page
totalPage String Total number of pages
validatorList Array List of validators
> index String Validator number
> pubkey String Validator's public key
> state String Validator's status - online: active in the last 2 Epochs, offline: inactive in the last 2 Epochs
> holdingAmount String Validator's balance in ETH
> totalIncome String Total income of the validator
> proposals String Number of blocks proposed
> activationEpoch String Epoch when the validator was activated; "0" for genesis block, "" if not activated
> exitEpoch String Epoch when the validator exited
> withdrawalAmountEpoch String Epoch when the balance was withdrawn
> isSlashed Bol Whether the validator was penalized; true for yes, false for no

Beacon chain validator details

Retrieve details of the validator on the beacon chain.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/beacon/beacon-validator-details

Sample Request

GET /api/v5/explorer/beacon/beacon-validator-details?index=21958

Request Parameters

Parameter Type Required Description
index String Choose one Validator index number
pubkey String Choose one Validator public key

Response Sample

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "index": "21958",
            "pubkey": "0x91104f28e17de8c6bec26c5a8e64a149ba3ed2a35273197c33ed2f2bc74b8dbda96f9098517a6e946247c169c89deb34",
            "type": "active",
            "beaconDepositsReceived": "64",
            "holdingAmount": "68.79185725",
            "totalIncome": "4.79185725",
            "effectiveStakes": "32",
            "address": "0x6282085170b2f3396fdccc2b5164fa70ee7c5192",
            "deposits": "64",
            "activationEpoch": "268",
            "exitEpoch": "",
            "eligibleEpoch": "41"
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of data items on the current page
totalPage String Total number of pages
validatorList Array List of validators
> index String Validator index number
> pubkey String Validator public key
> type String Types of validators:
Active: active
Pending: pending
Exited: exited
All: all
Defaults to All if not specified
> beaconDepositsReceived String Total staked amount received by the beacon chain
> holdingAmount String Validator balance in ETH
> totalIncome String Total income of the validator
> effectiveStakes String Effective staked amount, ETH deposits visible and accepted by beacon chain nodes, updated every hour
> address String Validator address
> deposits String ETH deposits
> activationEpoch String Epoch when the validator was activated; "0" for genesis block, "" if not activated
> exitEpoch String Epoch when the validator exited
> eligibleEpoch String Epoch when the validator was eligible

|

Staking record list of the Beacon chain

Retrieve the staking record data of the beacon chain.

HTTP Request

GET /api/v5/explorer/beacon/beacon-deposit-list

Consumption per query 1

Request Example

GET /api/v5/explorer/beacon/beacon-deposit-list?index=21958&limit=1

Request Parameters

Parameter Type Required Description
index String No Corresponding validator number.
pubkey String No Corresponding validator public key.
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "2",
            "depositList": [
                {
                    "epoch": "40",
                    "slot": "1293",
                    "state": "active",
                    "index": "21958",
                    "pubkey": "0x91104f28e17de8c6bec26c5a8e64a149ba3ed2a35273197c33ed2f2bc74b8dbda96f9098517a6e946247c169c89deb34",
                    "time": "1606839539000",
                    "beaconDepositsReceived": "32",
                    "withdrawalCredential": "0x00f2c769bafa58cd7e973c597e69d73f9cc6624296f5ff6bb3aa359cb3db5a04"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of records on the current page
totalPage String Total number of pages
depositList Array List of staking records
> epoch String Epoch to which the slot belongs
> slot String Slot number
> state String Validator status
deposited: Staking, user staked 32 or more ETH in the ETH 1.0 staking contract
pending: Waiting for confirmation. After Beacon receives the deposit, based on the total number of deposits, users have to wait in a queue for approval. Six validators are approved per epoch.
active: The user is activated and can serve as a validator to verify slots in the Beacon network.
exited: The user has exited. Either due to a previous violation or because they chose to exit (voluntarily), they cant continue verifying slots in the Beacon network.
> index String Corresponding validator number
> pubkey String Corresponding validator public key
> time String Time of staking
> beaconDepositsReceived String Total staked amount received by the beacon chain
> withdrawalCredential String Withdrawal certificate

Beacon chain withdrawal record query

Retrieve withdrawal record data from the Beacon Chain.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/beacon/beacon-withdrawal-list

Sample Request

GET /api/v5/explorer/beacon/beacon-withdrawal-list?index=535309&limit=1

Request Parameters

Parameter Name Type Required Description
index String No Corresponding validator number.
pubkey String No Corresponding validator's public key.
limit String No Number of records returned. Default is the last 20, up to 100.
page String No Page number.

Sample Response

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "35",
            "withdrawalList": [
                {
                    "epoch": "236653",
                    "slot": "7572896",
                    "state": "active",
                    "index": "535309",
                    "pubkey": "0xb54d8183c989e51259ba93695a0b4584fec1b839b8ffbbc9e1925c8aa68221fbbe036657a2b409d03b2f4df85bb1afa9",
                    "time": "1697698775000",
                    "beaconWithdrawalReceived": "0.01681278",
                    "address": "0xb9d7934878b5fb9610b3fe8a5e441e8fad7e293f",
                    "withdrawalCredential": "0x010000000000000000000000b9d7934878b5fb9610b3fe8a5e441e8fad7e293f"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Name Type Description
page String Current page number
limit String Number of records on the current page
totalPage String Total number of pages
withdrawalList Array List of staking records
> epoch String Epoch to which the slot belongs
> slot String Slot number
> state String Validator status:
deposited: Staked on the ETH1.0 staking contract with 32+ ETH

pending: Waiting for confirmation after Beacon received the deposit. Based on the total deposit amount, users need to queue for approval. Six validators are approved per epoch.

active: The user has been activated and can serve as a validator on the Beacon network to validate slots.

exited: The user has exited due to past violations or voluntary exit and cannot continue to validate slots on the Beacon network.
> index String Corresponding validator number
> pubkey String Corresponding validators public key
> time String Time of staking
> beaconWithdrawalReceived String Total withdrawal amount received by the beacon chain
> address String Validator address
> withdrawalCredential String Withdrawal credential

Beacon Chain Withdrawal Credentials Information

Get the basic information by withdrawal credentials on the beacon chain.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/beacon/beacon-withdrawal-credentials

Sample Request

GET /api/v5/explorer/beacon/beacon-withdrawal-credentials?withdrawalCredential=0x0100000000000000000000004f13d70f72292e699fbb420003caff2778c18f70

Request Parameters

Parameter Type Required Description
withdrawalCredentials String Yes Withdrawal credential.
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Sample

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "2324",
            "validatorList": [
                {
                    "index": "19782",
                    "pubkey": "0x8313ce1237ff07c6afed630608e339034e76a9a396ab146401ed34abb957a30079d5f2b4d126e8a8e3f1c5c415361ec3",
                    "activationEpoch": "0",
                    "balance": "32.00239377",
                    "effectiveBalance": "32.00239377",
                    "voteEpoch": "237771",
                    "exitEpoch": "",
                    "slashed": "false",
                    "proposal": "38",
                    "status": "active_ongoing",
                    "withdrawalCredential": "0x010000000000000000000000347a70cb4ff0297102dc549b044c41bd61e22718"
                }
            ]
        }
    ]
}

Return Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
validatorList Array ValidatorList
> index String Validator index number
> pubkey String Number of data items on the current page
> withdrawalCredential String Withdrawal credential.
> activationEpoch String Epoch when the validator was activated; "0" for genesis block, "" if not activated
> exitEpoch String Epoch when the validator exited
> balance String balance
> effectiveBalance String Effective balance
> voteEpoch String Vote epoch
> proposals String Number of blocks produced
> status String status
> slashed Bol Whether the validator was penalized: true for yes, false for no

StarkNet

These endpoints from this module retrieve transaction data and token data for the StarkNet chain

Query StarkNet block header details

Get the block details of StarkNet chain.

HTTP Request

GET /api/v5/explorer/block/detail-starknet

Consumption per query 1

Request Example

GET /api/v5/explorer/block/detail-starknet?chainShortName=starknet&height=305653

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
height String Yes Block height

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "blockHash": "0x0077befc73fba1983eeb0cc421266af52c63cdaece8a49c2e5c91cb4942ec16f",
        "height": "305653",
        "status": "ACCEPTED_ON_L1",
        "parentBlockHash": "0x0714623a72e27a1631ec9acac8f46e31409327913388c9a46b6fb88e95f040c1",
        "blockTime": "1696831933",
        "stateRoot": "0x372db6f7b7bd72396215035b7ff7f6eb7589a4f9cb249b5ae4fedd0ab1fbf5e",
        "sequencerAddress": "0x01176a1bd84444c89232ec27754698e5d2e7e1a7f1539f12027f28b23ec9f3d8",
        "l1TransactionHash": "0x98c5cf7d0c457ecc238a9e75a688e715c11be3bdbf0b0d89bc216d7a5e91aae3",
        "transactionAmount": "156",
        "messageAmount": "3",
        "eventAmount": "792"
    }
}

Response Parameters

Parameter Type Description
blockHash String Block hash
height String Block height
blockTime String Generate block time. Unix timestamp format in milliseconds, e.g. 1597026383085
parentBlockHash String The parent block hash of thin block
stateRoot String State commitment after the block
sequencerAddress String The address of sequencer
status String The status of block
transactionAmount String The number of transactions contained in the block
messageAmount String The number of message contained in the block
eventAmount String The number of event contained in the block
l1TransactionHash String L1 transaction hash

Query StarkNet block transaction list

Get the list of transactions in a block under the StarkNet.

HTTP Request

GET /api/v5/explorer/block/transaction-list-starknet

Consumption per query 1

Request Example

GET /api/v5/explorer/block/transaction-list-starknet?chainShortName=starknet&height=305653&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
height String Yes Block height
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "156",
        "transactionList": [
            {
                "txId": "0x04e055fb82640d74576b107135e69535aa26ca17f1d1071c77281b5121bee531",
                "blockHash": "0x0077befc73fba1983eeb0cc421266af52c63cdaece8a49c2e5c91cb4942ec16f",
                "height": "305653",
                "transactionTime": "1696831933",
                "transactionType": "INVOKE",
                "transactionStatus": "ACCEPTED_ON_L1",
                "address": "0x05dd2e71e9f4627b79e115e2c2267c1d528735faf870fe5e8e3a584577b40707"
            }
        ]
    }
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Block transaction list
> txId String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> address String The address in the transaction
> transactionType String The type of transaction
> transactionStatus String The status of transaction

Query StarkNet address token balance

Get Token Balance Detail for an StarkNet address to get information about the balance of all tokens on that address.(Currently only supports ERC20 tokens)

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/token-balance-starknet

Request Example

GET /api/v5/explorer/address/token-balance-starknet?address=0x044a33f085b5ef75bde5df11d188e4c16db6c090f8c9c38c6020fbe6e24fcbc0&chainShortName=starknet&protocolType=token_20

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
address String Yes Address
protocolType String Yes Contract protocol type
token_20
token_721
token_1155
tokenContractAddress String No Token Contract Address
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "page": "1",
        "limit": "20",
        "totalPage": "1",
        "tokenList": [
            {
                "symbol": "ETH",
                "holdingAmount": "0.09338760014159263",
                "tokenContractAddress": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7"
            },
            {
                "symbol": "zETH",
                "holdingAmount": "0.01200306543397489",
                "tokenContractAddress": "0x01b5bd713e72fdc5d63ffd83762f81297f6175a5e0a4771cdadbc1dd5fe72cb1"
            }
        ]
    }
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenList Array Token list
> symbol String Token symbol
> tokenContractAddress String Token contract address
> holdingAmount String The holding amount of the token

Query StarkNet address normal transaction list

Get a list of common transactions associated with an StarkNet address.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/normal-transaction-list-starknet

Request Example

GET /api/v5/explorer/address/normal-transaction-list-starknet?limit=1&address=0x044a33f085b5ef75bde5df11d188e4c16db6c090f8c9c38c6020fbe6e24fcbc0&chainShortName=starknet

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
address String Yes Address
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "23",
        "transactionList": [
            {
                "txId": "0x008f40e4973d54ce0be584a851bd8dc9855c9b17277ea2cd3345ae73590af1ba",
                "blockHash": "0x0394c76b5148ef928302baadf1ad981126a8c7861ba6cc0d7a245aa0041a9d24",
                "height": "305222",
                "transactionTime": "1696820202",
                "transactionType": "INVOKE",
                "transactionStatus": "ACCEPTED_ON_L2"
            }
        ]
    }
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txid String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> transactionType String The type of the transaction
> transactionStatus String The status of the transaction

Query StarkNet address token transaction list

Get a list of token trading transactions associated with the StarkNet address.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/token-transaction-list-starknet

Request Example

GET /api/v5/explorer/address/token-transaction-list-starknet?limit=1&address=0x044a33f085b5ef75bde5df11d188e4c16db6c090f8c9c38c6020fbe6e24fcbc0&chainShortName=starknet&protocolType=token_20

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
address String Yes Address
protocolType String Yes Contract protocol type
token_20
token_721
token_1155
tokenContractAddress String No Token contract address
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "66",
        "transactionList": [
            {
                "txId": "0x008f40e4973d54ce0be584a851bd8dc9855c9b17277ea2cd3345ae73590af1ba",
                "blockHash": "0x0394c76b5148ef928302baadf1ad981126a8c7861ba6cc0d7a245aa0041a9d24",
                "height": "305222",
                "transactionTime": "1696820202",
                "from": "0x04270219d365d6b017231b52e92b3fb5d7c8378b05e9abc97724537a80e93b0f",
                "to": "0x044a33f085b5ef75bde5df11d188e4c16db6c090f8c9c38c6020fbe6e24fcbc0",
                "amount": "0.03156615266324224",
                "symbol": "ETH"
            }
        ]
    }
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txId String Transaction hash
> blockHash String Block hash
> height String Block height
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> from String Funds source address
> to String Funds arrival address
> amount String Transaction amount
> symbol String Token symbol

Cosmos

Query basic information, block, address, transaction, and token data for COSMOS, KAVA, and EVMOS.

Query blockchain info

Query blockchain basic information. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/blockchain

Request Example

GET /api/v5/explorer/cosmos/blockchain?chainShortName=COSMOS

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "COSMOS HUB",
            "chainShortName": "COSMOS",
            "symbol": "ATOM",
            "chainCosmosId": "cosmoshub-4",
            "consensus": "POS",
            "marketCap": "2964931888.81",
            "tps": "0.88",
            "lastBlockTime": "1703587500000",
            "lastBlockHeight": "18446784",
            "totalTransactionCount": "47637956",
            "totalTransactionValue": "5134936965.921793",
            "transactionValue24h": "124615822260.29991",
            "totalAddresses": "2070187",
            "activeValidators": "180",
            "totalSupply": "380237029.903674",
            "totalStaked": "242415216.719547",
            "totalAsset": "13108",
            "ibcTokens": "954"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. COSMOS HUB
chainShortName String Chain short name, e.g. COSMOS
symbol String The native token symbol, e.g. ATOM
chainCosmosId String The ID of the blockchain network in the Cosmos ecosystem
consensus String Consensus algorithm, e.g. PoS
marketCap String Market cap of the chain
tps String Transactions per second, calculated with the average of nearly 10 blocks
lastBlockTime String Last block time; Unix timestamp format in milliseconds, e.g. 1597026383085
lastBlockHeight String The latest block height
totalTransactionCount String Total number of transactions
totalTransactionValue String Total transaction value of transfers of on-chain native tokens
transactionValue24h String Transaction value of transfers of on-chain native tokens in the past 24 hours
totalAddresses String Total number of addresses on the blockchain
activeValidators String Total number of active addresses on the blockchain
totalSupply String Total supply of the native token
totalStaked String The amount of staked native token
totalAsset String Total number of assets on this blockchain
ibcTokens String Total number of assets received from other blockchain via IBC

Query block fills

Query block details of the public chains. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/block-fills

Request Example

GET /api/v5/explorer/cosmos/block-fills?chainShortName=COSMOS&height=17872234

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS
height String Yes Block height

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "COSMOS HUB",
            "chainShortName": "COSMOS",
            "hash": "81788E1AD853DB23EF1650A8EC270D6FEFE87B47116B75870214C53F3B8DA3AA",
            "height": "17872234",
            "validator": "cosmosvaloper14k4pzckkre6uxxyd2lnhnpp8sngys9m6hl6ml7",
            "blockTime": "1700102295000",
            "txnCount": "2",
            "round": "0",
            "mineReward": "12.274384",
            "gasUsed": "615684",
            "gasLimit": "666684",
            "totalFee": "0.0028330000000000004"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. COSMOS HUB
chainShortName String Chain short name, e.g. COSMOS
hash String Block hash
height String Block height
validator String Validator/Producer
blockTime String Time when the block was produced, Unix timestamp in millisecond format, e.g. 1597026383085
txnCount String The number of normal transactions contained in the block
round String Voting round
mineReward String Block reward
gasUsed String Actual amount of gas used
gasLimit String Gas limit
totalFee String The sum of all fees in the block, the unit is the native token of the chain

Query block transaction list

Get the list of transactions in a block under the blockchain. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/block-transaction-list

Request Example

GET /api/v5/explorer/cosmos/block-transaction-list?chainShortName=COSMOS&height=17872234

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS
height String Yes Block height
transactionListType String No Transaction list type
cosmos: cosmos transaction list of the block
evm: EVM transaction list of the block
The default is cosmos
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "chainFullName": "COSMOS HUB",
            "chainShortName": "COSMOS",
            "cosmosTransactionList": [
                {
                    "txId": "617533FA5F0BE0773E3AD2CA5665C90203DC5279D64FF879F2A68CFC335A268A",
                    "txType": "ibc.core.client.v1.MsgUpdateClient,ibc.core.channel.v1.MsgRecvPacket",
                    "state": "success",
                    "txFee": "0.000577"
                },
                {
                    "txId": "D7FD67D5CD73CC53F980122085AB859B27F26B1ADA2653777AA5D782A4945FB4",
                    "txType": "cosmos.gov.v1beta1.MsgVote",
                    "state": "success",
                    "txFee": "0.002256"
                }
            ],
            "evmTransactionList": []
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. COSMOS HUB
chainShortName String Chain short name, e.g. COSMOS
cosmosTransactionList Array Cosmos transaction list of the block
> txId String Transaction hash
> txType String Transaction type, multiple transaction types are separated by comma
> state String Transaction state
success
fail
> txFee String Transaction fee, the unit is the native token of the chain
evmTransactionList Array EVM transaction list of the block, only for Kava and Evmos
> txId String Transaction hash
> methodId String Method id
> state String Transaction state
success
fail
> from String From address
> isFromContract Bol Whether the from address is a contract address
> to String To address
> isToContract Bol Whether the to address is a contract address
> amount String The transaction amount of the native token
> txFee String Transaction fee, the unit is the native token of the chain

Query validator list

Get the list of validators. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/validator-list

Request Example

GET /api/v5/explorer/cosmos/validator-list?chainShortName=COSMOS&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS
validatorAddress String Yes Validator operator address
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "573",
            "validatorList": [
                {
                    "rank": "1",
                    "validatorName": "Coinbase Custody",
                    "validatorAddress": "cosmosvaloper1c4k24jzduc365kywrsvf5ujz4ya6mwympnc4en",
                    "votingPower": "0.0923",
                    "weight": "22371898.089718",
                    "blocks": "500896",
                    "participateProposals": "0",
                    "proposals": "152",
                    "uptime": "1",
                    "commission": "0.2",
                    "ownerAddress": "cosmos1c4k24jzduc365kywrsvf5ujz4ya6mwymy8vq4q",
                    "state": "active",
                    "bondedHeight": "0",
                    "website": "custody.coinbase.com",
                    "descriptions": "Coinbase Custody Cosmos Validator"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
validatorList Array Validator list
> rank String Voting power ranking of the validator
> validatorName String Validator name
> validatorAddress String Validator operator address
> votingPower String Voting power, the total amount of native tokens delegated by the validator accounts for the proportion of the total amount of native tokens delegated by all validators
> weight String The total amount of native tokens delegated by the validator
> blocks String The number of blocks generated
> participateProposals String The number of proposals that the validator participated in
> proposals String Total number of proposals
> uptime String The percentage of time the validator has been actively functioning in the last 100 blocks
> commission String Commission percentage
> ownerAddress String Owner address of the validator
> state String Validator status
active, jailed, inactive
> bondedHeight String Delegation effective height
> website String Website of the validator
> descriptions String Description of the validator

Query address native token balance

Query the native token balance of an address. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/balance-cosmos

Request Example

GET /api/v5/explorer/address/balance-cosmos?chainShortName=cosmos&address=cosmos1gn52hszvhmhu64hs2mywfj7tr4ps6nwz0snht8

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name
address String Yes Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "address": "cosmos1gn52hszvhmhu64hs2mywfj7tr4ps6nwz0snht8",
        "availableBalance": "0.571788",
        "delegated": "0",
        "delegatedReward": "0",
        "rewardRecipientAddress": "cosmos1gn52hszvhmhu64hs2mywfj7tr4ps6nwz0snht8",
        "unbonding": "0",
        "symbol": "ATOM",
        "commission": "0",
        "incentive": "",
        "ethereumCoChainAddress": ""
    }
}

Response Parameters

Parameter Type Description
address String Ordinary address
availableBalance String Available balance of the address
delegated String Delegated balance
delegatedReward String Delegated reward
rewardRecipientAddress String Reward recipient address
unbonding String Unbonding balance
symbol String Native token symbol of the chain
commission String Validator commission
incentive String Number of incentive tokens, only for Kava and Evmos
ethereumCoChainAddress String The contract address for interacting with the Ethereum main chain, only for Kava and Evmos

Query address token balance

Query for the token balance of an address. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/token-balance-detail-cosmos

Request Example

GET /api/v5/explorer/address/token-balance-detail-cosmos?chainShortName=kava&address=kava1wq9ts6l7atfn45ryxrtg4a2gwegsh3xha9e6rp&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name
address String Yes Address
tokenType String No Token type, all Cosmos tokens are returned by default (including native tokens, LP tokens, IBC tokens, and BEP-3 bridged tokens). You can also filter by:
nativeToken: native token
lp: LP token
ibc: IBC token
bep: BEP-3 bridged token
token_20: ERC-20 token, only for Kava and Evmos
token_721: ERC-721 token, only for Kava and Evmos
token_1155: ERC-1155 token, only for Kava and Evmos
ibcDenom String No Cross-chain token identifier, only for IBC token
denom String No The smallest unit of a transaction request, only for Cosmos token
tokenContractAddress String No Token contract address, only for ERC-20, ERC-721, ERC-1155 token
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "8",
        "tokenList": [
            {
                "token": "debt",
                "tokenType": "nativeToken",
                "holdingAmount": "21618717436640",
                "denom": "debt",
                "ibcDenom": ""
            }
        ]
    }
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenList Array Token list
> token String Token symbol
> tokenType String nativeToken: native token
lp: LP token
ibc: IBC token
bep: BEP-3 bridged token
token_20: ERC-20 token, only for Kava and Evmos
token_721: ERC-721 token, only for Kava and Evmos
token_1155: ERC-1155 token, only for Kava and Evmos
> holdingAmount String The holding amount of the token
> denom String The smallest unit of a transaction request, only for Cosmos token
> ibcDenom String Cross-chain token identifier, only for IBC token

Query address Cosmos transaction

Query for the Cosmos transactions of an address. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/address/normal-transaction-cosmos

Request Example

GET /api/v5/explorer/address/normal-transaction-cosmos?chainShortName=cosmos&address=cosmos1nvcgd368m4pm5mm3ppzawhsq6grra4ejnppplx&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name
address String Yes Address
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "10000",
        "transactionList": [
            {
                "symbol": "ATOM",
                "txId": "779D81F33632B91EC2A58CDF79221FAAF357B89EFFA14300D1102DE8A7445DF6",
                "blockHash": "1C1672F41EDAA2E1A8E816E885162658D178E0B28691715B97CA927EFF7E3F46",
                "height": "18461766",
                "transactionTime": "1703678689",
                "from": [
                    "cosmos1jv65s3grqf6v6jl3dp4t6c9t9rk99cd88lyufl",
                    "cosmos1nvcgd368m4pm5mm3ppzawhsq6grra4ejnppplx"
                ],
                "to": [
                    "cosmos1nvcgd368m4pm5mm3ppzawhsq6grra4ejnppplx"
                ],
                "txFee": "0.004",
                "gasLimit": "700000",
                "gasUsed": "644948",
                "type": [
                    "cosmos.staking.v1beta1.MsgDelegate"
                ],
                "value": "0",
                "state": "0"
            }
        ]
    }
}

Response Parameters

Parameter Type Description
page String Page number
limit String Number of records per page, default min 20, max 100
totalPage String Total number of pages
transactionList Array List of transactions
> symbol String Symbol of the transaction token
> txId String Transaction hash
> blockHash String Block hash
> height String Block height of the transaction
> transactionTime String Transaction timestamp
> from Array Transaction sender's address
> to Array Transaction receiver's address
> txFee String Transaction fee
> gasLimit String Maximum gas amount
> gasUsed String Actual amount of gas used
> type String Transaction type
> value String Transaction value
> state String Transaction status: 0 for success, others for failed

Query transaction list

Get the list of transactions, only return the latest 10,000 transactions. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/transaction-list

Request Example

GET /api/v5/explorer/cosmos/transaction-list?chainShortName=cosmos&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS
height String No Block height
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "COSMOS HUB",
            "chainShortName": "COSMOS",
            "transactionList": [
                {
                    "txId": "8169A9D244F5D2478FA8C2D3496BB5BCE5B0D728A6BAA1E33DED085117569CF5",
                    "blockHash": "86177ABDBC145BFD4C4B3E71DF194866ADB95F716F3549655AAD9E6C8162A3A7",
                    "height": "18470022",
                    "transactionTime": "1703729095000",
                    "from": "cosmos13rsacl9a3r272fqhtw59zeawdpuxkj64cw9myq",
                    "to": "cosmos1j8pp7zvcu9z8vd882m284j29fn2dszh05cqvf9",
                    "isFromContract": false,
                    "isToContract": false,
                    "amount": "266.85",
                    "transactionSymbol": "ATOM",
                    "txFee": "0.002",
                    "transactionType": "cosmos.bank.v1beta1.MsgSend",
                    "state": "success"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. COSMOS HUB
chainShortName String Chain short name, e.g. COSMOS
transactionList Array Transaction list
> txId String Transaction hash
> blockHash String Block hash
> height String Block height of the transaction
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> from String From address
> to String To address
> isFromContract Bol Whether the from address is a contract address
> isToContract Bol Whether the to address is a contract address
> amount String The transaction amount of the native token
> transactionSymbol String Token symbol of the transaction
> txFee String Transaction fee
> transactionType String Transaction type
> state String Transaction state
success
fail

Query token list

Get the list of tokens. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/token-list

Request Example

GET /api/v5/explorer/cosmos/token-list?chainShortName=cosmos&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS
protocolType String No Token type, all Cosmos tokens are returned by default (including native tokens, LP tokens, IBC tokens, and BEP-3 bridged tokens). You can also filter by:
nativeToken: native token
lp: LP token
ibc: IBC token
bep: BEP-3 bridged token
token_20: ERC-20 token, only for Kava and Evmos
token_721: ERC-721 token, only for Kava and Evmos
token_1155: ERC-1155 token, only for Kava and Evmos
denom String No Cross-chain token identifier for IBC token, the smallest unit of a transaction request for other Cosmos tokens
tokenContractAddress String No Token contract address, only for ERC-20, ERC-721, ERC-1155 token
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "COSMOS HUB",
            "chainShortName": "COSMOS",
            "tokenList": [
                {
                    "tokenFullName": "ATOM",
                    "token": "ATOM",
                    "precision": "6",
                    "tokenContractAddress": "",
                    "protocolType": "nativeToken",
                    "addressCount": "1139570",
                    "totalSupply": "351129538.440699",
                    "circulatingSupply": "372198329",
                    "price": "12.064",
                    "website": "",
                    "totalMarketCap": "4597411775.6",
                    "transactionAmount24h": "7865935.1198792",
                    "denom": "uatom"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. COSMOS HUB
chainShortName String Chain short name, e.g. COSMOS
tokenList Array Token list
> tokenFullName String Token full name
> token String Token name
> precision String Precision
> tokenContractAddress String Token contract address
> protocolType String Protocol type
> addressCount String The number of holders of the token
> totalSupply String Total supply
> circulatingSupply String Circulating supply
> price String Price, the unit is USD
> website String Website
> totalMarketCap String Total market cap
> transactionAmount24h String Transaction amount in the past 24 hours, the unit is USD, only for ERC-20 token and IBC token
> denom String Cross-chain token identifier for IBC token, the smallest unit of a transaction request for other Cosmos tokens

Query token position list

Get the list of token position. The supported chains are COSMOS, KAVA, EVMOS.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/token-position-list

Request Example

GET /api/v5/explorer/cosmos/token-position-list?chainShortName=cosmos&denom=uatom&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS
denom String Either denom or tokenContractAddress must be chosen Cross-chain token identifier for IBC token, the smallest unit of a transaction request for other Cosmos tokens
tokenContractAddress String Either denom or tokenContractAddress must be chosen Token contract address, only for ERC-20, ERC-721, ERC-1155 token
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "COSMOS HUB",
            "chainShortName": "COSMOS",
            "circulatingSupply": "",
            "positionList": [
                {
                    "holderAddress": "cosmos1fl48vsnmsdzcv85q5d2q4z5ajdha8yu34mf0eh",
                    "amount": "241846712.302262",
                    "valueUsd": "2892970372.559658",
                    "positionChange24h": "-167045.82778599858",
                    "rank": "1"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. COSMOS HUB
chainShortName String Chain short name, e.g. COSMOS
circulatingSupply String Circulating Supply
positionList Array Position List
> holderAddress String Holder Address
> amount String Holding amount
> valueUsd String Value of positions, unit: USD
> positionChange24h String 24 hour position changes
> rank String Position ranking

Batch query token price

Batch query the price of up to 100 tokens. The price is the result of a comprehensive calculation of prices from multiple CEX and DEX. The supported chains are COSMOS, KAVA.

Consumption per query 1

HTTP Request

GET /api/v5/explorer/cosmos/token-price-multi

Request Example

GET /api/v5/explorer/cosmos/token-price-multi?denom=uatom&chainShortName=cosmos

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. COSMOS, KAVA, EVMOS
denom String Either denom or tokenContractAddress must be chosen Cross-chain token identifier for IBC token, the smallest unit of a transaction request for other Cosmos tokens
tokenContractAddress String Either denom or tokenContractAddress must be chosen Token contract address, only for ERC-20, ERC-721, ERC-1155 token

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "lastPrice": "11.92",
            "tokenContractAddress": "",
            "denom": "uatom",
            "priceAbnormal": []
        }
    ]
}

Response Parameters

Parameter Type Description
lastPrice String The latest price of the token, updated every minute.
tokenContractAddress String Token Contract Address
denom String Cross-chain token identifier for IBC token, the smallest unit of a transaction request for other Cosmos tokens
priceAbnormal String Abnormal price type
Low Liquidity, Disparity Between Sources, Abnormal Fluctuation

Tether

These endpoints from this module retrieve issuance and redemption records for USDT on ETH, TRON and BTC.

Query USDT printing/destruction list

Get the issuance records of USDT on TRX, BTC, and ETH public chain networks

HTTP Request

GET /api/v5/explorer/stablecoin/printing-record

Consumption per query 1

Request Example

GET /api/v5/explorer/stablecoin/printing-record?stablecoinName=USDT&network=btc&type=printing&limit=1

Request Parameters

Parameter Type Required Description
stablecoinName String Yes Stablecoin name, e.g. USDT
network String Yes Chain name
all
TRX
ETH
BTC
USDT
type String Yes Type
printing
destruction
limit String No Number of results per request. The maximum is 50. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "83",
            "recordList": [
                {
                    "stablecoinName": "USDT",
                    "txid": "0c8c22ee5cd69649ff36c0396bb9ce951425614a32129d8d54c0144895ef4e7a",
                    "network": "BTC",
                    "height": "573063",
                    "amount": "300000000",
                    "sendAddress": "32TLn1WLcu8LtfvweLzYUYU6ubc2YV9eZs",
                    "receiveAddress": "1NTMakcgVwQpMdGxRQnFKyb3G1FAJysSfz",
                    "transactionTime": "1556131281000"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
recordList String Printing/destruction list
> stablecoinName String Stablecoin name
> txid String Transaction hash
> network String Chain name
> height String Block height
> amount String The amount of stablecoin
> sendAddress String Send address
> receiveAddress String Receive address
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085

POR

These endpoints from this module retrieve exchange reserve details, historical reserve records, and reserve breakdowns for top exchanges. The supported exchanges for querying: Binance, OKX, Huobi, Bitget, KuCoin, Crypto.com, Bybit, Deribit, Bitfinex

Query proof of reserves

Get the latest proof of reserves data from centralized exchanges

HTTP Request

GET /api/v5/explorer/por/proof-of-reserves

Consumption per query 5

Request Example

GET /api/v5/explorer/por/proof-of-reserves

Request Parameters

Parameter Type Required Description
institutionName String No Exchange Name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "institutionName": "OKX",
            "totalBalance": "6502554504.391312",
            "balanceDetails": [
                {
                    "symbol": "ETH",
                    "balance": "1077119.4731584482",
                    "balanceUsd": "1354434652.7178226",
                    "change": "1"
                },
                {
                    "symbol": "USDT",
                    "balance": "3006224032.2949777",
                    "balanceUsd": "3006930041.122987",
                    "change": "1"
                },
                {
                    "symbol": "BTC",
                    "balance": "102951",
                    "balanceUsd": "1745781287.4",
                    "change": "1"
                },
                {
                    "symbol": "USDC",
                    "balance": "395343687.173071",
                    "balanceUsd": "395391628.917477",
                    "change": "1"
                },
                {
                    "symbol": "BUSD",
                    "balance": "16889.72009695",
                    "balanceUsd": "16894.233026629954",
                    "change": "1"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
institutionName String Exchange Name
totalBalance String Total exchange assets, unit: USDT
balanceDetails Array Asset detail list
> symbol String Token symbol
> balance String Token balance
> change String Last 7 days fund movement up or down, 0.1 means 10%
> balanceUsd String Token balance, unit: USDT

Query proof of reserves history

Get the history of the exchange proof of reserve.

HTTP Request

GET /api/v5/explorer/por/institution-history-asset

Consumption per query 5

Request Example

GET /api/v5/explorer/por/institution-history-asset?institutionName=Huobi

Request Parameters

Parameter Type Required Description
institutionName String Yes Exchange Name
time String No History time, e.g:1670601600000

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "institutionName": "Huobi",
            "balanceList": [
                {
                    "chainShortName": "ETH",
                    "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "symbol": "USDT",
                    "balance": "583066271.058834",
                    "balanceUsd": "583066271.058834",
                    "time": "1670601600000"
                },
                {
                    "chainShortName": "ETH",
                    "tokenContractAddress": "0xb8c77482e45f1f44de1745f52c74426c631bdd52",
                    "symbol": "BNB",
                    "balance": "0.3",
                    "balanceUsd": "86.51097014666489",
                    "time": "1670601600000"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
institutionName String Exchange name
balanceList Array Balance details
> chainShortName String Chain short name, e.g. BTC
> tokenContractAddress String Token contract address
> symbol String Token symbol
> balance String Token balance
> balanceUsd String Token balance, unit: USDT
> time String History time

Query POR address list

Query the publicly disclosed POR address lists of a specific exchange on different chains, returning a maximum of 1000 addresses in descending order of asset amount. The supported chains are BTC, ETH, BSC, POLYGON, AVAXC, OP, ARBITRUM, BEACON, TRON.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/por/address-list

Request Example

GET /api/v5/explorer/por/address-list?institutionName=Binance

请求参数

Parameter Type Required Description
institutionName String Yes Exchange name
chainShortName String No Chain short name, e.g. BTC

Response Example

{
   "code": "0",
    "msg": "",
    "data": [
        {
            "chainShortName": "BTC",
            "address": "3Jxc4zsvEruEVAFpvwj818TfZXq5y2DLyF"
        }
    ]
}

Response Parameters

Parameter Type Description
chainShortName String Chain short name
address String POR address

Query address balance details

Query the asset details of the top 50 addresses in terms of capital volume of a specific exchange

HTTP Request

GET /api/v5/explorer/por/address-balance-details

Consumption per query 5

Request Example

GET /api/v5/explorer/por/address-balance-details?institutionName=Huobi

Request Parameters

Parameter Type Required Description
institutionName String Yes Exchange Name
page String No Page
limit String No Number of returned data, 10 by default, 50 at most

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "50",
            "addressDetails": [
                {
                    "balance": "248597.39260212",
                    "balanceUsd": "7658614453.111291",
                    "chainShortName": "BTC",
                    "symbol": "BTC",
                    "address": "34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo",
                    "updateTime": "1698037200000"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
addressDetails Array Address details
> chainShortName String Chain short name, e.g. BTC
> symbol String Token symbol
> balance String Token balance
> balanceUsd String Token balance, unit: USDT
> address String Address
> updateTime String Update time

Query asset flow of exchanges

Get the asset flow of exchanges in the past 30 days

HTTP Request

GET /api/v5/explorer/por/asset-flow

Consumption per query 1

Request Example

GET /api/v5/explorer/por/asset-flow?institutionName=Binance

Request Parameters

Parameter Type Required Description
institutionName String No Exchange name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "institutionName": "Binance",
            "startTime": "1698163200000",
            "endTime": "1700755200000",
            "symbol": "BTC,USDT,ETH,USDC",
            "inFlow": [
                {
                    "entities": "Binance",
                    "totalValue": 4895055579.856456080721,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 105218.90925652136260,
                            "usdValue": 6826324.548780690122
                        },
                        {
                            "symbol": "ETH",
                            "value": 230384927.744176925,
                            "usdValue": 455318082.704016072
                        },
                        {
                            "symbol": "USDT",
                            "value": 4124675775.9757988826,
                            "usdValue": 4126567904.5649451159
                        },
                        {
                            "symbol": "USDC",
                            "value": 306337238.601268376465,
                            "usdValue": 306343268.038714202699
                        }
                    ]
                },
                {
                    "entities": "Kraken",
                    "totalValue": 2894665874.143568113741,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 52334363.306053193576688,
                            "usdValue": 2894665874.143568113741
                        }
                    ]
                },
                {
                    "entities": "Coinbase",
                    "totalValue": 1944412213.245690277,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 33499351.06362882384,
                            "usdValue": 1944412213.245690277
                        }
                    ]
                },
                {
                    "entities": "Non institutional",
                    "totalValue": 61097057433.775659899517,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 378177025.504197862,
                            "usdValue": 22381646937.37760093
                        },
                        {
                            "symbol": "ETH",
                            "value": 420463853.748517634609,
                            "usdValue": 6353422752.5202973257
                        },
                        {
                            "symbol": "USDT",
                            "value": 26476640510.29366205403,
                            "usdValue": 26486442857.38710407426
                        },
                        {
                            "symbol": "USDC",
                            "value": 5875372621.385650664061,
                            "usdValue": 5875544886.490657569557
                        }
                    ]
                },
                {
                    "entities": "OTHER",
                    "totalValue": 5925062015.982478217526750,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 96695995.98055366673561927,
                            "usdValue": 5629851813.752190546446854
                        },
                        {
                            "symbol": "ETH",
                            "value": 4235.11820857,
                            "usdValue": 1888578.92583743166001
                        },
                        {
                            "symbol": "USDT",
                            "value": 253435373.5741789998,
                            "usdValue": 253514589.37770223841989
                        },
                        {
                            "symbol": "USDC",
                            "value": 39806633.34,
                            "usdValue": 39807033.926748000999996
                        }
                    ]
                }
            ],
            "outflow": [
                {
                    "entities": "Binance",
                    "totalValue": 25880519279.34233794684659,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 446979843.069527148,
                            "usdValue": 25758813304.31752274
                        },
                        {
                            "symbol": "ETH",
                            "value": 241651.542300100004,
                            "usdValue": 102488438.639715334575
                        },
                        {
                            "symbol": "USDT",
                            "value": 9683786.116047718969,
                            "usdValue": 9687369.62429497364399
                        },
                        {
                            "symbol": "USDC",
                            "value": 9529232.797039480002,
                            "usdValue": 9530166.7608048986276
                        }
                    ]
                },
                {
                    "entities": "OKX",
                    "totalValue": 1778131903.198936031468086,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 27229581.83959817462,
                            "usdValue": 1625828865.799360377
                        },
                        {
                            "symbol": "ETH",
                            "value": 27502583.2804187682,
                            "usdValue": 40166453.3014638396
                        },
                        {
                            "symbol": "USDT",
                            "value": 109012875.6836676494974,
                            "usdValue": 109066623.358723094326326
                        },
                        {
                            "symbol": "USDC",
                            "value": 3069684.019895000061435,
                            "usdValue": 3069960.73938872054176
                        }
                    ]
                },
                {
                    "entities": "Bybit",
                    "totalValue": 165499102.316852054127908,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "ETH",
                            "value": 1154670.49264628987,
                            "usdValue": 5261706.95908915983
                        },
                        {
                            "symbol": "USDT",
                            "value": 125986732.81877199220003,
                            "usdValue": 126032425.899575876057908
                        },
                        {
                            "symbol": "USDC",
                            "value": 34203788.99158674844,
                            "usdValue": 34204969.45818701824
                        }
                    ]
                },
                {
                    "entities": "Non institutional",
                    "totalValue": 43553300007.536882798703,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 32883243.02858405587,
                            "usdValue": 1876226041.101757367
                        },
                        {
                            "symbol": "ETH",
                            "value": 380488212.12212643767,
                            "usdValue": 6943686548.344351922
                        },
                        {
                            "symbol": "USDT",
                            "value": 28554661639.94832429986,
                            "usdValue": 28565426281.90919205095
                        },
                        {
                            "symbol": "USDC",
                            "value": 6167752794.3580837402978,
                            "usdValue": 6167961136.181581458753
                        }
                    ]
                },
                {
                    "entities": "OTHER",
                    "totalValue": 505335352.4121178055108002,
                    "tokenFlowDetailList": [
                        {
                            "symbol": "BTC",
                            "value": 10008.386152673052149,
                            "usdValue": 561052.14232849779361
                        },
                        {
                            "symbol": "ETH",
                            "value": 5476601.371627149954682053,
                            "usdValue": 26217318.248646359432310
                        },
                        {
                            "symbol": "USDT",
                            "value": 460278302.522870445258762,
                            "usdValue": 460468089.9823136189277595
                        },
                        {
                            "symbol": "USDC",
                            "value": 18087770.97845448987203,
                            "usdValue": 18088892.0388293293571207
                        }
                    ]
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
institutionName String Exchange name
startTime String Start time
endTime String End time
symbol String Symbols participating in the calculation
inFlow Array inflow list
> entities String Entity name
> totalValue String Total usd value
> tokenFlowDetailList Array Token flow list
>> symbol String Symbol
>> value String The amount of tokens
>> usdValue String The USD value of tokens

NFT API

These endpoints from this module retrieve NFT data such as NFT's attributes, NFT rarity, floor price and other related information.

Chain list

Get the list of public chains supported by the API interface of the NFT module

HTTP Request

GET /api/v5/explorer/nft/chain-list

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/chain-list

Request Parameters

Parameter Type Required Description
chainShortName String No Chain name

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH"
        },
        {
            "chainFullName": "Polygon",
            "chainShortName": "POLYGON"
        },
        {
            "chainFullName": "Optimism",
            "chainShortName": "OPTIMISM"
        },
        {
            "chainFullName": "OKT Chain",
            "chainShortName": "OKTC"
        },
        {
            "chainFullName": "Avalanche-C",
            "chainShortName": "AVAXC"
        },
        {
            "chainFullName": "ARBITRUM",
            "chainShortName": "ARBITRUM"
        },
        {
            "chainFullName": "BNB Chain",
            "chainShortName": "BSC"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC

NFT market overview

Get chain-wide NFT market data overview data.

HTTP Request

GET /api/v5/explorer/nft/nft-stats-overview

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/nft-stats-overview

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "totalMarketCap": "25854298568.561043",
            "totalHolder": "14315586",
            "dailyTradingVolume": "8816152.74027341",
            "dailyTransaction": "30656"
        }
    ]
}

Response Parameters

Parameter Type Description
totalMarketCap String Total NFT market value of all the network, in USD
totalHolder String Total number of addresses held NFT of all the network
dailyTradingVolume String Total daily transaction volume of all the network, in USD
dailyTransaction String Number of NFT daily transactions of all the network

Collection info

Gets the overview information of the collection. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/collection-info

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/collection-info?chainShortName=ETH&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Contract address for the collection

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "collectionName": "BoredApeYachtClub",
            "token": "BAYC",
            "protocolType": "token_721",
            "website": "",
            "createContractAddress": "0xaba7161a7fb69c88e16ed9f455ce62b791ee4d03",
            "collectionType": "top_collectibles",
            "totalSupply": "10000",
            "collectionLogoUrl": "https://static.coinall.ltd/cdn/nft/files/collection/205-logo.webp"
        }
    ]
}

Response Parameters

Parameter Type Description
collectionName String Collection name
collectionLogoUrl String Collection logo
tokenContractAddress String Contract address for the collection
token String Token name
protocolType String Protocol type: token_721, token_1155
website String Official website of the collection
creatContractAddress String Creat contract address
collectionType String Collection type:
art
sports
music
domain_names
virtual_places
trading_cards
top_collectibles
utility_nfts
totalSupply String NFT total supply

Collection details

Get detailed information about the collection, including the floor price, etc. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/collection-details

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/collection-details?chainShortName=ETH&tokenContractAddress=0xed5af388653567af2f388e6224dc7c4b3241c544

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Contract address for the collection

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "collectionName": "BoredApeYachtClub",
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "totalSupply": "10000",
            "holder": "5537",
            "avgPrice": "39335.9037",
            "transactionNumber": "156",
            "activeUser": "67",
            "transactionVolume": "1927459.2813000001",
            "transactionVolumeUsd": "2992611829.332006",
            "floorPrice": "24.38995001",
            "lastPrice": "26.9",
            "collectionLogoUrl": "https://static.coinall.ltd/cdn/nft/files/collection/205-logo.webp"
        }
    ]
}

Response Parameters

Parameter Type Description
collectionName String Collection name
tokenContractAddress String Contract address for the collection
totalSupply String Total supply
holder String Number of NFT holders
avgPrice String Avg price
transactionNumber String Daily Number of transactions
activeUser String Number of daily active users
transactionVolume String Daily transaction amount
transactionVolumeUsd String Daily transaction amount in USDT
floorPrice String Floor price
lastPrice String Last price
collectionLogoUrl String Collection logo

Collection NFT list

Get the NFT list of the collection. The supported chains are ETH, OKTC, BSC, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/collection-nft-list

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/collection-nft-list?chainShortName=eth&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Contract address for the collection
filterType String No Filter type:
maximum_number_of_transfer
price_high
price_low
latest_transaction_time
maximum_number_of_transfer
tokenId String No NFT token ID
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10002",
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "totalSupply": "10000",
            "nftList": [
                {
                    "tokenId": "2779",
                    "holdingAddressAmount": "1",
                    "logoUrl": "/nft/files/c34da970-16ba-44b0-8892-bd05d24a350c.webp",
                    "protocolType": "token_721",
                    "lastTransactionTime": "1697631959000",
                    "lastPrice": "24",
                    "lastPriceUnit": "ETH",
                    "transactionCount": "202",
                    "mintTime": "1631463135000",
                    "title": "Bored Ape Yacht Club #2779"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenContractAddress String Contract address for the collection
totalSupply String NFT total supply
nftList Array NFT list
> tokenId String NFT token id
> holdingAddressAmount String Number of addresses holding this NFT
> logoUrl String NFT logo
> protocolType String NFT protocol type
> lastTransactionTime String Latest transaction time, Unix timestamp in millisecond format, e.g. 1597026383085
> lastPrice String The latest price of this NFT
> lastPriceUnit String The price corresponds to the counting unit
> transactionCount String Number of times this NFT has been traded
> mintTime String Mint time for this NFT
> title String The 'name' attribute in the metadata of this NFT, which can obtain ENS or DID.

Position list

List of position addresses in the collection. ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/token/position-list

Consumption per query 1

Request Example

GET /api/v5/explorer/token/position-list?chainShortName=eth&tokenContractAddress=0x495f947276749ce646f68ac8c248420045cb7b5e

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Contract address for the collection
holderAddress String No Collection holder address
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "circulatingSupply": "1005858",
            "positionList": [
                {
                    "holderAddress": "0x000000000000000000000000000000000000dead",
                    "amount": "1109086708481",
                    "valueUsd": "",
                    "positionChange24h": "",
                    "rank": "1"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainFullName String Chain full name, e.g. Bitcoin
chainShortName String Chain short name, e.g. BTC
circulatingSupply String Collection circulating supply
positionList Array Collection position list
> holderAddress String Holder address
> amount String Number of NFTs held by the address
> valueUsd String Position value in usd
> positionChange24h String 24-hour position change
> rank String Holding amount rank

Collection floor price

Retrieve the floor price of the collection across various NFT marketplaces. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/collection-floor-price

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/collection-floor-price?chainShortName=ETH&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
tokenContractAddress String Yes Contract address for the collection
marketplace String No Project's NFT marketplace
OpenSea
LooksRare
X2Y2
Blur
CryptoPunks
okx

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "marketplace": "OKX",
            "floorPrice": "200",
            "priceSymbol": "ETH",
            "updateTime": "1697542101000"
        },
        {
            "marketplace": "X2Y2",
            "floorPrice": "26.98",
            "priceSymbol": "ETH",
            "updateTime": "1697470407000"
        },
        {
            "marketplace": "LooksRare",
            "floorPrice": "26.349",
            "priceSymbol": "ETH",
            "updateTime": "1697701282000"
        },
        {
            "marketplace": "Blur",
            "floorPrice": "24.65",
            "priceSymbol": "ETH",
            "updateTime": "1697701832000"
        },
        {
            "marketplace": "OpenSea",
            "floorPrice": "26.349",
            "priceSymbol": "ETH",
            "updateTime": "1697701278000"
        }
    ]
}

Response Parameters

Parameter Type Description
marketplace String Project's NFT marketplace
floorPrice String Floor price of the project
priceSymbol String Unit of the floor price
update String Update time for the floor price data

NFT details

Get detailed information about a particular NFT, including the floor price, attributes and rarity of the attributes. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/nft-details

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/nft-details?chainShortName=ETH&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d&tokenId=3481

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Contract address for the collection
tokenId String Yes NFT token ID

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "collectionName": "BoredApeYachtClub",
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "tokenId": "3481",
            "protocolType": "token_721",
            "token": "BAYC",
            "ownerAddress": "0x7285e8f0186a0a41e73cef7603ad7b80a2d5a793",
            "logoUrl": "https://static.oklink.com/cdn/nft/files/d7169236-7cbb-4776-8a4c-3ef358f01fc9.webp",
            "lastPrice": "0",
            "lastPriceUnit": "ETH",
            "lastTransactionTime": "1628951146000",
            "lastHeight": "13023815",
            "lastTxid": "0x7e91013ab5bc0b336f57696dc6cbc7b631127fc0996bab9e10c6657ff09eec9a",
            "transactionCount": "66",
            "minterAddress": "0xee402489d83e2b22d496910f8c810d35a3ad7b25",
            "mintTime": "1619853826000",
            "floorPrice": "24.38995001",
            "title": "Bored Ape Yacht Club #3481",
            "attributes": [
                {
                    "traitType": "Background",
                    "value": "Gray",
                    "prevalence": "0.117"
                },
                {
                    "traitType": "Clothes",
                    "value": "Striped Tee",
                    "prevalence": "0.0412"
                },
                {
                    "traitType": "Eyes",
                    "value": "Bloodshot",
                    "prevalence": "0.0846"
                },
                {
                    "traitType": "Fur",
                    "value": "Gray",
                    "prevalence": "0.0496"
                },
                {
                    "traitType": "Hat",
                    "value": "Halo",
                    "prevalence": "0.0324"
                },
                {
                    "traitType": "Mouth",
                    "value": "Bored Unshaven",
                    "prevalence": "0.1551"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
collectionName String Collection name
tokenContractAddress String Contract address for the collection
tokenId String NFT token id
protocolType String Protocol type of the collection
token String Token name
ownerAddress String NFT owner address
logoUrl String NFT logo url
lastPrice String NFT last price
floorPrice String Floor price
lastPriceUnit String Unit of measurement of last prices\
lastTransactionTime String Latest transaction time, Unix timestamp in millisecond format, e.g. 1597026383085
lastHeight String Block height of the latest transaction
lastTxid String Last transaction hash of the NFT
transactionCount String Transaction count of this NFT
minterAddress String The mint address of this NFT
storageMethod String The storage method of this NFT
mintTime String Mint time of this NFT
attributes Array Attributes of this NFT
title String The 'name' attribute in the metadata of this NFT, which can obtain ENS or DID.
> traitType String Trait type
> value String Trait value
> prevalence String Rarity of the attribute, expressed as a decimal, 0.1 = 10%

Historical transactions of the NFT

Get the list of NFT holder addresses. ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/nft-owner-address

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/nft-owner-address?chainShortName=ETH&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d&tokenId=3481

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Contract address for the collection
tokenId String Yes NFT token id
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "positionList": [
                {
                    "ownerAddress": "0x7285e8f0186a0a41e73cef7603ad7b80a2d5a793",
                    "logoUrl": "https://static.oklink.com/cdn/nft/files/d7169236-7cbb-4776-8a4c-3ef358f01fc9.webp",
                    "amount": "1"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
positionList Array List of addresses holding this nft
> ownerAddress String Holding address of this nft
> logoUrl String NFT's logo
> amount String Number of NFTs held by this address

NFT trader history

Get nft trade history. ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/nft-trade-history

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/nft-trade-history?chainShortName=eth&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d&tokenId=3481&activeType=sale&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Contract address for the collection
tokenId String Yes NFT token id
activeType String Yes Type of transaction: mint (creation), transfer, sale (completion)
page String No Page number
limit String No Number of results per request. The maximum is 100. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "0",
            "collectionName": "Bored Ape Yacht Club",
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "tokenId": "3481",
            "token": "BAYC",
            "historyList": [
                {
                    "amount": "1",
                    "createTime": "1685730899000",
                    "fromAddress": "0x4341f1bdd076760013ffc1aeff9fcf1c2c815fab",
                    "toAddress": "0x5f90dc9735d752e8ef296c045f66efc788a01126",
                    "price": "45.8640199999999965",
                    "priceSymbol": "ETH",
                    "usdPrice": "86760.5079937999981",
                    "marketplace": "LooksRare",
                    "actveType": "sale",
                    "txId": "0x2e925d817680ca70eb46e49f919b1406b86470fa10d50ce1649f57d3615a7bd9",
                    "invalid": false
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of results on the current page
totalPage String Total number of pages
collectionName String Full collection name
tokenContractAddress String Project contract address
tokenId String NFT token ID
token String Token name
logoUrl String Image link for the NFT
historyList Array Historical transaction list
> amount String Transaction amount
> createTime String Transaction creat time. Timestamp in milliseconds
> fromAddress String NFT sending address
> toAddress String NFT receiving address
> price String Transaction price
> priceSymbol String Price unit (e.g., ETH)
> usdPrice String Price in USD
> marketplace String Trading platform, e.g., LooksRare
> activeType String Type of transaction: mint, transfer, sale
> txId String Transaction hash
> invalid Bool Whether the transaction has expired (true or false)

Retrieve NFT offer list

Fetches the offer list for a specific NFT, displaying the order data of the specified NFT in various marketplaces. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/nft-offers-list

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/nft-offers-list?chainShortName=eth&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d&tokenId=3481&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Collection contract address.
tokenId String Yes NFT token ID.
marketplace String No NFT trading platforms (e.g., OpenSea, LooksRare, etc.)
page String No Page number
limit String No Number of results returned, max 100 per page, default is 20

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "140",
            "collectionName": "Bored Ape Yacht Club",
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "tokenId": "3481",
            "token": "BAYC",
            "offerList": [
                {
                    "amount": "1",
                    "createTime": "1683990533000",
                    "validTime": "1699542522000",
                    "price": "1",
                    "priceSymbol": "WETH",
                    "priceSymbolContractAddress": "",
                    "orderHash": "0x9fe5e206029ad24c077ca696b43218b7e236d0c871d07aa94f5367208bb9989e",
                    "ownerAddress": "0xf0ae1a04481a894ecd3dd231af914572bc289935",
                    "marketplace": "OKX",
                    "usdPrice": "1919.76"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of entries on the current page
totalPage String Total number of pages
collectionName String Full collection name
tokenContractAddress String Collection contract address
tokenId String NFT token ID
token String Token name
offerList Array List of bids
> amount String Offer amount
> createTime String Order create time (timestamp in milliseconds)
> validTime String Expiry time of the bid
> price String Bid price
> priceSymbol String Price unit
> priceSymbolContractAddress String Contract address of the price unit
> orderHash String Order hash
> ownerAddress String Bid order address
> marketplace String Trading platform (e.g., LooksRare)
> usdPrice String Value of the bid in USD

Retrieve NFT listing list

Fetches the listing list for a specific NFT, displaying the order data of the specified NFT in various marketplaces. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/nft-listing-list

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/nft-listing-list?chainShortName=eth&tokenContractAddress=0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d&tokenId=6137

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
tokenContractAddress String Yes Collection's contract address.
tokenId String Yes NFT token ID.
marketplace String No NFT trading platforms (e.g., OpenSea, LooksRare, etc.)
page String No Page number
limit String No Number of results returned, max 100 per page, default is 20

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "2",
            "collectionName": "Bored Ape Yacht Club",
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "tokenId": "6137",
            "token": "BAYC",
            "listingList": [
                {
                    "amount": "1",
                    "createTime": "1697470407000",
                    "validTime": "1697729593000",
                    "price": "26.98",
                    "priceSymbol": "ETH",
                    "priceSymbolContractAddress": "",
                    "orderHash": "0xce44938ed7af8565835b6bc2e57368093bba1fd29d05aa223f1a382d5d62a8d5",
                    "ownerAddress": "0x65a837220bddc55b67010adec2125e136ed19444",
                    "marketplace": "X2Y2",
                    "usdPrice": "41935.5536"
                },
                {
                    "amount": "1",
                    "createTime": "1697530292000",
                    "validTime": "2147443200000",
                    "price": "26.98",
                    "priceSymbol": "ETH",
                    "priceSymbolContractAddress": "",
                    "orderHash": "0x478e6e8ee59adfbd81d546af6757df6642e6e9d66b816306dc5305c668997d29",
                    "ownerAddress": "0x65a837220bddc55b67010adec2125e136ed19444",
                    "marketplace": "Blur",
                    "usdPrice": "41935.5536"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String Number of entries on the current page
totalPage String Total number of pages
collectionName String Full collection name
tokenContractAddress String Collection contract address
tokenId String NFT token ID
token String Token name
listingList Array List of listings
> amount String Listing amount
> createTime String Order listing time (timestamp in milliseconds)
> validTime String Expiry time of the listing
> price String Listing price
> priceSymbol String Price unit
> priceSymbolContractAddress String Contract address of the price unit
> orderHash String Order hash
> ownerAddress String Listing order address
> marketplace String Trading platform (e.g., LooksRare)
> usdPrice String Value of the listing in USD

The NFTs held by the address

Get the list of NFTs held by the specified address. The supported chains are ETH, OKTC, BSC, POLYGON, AVAXC, OP, ARBITRUM.

HTTP Request

GET /api/v5/explorer/nft/address-balance-fills

Consumption per query 1

Request Example

GET /api/v5/explorer/nft/address-balance-fills?chainShortName=oktc&address=0xda0d7f342b9c0f7f5f456e0c0a3ec6fe925eaef3&protocolType=token_721&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. BTC
address String Yes address
protocolType String Yes Protocol type
token_721
token_1155
tokenContractAddress String No Contract address for the collection
limit String No Number of results per request. The maximum is 100. The default is 20.
page String No Page

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "224",
            "tokenList": [
                {
                    "tokenContractAddress": "0x1e0e008eec6d04c52a3945d3df33d04e06a9c46f",
                    "tokenId": "5158",
                    "protocolType": "token_721",
                    "amount": "1",
                    "token": "GPF",
                    "logoUrl": "https://static.oklink.com/cdn/nft/files/65964236-8bd0-4985-9548-440c7953bc8c.webp"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenList Array Token list
> tokenContractAddress String The contract address of the collection
> tokenId String NFT id
> protocolType String Protocol type
> amount String The number of this NFT held by the address
> token String Token name
> logoUrl String NFT logo Url

Defi API

Get Defi lending (access, borrowing, and liquidation) transaction data, APY and TVL data of different Defi protocols on different chains.

Query Defi lending access transactions

Query Defi lending access transactions, and only return the latest 10,000 transaction data. The supported chain is ETH.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/defi/lending-access

Request Example

GET /api/v5/explorer/defi/lending-access?chainShortName=ETH&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
tokenContractAddress String No Token contract address; 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
maxAmount String No Transaction quantity range, maximum amount
minAmount String No Transaction quantity range, minimum amount
page String No Page
limit String No Number of results per request. The maximum is 100. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "transactionList": [
                {
                    "txId": "0x2fbb7b6c205851dff82fb27a8a9515fa032a5b6b69845ac6f4ba189967a87653",
                    "height": "18632143",
                    "transactionTime": "1700714831000",
                    "action": "supply",
                    "tokenContractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
                    "quantity": "1900000",
                    "amount": "1900000",
                    "project": "Aave V2",
                    "from": "0xf4dfcd61c36fc3ac374e52206c43253e14c2ffe2"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txId String Transaction hash
> height String Block height of the transaction
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> action String Transaction action: supply, redeem
> tokenContractAddress String Token contract address; 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token
> quantity String The supplied or redeemed quantity of the token
> amount String The transaction amount of the token. It is equal to the transaction quantity multiplied by the token price. The unit is USD.
> project String Defi lending project
> from String Sender address, multiple addresses separated by commas

Query Defi lending borrowing transactions

Query Defi lending borrowing transactions, and only return the latest 10,000 transaction data. The supported chain is ETH.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/defi/lending-borrow

Request Example

GET /api/v5/explorer/defi/lending-borrow?chainShortName=ETH&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
tokenContractAddress String No Token contract address; 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
maxAmount String No Transaction quantity range, maximum amount
minAmount String No Transaction quantity range, minimum amount
page String No Page
limit String No Number of results per request. The maximum is 100. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "transactionList": [
                {
                    "txId": "0xf370eb39e628abf10e120ee2af353fdb48172884495be5fa03065e51cebf1ae1",
                    "height": "18624454",
                    "transactionTime": "1700621867000",
                    "action": "repay",
                    "tokenContractAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "quantity": "25.22281301849709",
                    "amount": "49671.2295389268",
                    "project": "Aave V2"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txId String Transaction hash
> height String Block height of the transaction
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> action String Transaction action: loan, repay
> tokenContractAddress String Token contract address; 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token
> quantity String The borrowed or repaid quantity of the token
> amount String The transaction amount of the token. It is equal to the transaction quantity multiplied by the token price. The unit is USD.
> project String Defi lending project

Query Defi lending liquidation transactions

Query Defi lending liquidation transactions, and only return the latest 10,000 transaction data. The supported chain is ETH.

Consumption per query 5

HTTP Request

GET /api/v5/explorer/defi/lending-liquidate

Request Example

GET /api/v5/explorer/defi/lending-liquidate?chainShortName=ETH&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
tokenContractAddress String No Token contract address; 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token
startBlockHeight String No The height of the start block
endBlockHeight String No The height of the end block
maxAmount String No Transaction quantity range, maximum amount
minAmount String No Transaction quantity range, minimum amount
page String No Page
limit String No Number of results per request. The maximum is 100. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "1",
            "totalPage": "10000",
            "transactionList": [
                {
                    "txId": "0x1120c5ec58e4c5b7565bae56f916845b266213bac2be079607add92bbe51b4a2",
                    "height": "18623731",
                    "transactionTime": "1700613095000",
                    "tokenContractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
                    "quantity": "792.439819",
                    "amount": "792.439819",
                    "rewards": "828.09961",
                    "rewardsSymbol": "USDC",
                    "liquidator": "0xb6569481dccddd527c2b0e8ba32f494e52224ca1",
                    "project": "Aave V2"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txId String Transaction hash
> height String Block height of the transaction
> transactionTime String Transaction time. Unix timestamp format in milliseconds, e.g. 1597026383085
> tokenContractAddress String Token contract address; 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token
> quantity String The liquidation quantity of the token
> amount String The liquidation amount of the token. It is equal to the liquidation quantity multiplied by the token price. The unit is USD.
> rewards String The liquidation rewards
> rewardsSymbol String The symbol of the liquidation reward token
> liquidator String The liquidator
> project String Defi lending project

Defi APY and TVL

Query the Annual Percentage Yield (APY) or Annual Percentage Rate (APR), as well as the Total Value Locked (TVL) data of multiple Defi protocols on multiple public chains.

Supported Defi protocols and chains

Get the list of Defi protocols and chains supported in this module. Return in alphabetical order based on the first letter of Defi protocol by default.

Consumption per query 0

HTTP Request

GET /api/v5/explorer/defi/support-protocol

Request Example

GET /api/v5/explorer/defi/support-protocol

Request Parameters

Parameter Type Required Description
chainShortName String No Chain short name, e.g. ETH

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainShortName": "AVAX",
            "protocol": "Aave V2"
        },
        {
            "chainShortName": "ETH",
            "protocol": "Aave V2"
        },
        {
            "chainShortName": "MATIC",
            "protocol": "Aave V2"
        }
    ]
}

Response Parameters

Parameter Type Description
chainShortName String Chain short name, e.g. ETH
protocol String Defi protocol name

Query by tokens

Query the real-time and daily Annual Percentage Yield (APY) or Annual Percentage Rate (APR), as well as the Total Value Locked (TVL) data for different tokens on different public chains in various liquidity pools; only single-token pool queries are supported.
You can query the Defi protocols and chains we support by /api/v5/explorer/defi/support-protocol

Consumption per query 3

HTTP Request

GET /api/v5/explorer/defi/token-pool-data

Request Example

GET /api/v5/explorer/defi/token-pool-data?tokenContractAddress=0xdac17f958d2ee523a2206206994597c13d831ec7&chainShortName=ETH&protocol=Aave v3&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
tokenContractAddress String Yes Token contract address; 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token
protocol String Yes Defi protocol name
startTime String No Query the historical DeFi data of the token later than this date. Unix timestamp format in milliseconds, e.g. 1597026383085
endTime String No Query the historical DeFi data of the token earlier than this date. Unix timestamp format in milliseconds, e.g. 1597026383085
page String No Page
limit String No Number of results per request. The maximum is 100. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "limit": "1",
            "page": "1",
            "totalPage": "30",
            "chainShortName": "ETH",
            "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "protocol": "Aave V3",
            "rateType": "0",
            "rate": "0.04003",
            "borrowRateType": "1",
            "borrowRate": "0.0491",
            "tvl": "46893689.20997",
            "poolHistory": [
                {
                    "time": "1702828800000",
                    "historyRate": "0.05477",
                    "historyTvl": "39603860.76729802",
                    "historyBorrowRate": "0.06569"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainShortName String Chain short name, e.g. ETH
tokenContractAddress String Token contract address
protocol String Defi protocol name
rateType Array Supply rate type, 0 APY, 1 APR
rate String The current supply APY or APR of the token in this liquidity pool, data updated every hour
borrowRateType Array Borrow rate type, 0 APY, 1 APR, only applicable to Defi lending protocols
borrowRate String The current borrow APY or APR of the token in this liquidity pool, only applicable to Defi lending protocols, data updated every hour
tvl String The current TVL of the token in this liquidity pool, data updated every hour
poolHistory Array The historical APY and TVL data of the token in the liquidity pool
> time String Date, unix timestamp format in milliseconds, e.g. 1597026383085
> historyRate String The historical supply APY or APR data of the token in this liquidity pool, data updated daily
> historyTvl String The historical TVL data of the token in this liquidity pool, data updated daily
> historyBorrowRate String The historical borrow APY or APR data of the token in this liquidity pool, only applicable to Defi lending protocols, data updated daily

Query by pool address

Query the Annual Percentage Yield (APY) or Annual Percentage Rate (APR), as well as the Total Value Locked (TVL) data by pool address or LP token contract address.

Consumption per query 3

HTTP Request

GET /api/v5/explorer/defi/defi-pool-data

Request Example

GET /api/v5/explorer/defi/defi-pool-data?chainShortName=ETH&poolAddress=0x12392f67bdf24fae0af363c24ac620a2f67dad86

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain short name, e.g. ETH
poolAddress String Yes Defi pool contract address, or LP token contract address
startTime String No Query the historical DeFi data later than this date. Unix timestamp format in milliseconds, e.g. 1597026383085
endTime String No Query the historical DeFi data earlier than this date. Unix timestamp format in milliseconds, e.g. 1597026383085
page String No Page
limit String No Number of results per request. The maximum is 100. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "limit": "20",
            "page": "1",
            "totalPage": "2",
            "chainShortName": "ETH",
            "investmentName": "TUSD",
            "protocol": "Compound",
            "rateType": "0",
            "rate": "0.11277",
            "borrowRateType": "1",
            "borrowRate": "0.12144",
            "tvl": "769606.55705",
            "poolHistory": [
                {
                    "time": "1705334400000",
                    "historyRate": "0.05377",
                    "historyTvl": "630785.3408479508",
                    "historyBorrowRate": "0.06957"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
chainShortName String Chain short name, e.g. ETH
protocol String Defi protocol name
investmentName String Investment name
rateType Array Supply rate type, 0 APY, 1 APR
rate String The current supply APY or APR of the token in this liquidity pool, data updated every hour
borrowRateType Array Borrow rate type, 0 APY, 1 APR, only applicable to Defi lending protocols
borrowRate String The current borrow APY or APR of the token in this liquidity pool, only applicable to Defi lending protocols, data updated every hour
tvl String The current TVL of the token in this liquidity pool, data updated every hour
poolHistory Array The historical APY and TVL data of the token in the liquidity pool
> time String Date, unix timestamp format in milliseconds, e.g. 1597026383085
> historyRate String The historical supply APY or APR data of the token in this liquidity pool, data updated daily
> historyTvl String The historical TVL data of the token in this liquidity pool, data updated daily
> historyBorrowRate String The historical borrow APY or APR data of the token in this liquidity pool, only applicable to Defi lending protocols, data updated daily

Market Data

The Market Data function module interface provides full currency token market data for 200+ public chains. Based on the powerful parsing ability of the underlying layer, real-time parsing of the prices in the token pool provides users with the most comprehensive token market data.

Supported chains

Get the list of public chains supported in this module, which can be used to query the chainID of a specific chain. Return in alphabetical order based on the first letter of chainShortName by default.

HTTP Request

GET /api/v5/explorer/tokenprice/chain-list

Consumption per query 1

Request Example

GET /api/v5/explorer/tokenprice/chain-list

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainId": "260",
            "chainFullName": "Arkblock",
            "chainShortName": "ABT"
        },
        {
            "chainId": "787",
            "chainFullName": "Acala Network",
            "chainShortName": "ACA"
        }
    ]
}

Response Parameters

Parameter Type Description
chainList Array Supported chain list
> chainId String Unique identifier of the public chain.
> chainFullName String Chain full name, e.g. Bitcoin
> chainShortName String Chain short name, e.g. BTC

Token list

Query the list of 200+ public chain tokens to obtain their unique IDs.

HTTP Request

GET /api/v5/explorer/tokenprice/token-list

Consumption per query 1

Request Example

GET /api/v5/explorer/tokenprice/token-list?token=ordi

Request Parameters

Parameter Type Required Description
tokenUniqueId String No Chain id
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.
token String No Token

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "20",
            "totalPage": "1",
            "tokenList": [
                {
                    "tokenUniqueId": "18135625983068672",
                    "tokenFullName": "ordi",
                    "token": "ordi",
                    "network": [
                        {
                            "chainId": "56",
                            "chainFullName": "BNB Smart Chain",
                            "chainShortName": "BNB",
                            "tokenContractAddress": "0xf06aed41437f9e6d5b21812bb5d41fd709bc4f78"
                        }
                    ]
                },
                {
                    "tokenUniqueId": "18684748417958401",
                    "tokenFullName": "ordi",
                    "token": "ordi",
                    "network": [
                        {
                            "chainId": "0",
                            "chainFullName": "Bitcoin",
                            "chainShortName": "BTC",
                            "tokenContractAddress": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0"
                        }
                    ]
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
tokenList Array Token list
> tokenUniqueId String Token id
> tokenFullName String Token full name
> token String token
> network Array The network issued by this token
>> chainId String Chain id
>> chainFullName String Chain full name e.g, Bitcoin
>> chainShortName String Chain short name e.g, BTC
>> tokenContractAddress String Token contract address

Kline

Support querying the historical price data of over 200+ public chain tokens.

HTTP Request

GET /api/v5/explorer/tokenprice/historical

Consumption per query 1

Request Example

GET /api/v5/explorer/tokenprice/historical?chainId=0&tokenContractAddress=b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0&limit=2

Request Parameters

Parameter Type Required Description
chainId String Yes Chain id, you can query the chainId of the chains we support by /api/v5/explorer/tokenprice/chain-list
tokenContractAddress String No Token contract address, do not fill in this parameter, default to querying the historical data of this token.
limit String No Returns the number of data entries, with a default of 50 entries. A maximum of 200 entries can be returned for a single request
after String No Request the pagination content before this timestamp (older data), and the value passed is the time of the corresponding interface
before String No Request the pagination content after this timestamp (new data), and the value passed is the time of the corresponding interface
period String No Filter time granularity, default value of 1d [1m/5m/30m/1h/1D]

If you query the price of inscription tokens on Facet-VM, you need to add 'facet_' in front of the contract address, such as 'facet_0x55ab0390a89fed8992e3affbf61d102490735e24'.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "price": "3.271",
            "time": "1697644800000",
            "priceAbnormal": []
        },
        {
            "price": "3.129",
            "time": "1697558400000",
            "priceAbnormal": []
        }
    ]
}

Response Parameters

Parameter Type Description
price String Price
time String Update time
priceAbnormal String Abnormal price type
Low Liquidity, Disparity Between Sources, Abnormal Fluctuation

Batch query token price

You can batch query the price of up to 100 tokens. The price is the result of a comprehensive calculation of prices from multiple CEX and DEX. The supported chains are BTC, BCH, LTC, DASH, DOGE, ETH, OKTC, X1_TEST, BSC, ETC, POLYGON, AVAXC, ETHW, DIS, FTM, OP, ARBITRUM, KLAYTN, ZKSYNC, GNOSIS, RONIN, LINEA, POLYGON_ZKEVM, APT, SUI, TRON, BASE, SCROLL, OMEGA.

Consumption per query is 10

HTTP Request

GET /api/v5/explorer/tokenprice/price-multi

Request Example

GET /api/v5/explorer/token/tokenprice/price-multi?chainShortName=eth&tokenContractAddress=0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2,0x8d983cb9388eac77af0474fa441c4815500cb7bb

Request Parameters

Parameter Type Required Description
chainId String No Unique identifier of the public chain, you can query the chainId of the chains we support by /api/v5/explorer/tokenprice/chain-list. Either chainId or chainShortName must be chosen.
chainShortName String No Chain name, e.g, BTC, ETH. Either chainId or chainShortName must be chosen.
tokenContractAddress String Yes Token Contract Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "lastPrice": "6.397",
            "tokenContractAddress": "0x8d983cb9388eac77af0474fa441c4815500cb7bb",
            "priceAbnormal": []
        },
        {
            "lastPrice": "1395.5956462884245",
            "tokenContractAddress": "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2",
            "priceAbnormal": []
        }
    ]
}

Response Parameters

Parameter Type Description
lastPrice String The latest price of the token, updated every minute.
tokenContractAddress String Token Contract Address
priceAbnormal String Abnormal price type
Low Liquidity, Disparity Between Sources, Abnormal Fluctuation

Token market data

It supports the query of Market data information of 200+ public chain tokens and provides details of all currencies in the market.

HTTP Request

GET /api/v5/explorer/tokenprice/market-data

Consumption per query 2

Request Example

GET /api/v5/explorer/tokenprice/market-data?chainId=0&tokenContractAddress=b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0

Request Parameters

Parameter Type Required Description
chainId String Yes Chain id, you can query the chainId of the chains we support by /api/v5/explorer/tokenprice/chain-list
tokenContractAddress String No Token contract address, do not fill in this parameter, default to querying the historical data of this token.

If you query the price of inscription tokens on Facet-VM, you need to add 'facet_' in front of the contract address, such as 'facet_0x55ab0390a89fed8992e3affbf61d102490735e24'.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "lastPrice": "3.412",
            "totalSupply": "71946000",
            "circulatingSupply": "21000000",
            "volume24h": "10030.84212626599936",
            "marketCap": "71946000",
            "high24h": "3.546",
            "low24h": "3.193",
            "priceAbnormal": []
        }
    ]
}

Response Parameters

Parameter Type Description
lastPrice String Last price
totalSupply String Total supply
maxSupply String Max supply
circulatingSupply String Supply
volume24h String 24-hour trading volume
marketCap String Market cap
high24h String 24-hour maximum price
low24h String 24-hour minimum price
priceAbnormal String Abnormal price type
Low Liquidity, Disparity Between Sources, Abnormal Fluctuation

Tracker

Obtain transaction by transaction data from a certain Dex, up to 10000 entries can be queried.

HTTP Request

GET /api/v5/explorer/tokenprice/tracker

Consumption per query 1

Request Example

GET /api/v5/explorer/tokenprice/tracker?chainId=1&limit=2

Request Parameters

Parameter Type Required Description
chainId String Yes Chain id, you can query the chainId of the chains we support by /api/v5/explorer/tokenprice/chain-list
poolAddress String No Pool address
tokenContractAddress String No Token contract address
dexName String No Dex
height String No height
page String No Page
limit String No Number of results per request. The maximum is 50. The default is 20.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "page": "1",
            "limit": "2",
            "totalPage": "5000",
            "transactionList": [
                {
                    "txId": "0x7bc10ebc1a151e1d13117edcca38f1e0c28f2faf4b4205970ac2005d181235b1",
                    "poolAddress": "0x42bc8892085648c1d4b647e405a947f1e0badd38",
                    "tokenInAmount": "0.04",
                    "tokenInContractAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "tokenOutAmount": "2315878.592885542",
                    "tokenOutContractAddress": "0x857f4fe9426f48526efccf55e7528f6dd5ece6fd",
                    "dexName": "Balancer V2",
                    "factoryAddress": "0xba12222222228d8ba445958a75a0704d566bf2c8",
                    "transactionAmountUsd": "62.08102743967378",
                    "transactionTime": "1697703791000",
                    "height": "18383165",
                    "index": "237",
                    "traderAddress": "0x2461d9eafa23ffcfe242ed501c1687616a3ec95f"
                },
                {
                    "txId": "0xd2689e38ba03a8465046ae2154f0d3407d5e5eb9f021bdee0542337abefaeb9c",
                    "poolAddress": "0x10027efa7bfd14ac56de5c7e3427efa857d182ee",
                    "tokenInAmount": "0.007",
                    "tokenInContractAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "tokenOutAmount": "1274359.422601473",
                    "tokenOutContractAddress": "0xa49f4dc8101c84678ac6f0f15c2676d3d8362bd0",
                    "dexName": "Uniswap V2",
                    "factoryAddress": "0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f",
                    "transactionAmountUsd": "10.864179801942912",
                    "transactionTime": "1697703791000",
                    "height": "18383165",
                    "index": "234",
                    "traderAddress": "0x8b6d9e300d29bd349f5bdf1fbcac02ba8b97b083"
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
page String Current page number
limit String The amount of data
totalPage String Total number of pages
transactionList Array Transaction list
> txId String Transaction hash
> poolAddress String Pool address
> tokenInAmount String Amount of tokens transferred in
> tokenInContractAddress String Token contract address of tokens transferred in
> tokenOutAmount String Amount of tokens transferred out
> tokenOutContractAddress String Token contract address of tokens transferred out
> dexName String Dex
> factoryAddress String Factory address
> transactionAmountUsd String Transaction amount, in USD
> transactionTime String Transaction time
> height String Height
> index String index
> traderAddress String Trader address

On-chain Tools

Verify contract, retrieve authorization list for an address, scan the internet domain risk, and broadcast transactions.

Contract verification

Source code verification provides a way for projects to open source their smart contract code for end users to inspect and verify that it does what it claims to do and improve the transparency.

Endpoints of the "Contract verification" module support submitting contract source code for contract verification, verifying proxy contracts, and querying the contract ABI and source code of already verified contracts.

The supported chains are: ETH, X1_TEST, BSC, POLYGON, AVAXC, FTM, OP, ARBITRUM, LINEA, MANTA, POLYGON_ZKEVM, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Verify source code

By uploading the contract source code, OKLink explorer will match the compiled contract bytecode with the bytecode on the blockchain and display it on the contract page of the explorer.

You can use this endpoint to quickly verify contracts and improve verification efficiency. The average processing time for contract verification is between 30-60 seconds.

The supported chains are: ETH, X1_TEST, BSC, POLYGON, AVAXC, FTM, OP, ARBITRUM, LINEA, MANTA, POLYGON_ZKEVM, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 0

HTTP Request

POST /api/v5/explorer/contract/verify-source-code

Request Example

POST /api/v5/explorer/contract/verify-source-code
body
{
    "chainShortName":"ETH",
    "contractAddress":"0x9Dca580D2c8B8e19e9d77345a5b4C2820B25b386",
    "contractName":"HelloWorld",
    "sourceCode":"pragma solidity ^0.7.6;↵contract HelloWorl {↵ string public greet = 'Hello Worl!';↵}",
    "codeFormat":"solidity-single-file",
    "compilerVersion":"v0.7.6+commit.7338295f",
    "optimization":"1",
    "optimizationRuns":"200",
    "contractAbi":"0xfce353f66162630000000000000000000000000",
    "evmVersion":"tangerineWhistle",
    "viaIr":false,
    "libraryInfo":[
        {
        "libraryName":"libraryName1",
        "libraryAddress":"0xCfE28868F6E0A24b7333D22D8943279e76aC2cdc"
        },
        {
        "libraryName":"libraryName2",
        "libraryAddress":"0xCfE28868F6E0A24b7333D22D8943279e76aC2cdc"
        },
        {
        "libraryName":"libraryName3",
        "libraryAddress":"0xCfE28868F6E0A24b7333D22D8943279e76aC2cdc"
        }
    ]
}

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
contractAddress String Yes Contract address
contractName String Yes Contract name
sourceCode String Yes Source code of the contract.
If your contract uses "imports", you will need to concatenate the code into one file (otherwise known as "flattening") as we do not support "imports" in separate files.
You can use Solidity flatteners like SolidityFlattery(by@DaveAppleton)
codeFormat String Yes Code format, we support solidity-single-file, solidity-standard-json-input, Vyper
compilerVersion String Yes Compiler version used, e.g., v0.7.6+commit.7338295f, vyper:0.2.11.
You can check the supported compiler versions for contract verification in the OKLink Explorer under the Verify Contract section
optimization String Yes Whether optimization was used when compiling the contract, 0 for no optimization, 1 if optimization was used
optimizationRuns String No The number of runs if optimization was used, e.g., 200
contractAbi String No Contract ABI
evmVersion String No EVM version of contract compilation, leave blank for default compiler, specify if others such as tangerineWhistle, spuriousDragon, byzantium
licenseType String No Open source license type, leave blank for default No License
viaIr Bol No Whether to introduce an IR-based code generator, should be consistent with your compiling setting; true / false, false by default
libraryInfo Array No Library info used in contract.
The libraryName and libraryAddress must be matched one by one.
We support up to 10 different libraries.
> libraryName String No Library name
> libraryAddress String No Library address, e.g., 0xCfE28868F6E0A24b7333D22D8943279e76aC2cdc

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        "eb5c06099d3841359d398541166343fe"
    ]
}

Response Parameters

Parameter Type Description
guid String A GUID is returned upon successful submission, which can be used to query the verification result

Check source code verification result

After submitting the source code verification, you can query the result with the GUID returned.
The supported chains are: ETH, X1_TEST, BSC, POLYGON, AVAXC, FTM, OP, ARBITRUM, LINEA, MANTA, POLYGON_ZKEVM, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 0

HTTP Request

POST /api/v5/explorer/contract/check-verify-result

Request Example

POST /api/v5/explorer/contract/check-verify-result
body
{
    "chainShortName":"ETH",
    "guid":"eb5c06099d3841359d398541166343fe"
}

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
guid String Yes Query the source code verification result with the GUID returned

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        "Success"
    ]
}

Response Parameters

Parameter Type Description
result String Contract source code verification result
Success,Fail,Pending

Verify source code with hardhat

To verify a contract using hardhat plugin, you need to make the following modifications to the hardhat.config.js file:

Take the ETH chain as an example:

module.exports = {
    ...
    etherscan: {
        apiKey: {OKLink API key},
        customChains: [
            {
                network: "eth",
                chainId: 1,
                urls: {
                    apiURL: "https://www.oklink.com/api/explorer/v1/contract/verify/async/api/eth",
                    browserURL: "https://www.oklink.com/eth",
                }
            }
        ]
    }
};

Verify proxy contract

Verify whether a proxy contract implements the contract as expected.
The supported chains are: ETH, X1_TEST, BSC, POLYGON, AVAXC, FTM, OP, ARBITRUM, LINEA, MANTA, POLYGON_ZKEVM, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 0

HTTP Request

POST /api/v5/explorer/contract/verify-proxy-contract

Request Example

POST /api/v5/explorer/contract/verify-proxy-contract
body
{
    "chainShortName": "ETH",
    "proxyContractAddress": "0xfeee12d53ddb7ce61ee467ddf7243212a953174a",
    "expectedImplementation": "0x0ecbefc71524068cf18f9d4e50d787e134ee70b8"
}

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
proxyContractAddress String Yes Proxy contract address
expectedImplementation String No Verify whether the implementation contract for the proxy contract is this address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        "4f2e75682f75410f958c0a3bbf754358"
    ]
}

Response Parameters

Parameter Type Description
guid String A GUID is returned upon successful submission, which can be used to query the verification result

Check proxy contract verification result

After submitting the proxy contract verification, you can query the result with the GUID returned.
The supported chains are: ETH, X1_TEST, BSC, POLYGON, AVAXC, FTM, OP, ARBITRUM, LINEA, MANTA, POLYGON_ZKEVM, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 0

HTTP Request

POST /api/v5/explorer/contract/check-proxy-verify-result

Request Example

POST /api/v5/explorer/contract/check-proxy-verify-result
body
{
    "chainShortName":"ETH",
    "guid":"4f2e75682f75410f958c0a3bbf754358"
}

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
guid String Yes Query the proxy contract verification result with the GUID returned

Response Example

{
    "code": "0",
    "msg": "The proxy's (0x826427966fb2e7edee940c5d99b7d66062faef2e) implementation contract is found at 0xd4a2dca4e03713d5bf7d2173237058466a9c1be4 and is successfully updated.",
    "data": []
}

Response Parameters

Parameter Type Description
result String Proxy contract verification result.
If the verification is successful, return the address of the implementation contract.
If the verification fails, return "A corresponding implementation contract was unfortunately not detected for the proxy address."

Query info for verified contract

Query the contract ABI, source code and other basic information of the verified contract, or query the implementation contract address information of the verified proxy contract.
The supported chains are: ETH, X1_TEST, BSC, POLYGON, AVAXC, FTM, OP, ARBITRUM, LINEA, MANTA, POLYGON_ZKEVM, SEPOLIA_TESTNET, GOERLI_TESTNET, AMOY_TESTNET, MUMBAI_TESTNET, POLYGON_ZKEVM_TESTNET

Consumption per query 0

HTTP Request

GET /api/v5/explorer/contract/verify-contract-info

Request Example

/api/v5/explorer/contract/verify-contract-info?chainShortName=ETH&contractAddress=0xcF80631b469A54dcba8c8ee1aF84505f496ed248

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
contractAddress String Yes Contract address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "sourceCode": "// proxy.sol - execute actions atomically through the proxy's identity\r\n\r\n// Copyright (C) 2017  DappHub, LLC\r\n\r\n// This program is free software: you can redistribute it and/or modify\r\n// it under the terms of the GNU General Public License as published by\r\n// the Free Software Foundation, either version 3 of the License, or\r\n// (at your option) any later version.\r\n\r\n// This program is distributed in the hope that it will be useful,\r\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\r\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r\n// GNU General Public License for more details.\r\n\r\n// You should have received a copy of the GNU General Public License\r\n// along with this program.  If not, see <http://www.gnu.org/licenses/>.\r\n\r\npragma solidity ^0.4.23;\r\n\r\ncontract DSAuthority {\r\n    function canCall(\r\n        address src, address dst, bytes4 sig\r\n    ) public view returns (bool);\r\n}\r\n\r\ncontract DSAuthEvents {\r\n    event LogSetAuthority (address indexed authority);\r\n    event LogSetOwner     (address indexed owner);\r\n}\r\n\r\ncontract DSAuth is DSAuthEvents {\r\n    DSAuthority  public  authority;\r\n    address      public  owner;\r\n\r\n    constructor() public {\r\n        owner = msg.sender;\r\n        emit LogSetOwner(msg.sender);\r\n    }\r\n\r\n    function setOwner(address owner_)\r\n        public\r\n        auth\r\n    {\r\n        owner = owner_;\r\n        emit LogSetOwner(owner);\r\n    }\r\n\r\n    function setAuthority(DSAuthority authority_)\r\n        public\r\n        auth\r\n    {\r\n        authority = authority_;\r\n        emit LogSetAuthority(authority);\r\n    }\r\n\r\n    modifier auth {\r\n        require(isAuthorized(msg.sender, msg.sig));\r\n        _;\r\n    }\r\n\r\n    function isAuthorized(address src, bytes4 sig) internal view returns (bool) {\r\n        if (src == address(this)) {\r\n            return true;\r\n        } else if (src == owner) {\r\n            return true;\r\n        } else if (authority == DSAuthority(0)) {\r\n            return false;\r\n        } else {\r\n            return authority.canCall(src, this, sig);\r\n        }\r\n    }\r\n}\r\n\r\ncontract DSNote {\r\n    event LogNote(\r\n        bytes4   indexed  sig,\r\n        address  indexed  guy,\r\n        bytes32  indexed  foo,\r\n        bytes32  indexed  bar,\r\n        uint              wad,\r\n        bytes             fax\r\n    ) anonymous;\r\n\r\n    modifier note {\r\n        bytes32 foo;\r\n        bytes32 bar;\r\n\r\n        assembly {\r\n            foo := calldataload(4)\r\n            bar := calldataload(36)\r\n        }\r\n\r\n        emit LogNote(msg.sig, msg.sender, foo, bar, msg.value, msg.data);\r\n\r\n        _;\r\n    }\r\n}\r\n\r\n// DSProxy\r\n// Allows code execution using a persistant identity This can be very\r\n// useful to execute a sequence of atomic actions. Since the owner of\r\n// the proxy can be changed, this allows for dynamic ownership models\r\n// i.e. a multisig\r\ncontract DSProxy is DSAuth, DSNote {\r\n    DSProxyCache public cache;  // global cache for contracts\r\n\r\n    constructor(address _cacheAddr) public {\r\n        require(setCache(_cacheAddr));\r\n    }\r\n\r\n    function() public payable {\r\n    }\r\n\r\n    // use the proxy to execute calldata _data on contract _code\r\n    function execute(bytes _code, bytes _data)\r\n        public\r\n        payable\r\n        returns (address target, bytes32 response)\r\n    {\r\n        target = cache.read(_code);\r\n        if (target == 0x0) {\r\n            // deploy contract & store its address in cache\r\n            target = cache.write(_code);\r\n        }\r\n\r\n        response = execute(target, _data);\r\n    }\r\n\r\n    function execute(address _target, bytes _data)\r\n        public\r\n        auth\r\n        note\r\n        payable\r\n        returns (bytes32 response)\r\n    {\r\n        require(_target != 0x0);\r\n\r\n        // call contract in current context\r\n        assembly {\r\n            let succeeded := delegatecall(sub(gas, 5000), _target, add(_data, 0x20), mload(_data), 0, 32)\r\n            response := mload(0)      // load delegatecall output\r\n            switch iszero(succeeded)\r\n            case 1 {\r\n                // throw if delegatecall failed\r\n                revert(0, 0)\r\n            }\r\n        }\r\n    }\r\n\r\n    //set new cache\r\n    function setCache(address _cacheAddr)\r\n        public\r\n        auth\r\n        note\r\n        returns (bool)\r\n    {\r\n        require(_cacheAddr != 0x0);        // invalid cache address\r\n        cache = DSProxyCache(_cacheAddr);  // overwrite cache\r\n        return true;\r\n    }\r\n}\r\n\r\n// DSProxyFactory\r\n// This factory deploys new proxy instances through build()\r\n// Deployed proxy addresses are logged\r\ncontract DSProxyFactory {\r\n    event Created(address indexed sender, address indexed owner, address proxy, address cache);\r\n    mapping(address=>bool) public isProxy;\r\n    DSProxyCache public cache = new DSProxyCache();\r\n\r\n    // deploys a new proxy instance\r\n    // sets owner of proxy to caller\r\n    function build() public returns (DSProxy proxy) {\r\n        proxy = build(msg.sender);\r\n    }\r\n\r\n    // deploys a new proxy instance\r\n    // sets custom owner of proxy\r\n    function build(address owner) public returns (DSProxy proxy) {\r\n        proxy = new DSProxy(cache);\r\n        emit Created(msg.sender, owner, address(proxy), address(cache));\r\n        proxy.setOwner(owner);\r\n        isProxy[proxy] = true;\r\n    }\r\n}\r\n\r\n// DSProxyCache\r\n// This global cache stores addresses of contracts previously deployed\r\n// by a proxy. This saves gas from repeat deployment of the same\r\n// contracts and eliminates blockchain bloat.\r\n\r\n// By default, all proxies deployed from the same factory store\r\n// contracts in the same cache. The cache a proxy instance uses can be\r\n// changed.  The cache uses the sha3 hash of a contract's bytecode to\r\n// lookup the address\r\ncontract DSProxyCache {\r\n    mapping(bytes32 => address) cache;\r\n\r\n    function read(bytes _code) public view returns (address) {\r\n        bytes32 hash = keccak256(_code);\r\n        return cache[hash];\r\n    }\r\n\r\n    function write(bytes _code) public returns (address target) {\r\n        assembly {\r\n            target := create(0, add(_code, 0x20), mload(_code))\r\n            switch iszero(extcodesize(target))\r\n            case 1 {\r\n                // throw if contract failed to deploy\r\n                revert(0, 0)\r\n            }\r\n        }\r\n        bytes32 hash = keccak256(_code);\r\n        cache[hash] = target;\r\n    }\r\n}",
            "contractName": "DSProxy",
            "compilerVersion": "v0.4.23+commit.124ca40d",
            "optimization": "1",
            "optimizationRuns": "200",
            "contractAbi": "[{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"owner_\",\"type\":\"address\"}],\"name\":\"setOwner\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"_target\",\"type\":\"address\"},{\"indexed\":false,\"name\":\"_data\",\"type\":\"bytes\"}],\"name\":\"execute\",\"outputs\":[{\"name\":\"response\",\"type\":\"bytes32\"}],\"payable\":true,\"stateMutability\":\"payable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"_code\",\"type\":\"bytes\"},{\"indexed\":false,\"name\":\"_data\",\"type\":\"bytes\"}],\"name\":\"execute\",\"outputs\":[{\"name\":\"target\",\"type\":\"address\"},{\"name\":\"response\",\"type\":\"bytes32\"}],\"payable\":true,\"stateMutability\":\"payable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"cache\",\"outputs\":[{\"name\":\"\",\"type\":\"address\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"authority_\",\"type\":\"address\"}],\"name\":\"setAuthority\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"owner\",\"outputs\":[{\"name\":\"\",\"type\":\"address\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"_cacheAddr\",\"type\":\"address\"}],\"name\":\"setCache\",\"outputs\":[{\"name\":\"\",\"type\":\"bool\"}],\"payable\":false,\"