NAV
中文

Welcome to OKLink API

Business API is built on OKLink on-chain data and proprietary clustering labeling algorithms which help you to make a better investment decision in this ever-evolving crypto market. We provide industry leading on-chain data covering 99% of crypto assets. Combined with our crypto analytic tool, OKLink gains you access to the holistic view of a specific project or broader crypto market.

The browser API currently supports the following public chains: Bitcoin,Bitcoin Cash, Ethereum, OKT Chain, OKB Chain Test, BNB Chain, Ethereum Classic, Litecoin, DASH, TRON, Polygon, Avalanche-C, Aptos, EthereumPoW, EthereumFair, Fantom, OP Mainnet, Arbitrum One, Dogecoin, Sui, Klaytn, zkSync Era, Gnosis, Ronin, and will gradually support more chains. You can query the list of chains to retrieves the list of crypto networks supported by Network module。

Once you're logged to your OKLink account, go to create your dedicated API key and access the vast API data. Create

API key is the unique identifier used for accessing API endpoints. All OpenAPI endpoints require API key authentication for access.

Root URL for API:

API Interface Access Request Example:

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

You can also reach us by: :

Every time an API is called, it will consume a certain amount of calls. The cost for most API is either 1 or 2, and specific consumption information can be seen in the table below.

API Path Cost
Query the list of chains GET /api/v5/explorer/blockchain/summary 1
Query public chain details GET /api/v5/explorer/blockchain/info 1
Query address overview GET /api/v5/explorer/blockchain/address 1
Query block basic information GET /api/v5/explorer/blockchain/block 1
Query the best handling fee or gas fee GET /api/v5/explorer/blockchain/fee 1
Query the basic information of computing power GET /api/v5/explorer/blockchain/hashes 1
Query basic mining information GET /api/v5/explorer/blockchain/mine 1
Query on chain transaction information GET /api/v5/explorer/blockchain/transaction 1
Query block header details GET /api/v5/explorer/block/block-fills 1
Query block list GET /api/v5/explorer/block/block-list 1
Query block transaction list GET /api/v5/explorer/block/transaction-list 1
Query address balance details GET /api/v5/explorer/address/address-balance-fills 1
Query address information GET /api/v5/explorer/address/address-summary 1
Top 100 richest addresses GET /api/v5/explorer/address/rich-list 1
Query address transaction list information GET /api/v5/explorer/address/transaction-list 1
Query utxo GET /api/v5/explorer/address/unspent 1
Query utxo amount GET /api/v5/explorer/address/utxo 1
Query the mining pool share GET /api/v5/explorer/pool/estimated-pool-share 1
Get the mining pool hashrate ranking GET /api/v5/explorer/pool/pool-hashrate-rank 1
Validator GET /api/v5/explorer/pool/validator-list 1
Query the list of large value transactions GET /api/v5/explorer/transaction/large-transaction-list 1
Query transaction details GET /api/v5/explorer/transaction/transaction-fills 1
Query transaction list information GET /api/v5/explorer/transaction/transaction-list 1
Query the list of unconfirmed transactions GET /api/v5/explorer/transaction/unconfirmed-transaction-list 1
Send transaction POST /api/v5/explorer/transaction/publish-tx 5
Parse the transaction POST /api/v5/explorer/transaction/decode 5
Query token list information GET /api/v5/explorer/token/token-list 1
Query token position list details GET /api/v5/explorer/token/position-list 1
Query token transfer details GET /api/v5/explorer/token/transaction-list 1
Query usdt printing destruction list GET /api/v5/explorer/stablecoin/printing-record 1
Query proof of reserves GET /api/v5/explorer/por/proof-of-reserves 5
Query proof of reserves history GET /api/v5/explorer/por/institution-history-asset 5
Query address balance details GET /api/v5/explorer/por/address-balance-details 5
Query the eth supply change overview GET /api/v5/explorer/deflation/supply 5
Query the eth staking GET /api/v5/explorer/deflation/supply-burn 5
Query the eth supply and burn GET /api/v5/explorer/deflation/pos-staking?chainShortName=eth 5
Query the gas consumption GET /api/v5/explorer/deflation/gas 5
Defi address authorized tokens list GET /api/v5/tracker/contractscanner/token-authorized-list 1
Tracker GET /api/v5/explorer/tokenprice/tracker 1
Token list GET /api/v5/explorer/tokenprice/token-list 1
Market data GET /api/v5/explorer/tokenprice/market-data 2
Historical GET /api/v5/explorer/tokenprice/historical 1
NFT chain list GET /api/v5/explorer/nft/chain-list 1
NFT NFT market overview GET /api/v5/explorer/nft/nft-stats-overview 1
NFT Query the NFT held by the address GET /api/v5/explorer/nft/nft-owner-address 1
NFT Query the address of the NFT holder GET /api/v5/explorer/nft/address-balance-fills 1
NFT position list GET /api/v5/explorer/token/position-list 1
NFT NFT details GET /api/v5/explorer/nft/nft-details 1
NFT collection info GET /api/v5/explorer/nft/collection-info 1
NFT collection details GET /api/v5/explorer/nft/collection-details 1
NFT collection NFT list GET /api/v5/explorer/nft/collection-nft-list 1
BRC20 Query inscriptions list GET /api/v5/explorer/btc/inscriptions-list 1
BRC20 Query token list GET /api/v5/explorer/btc/token-list 1
BRC20 Query token details GET /api/v5/explorer/btc/token-details 1
BRC20 Query token position address list GET /api/v5/explorer/btc/position-list 1
BRC20 Query token transfer list GET /api/v5/explorer/btc/transaction-list 1
BRC20 Query address balance list GET /api/v5/explorer/btc/address-balance-list 1
BRC20 Query address balance details GET /api/v5/explorer/btc/address-balance-details 1
Historical transactions of the NFT GET /api/v5/explorer/nft/nft-trade-history 1
Retrieve NFT offer list GET /api/v5/explorer/nft/nft-offers-list 1
Retrieve NFT listing list GET /api/v5/explorer/nft/nft-listing-list 1

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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "lastHeight": "15495964",
            "lastBlockTime": "1662631619000",
            "circulatingSupply": "119663643.32797343",
            "circulatingSupplyProportion": "1",
            "transactions": "1703527016"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String The blockchain network full name, e.g., Bitcoin.
chainShortName String The blockchain network short name, e.g., BTC.
symbol String The native token symbol, e.g., btc.
lastHeight String Last height
lastBlockTime String Last block time;Unix timestamp format in milliseconds, e.g. 1597026383085
circulatingSupply String Circulating supply (also equals current total supply)
circulatingSupplyProportion String The ratio of the circulating quantity to the total supply, displayed in decimals, for example: 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

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,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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "rank": "2",
            "mineable": true,
            "algorithm": "Ethash ",
            "consensus": "PoW+PoS",
            "diffEstimation": "",
            "currentDiff": "12.34P",
            "diffAdjustTime": "",
            "circulatingSupply": "119663990.60586369",
            "totalSupply": "119663990.60586369",
            "tps": "12.41",
            "lastHeight": "15496152",
            "lastBlockTime": "1662634452000",
            "issueDate": "1406131200000"
        }
    ]
}

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, eg: btc
rank String Rank
mineable Bol Whether to support mining
true
false
algorithm String The core algorithm, for example: SHA-256
consensus String Consensus algorithm, for example: 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 (also equals current total supply)
totalSupply String Max total supply
tps String tps
lastHeight String Last 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 address overview

Get the basic information of the currency holding addresses of the public chains currently supported by OKLink

HTTP Request

GET /api/v5/explorer/blockchain/address

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/address?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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "validAddressCount": "86297889",
            "newAddressCount24h": "35792",
            "totalAddresses": "254039543",
            "newTotalAddresses24h": "69827",
            "contractAddresses": "50892123",
            "newContractAddresses24h": "6342",
            "externalAddresses": "203147420",
            "newExternalAddresses24h": "63485",
            "activeAddresses": "494966",
            "newActiveAddresses": "8926"
        }
    ]
}

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, eg: btc
validAddressCount String Holding Addresses
newAddressCount24h String Increment / decrement of the past 24-hour period comparing to the previous one
totalAddresses String Total Addresses
newTotalAddresses24h String Increment / decrement of the past 24-hour period comparing to the previous one
contractAddresses String Contract Addresses
newContractAddresses24h String Increment / decrement of the past 24-hour period comparing to the previous one
externalAddresses String External Addresses
newExternalAddresses24h String Increment / decrement of the past 24-hour period comparing to the previous one
activeAddresses String Active Addresses
newActiveAddresses String Increment / decrement of the past 24-hour period comparing to the previous one

Query block basic information

Obtain the basic information of the detailed blocks of the chains currently supported by OKLink

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,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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "lastHeight": "15496201",
            "firstExchangeHistoricalTime": "1406131200000",
            "firstBlockTime": "1406131200000",
            "firstBlockHeight": "0",
            "avgBlockInterval": "14.392",
            "avgBlockSize24h": "",
            "avgBlockSize24hPercent": "0",
            "mediaBlockSize": "65692.99815616556",
            "halveTime": ""
        }
    ]
}

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, eg: btc
lastHeight String 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 the best handling fee or gas fee

Get the basic information of the gas fee of the public chain currently supported by OKLink

HTTP Request

GET /api/v5/explorer/blockchain/fee

Consumption per query 1

Request Example

GET /api/v5/explorer/blockchain/fee?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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "bestTransactionFee": "",
            "recommendedGasPrice": "90.111827841",
            "rapidGasPrice": "91.411827841",
            "standardGasPrice": "90.111827841",
            "slowGasPrice": "90.011827841"
        }
    ]
}

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, eg: btc
bestTransactionFee String Best transaction fee
recommendedGasPrice String Recommended gas fee, unit. 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

Query the basic information of computing power

Get the basic information of the public chain computing power currently supported by OKLink.

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,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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "hashRate": "891.47TH",
            "hashRateChange24h": "-0.0561"
        }
    ]
}

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, eg: btc
hashrate String hashrate
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 currently supported by OKLink

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,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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "avgMineReward24h": "",
            "minerIncomePerUnit": "0.024509833699208023",
            "minerIncomePerUnitCoin": "0.000015118887757508927"
        }
    ]
}

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, eg: 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

Query on-chain transaction information

Get the basic transaction information on the public chain currently supported by OKLink

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": "Ethereum",
            "chainShortName": "ETH",
            "symbol": "ETH",
            "pendingTransactionCount": "147373",
            "transactionValue24h": "2309415",
            "totalTransactionCount": "1703578474",
            "tranRate": "12.34",
            "avgTransactionCount24h": "",
            "avgTransactionCount24hPercent": "",
            "pendingTransactionSize": ""
        }
    ]
}

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, eg: btc
pendingTransactionCount String Pending transaction count
transactionValue24h String Transaction value 24h
totalTransactionCount String Total transaction count
tranRate String Tran rate
avgTransactionCount24h String Avg transaction count 24h
avgTransactionCount24hPercent String Avg transaction count 24h percent
pendingTransactionSize String Pending transaction size

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 currently supported by OKLink.

HTTP Request

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

Consumption per query 1

Request Example

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

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
height String Yes Height
netWork String No Chain name ,USDT This field is required,

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "hash": "0xb837772ccffca8ffc56a5744c61eb49a13359068b971e4c47c602a708341dff0",
            "height": "14636119",
            "validator": "unknown",
            "blockTime": "1650650059000",
            "txnCount": "388",
            "amount": "581.754319526449",
            "blockSize": "154506",
            "mineReward": "2.1135572588660683",
            "totalFee": "1.665664869236147",
            "feeSymbol": "ETH",
            "ommerBlock": "0",
            "merkleRootHash": "0x545d4b8b000af4cdd1311c4b671c973447c9e456b986873c9b07a3686e1cad9e",
            "gasUsed": "27606791",
            "gasLimit": "29941410",
            "gasAvgPrice": "0.00000006033533087",
            "state": "",
            "burnt": "1.5521076103700786",
            "netWork": "",
            "txnInternal": "151",
            "miner": "0x2a20380dca5bc24d052acfbf79ba23e988ad0050",
            "difficuity": "13408168967664674",
            "nonce": "9dcedb3be62945a2",
            "tips": "0.08107281539769584",
            "confirm": "860638",
            "baseFeePerGas": "0.000000056221949533"
        }
    ]
}

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 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 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 Ommer block
merkleRootHash String Merkle root hash
gasUsed String Gas
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 For example: 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 Confirmation
tips String tips
baseFeePerGas String Basic fee per Gas, ETH, in Gwei

Query block list

Get the block list information of the public chains currently supported by OKLink, and only return nearly 10,000 block list data

HTTP Request

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

Consumption per query 1

Request Example

GET /api/v5/explorer/block/block-list?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
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": "20",
            "totalPage": "1",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "blockList": [
                {
                    "hash": "0xb837772ccffca8ffc56a5744c61eb49a13359068b971e4c47c602a708341dff0",
                    "height": "14636119",
                    "validator": "unknown",
                    "blockTime": "1650650059000",
                    "txnCount": "388",
                    "blockSize": "154506",
                    "mineReward": "2.1135572588660683",
                    "totalFee": "1.665664869236147",
                    "feeSymbol": "ETH",
                    "avgFee": "0",
                    "ommerBlock": "0",
                    "gasUsed": "27606791",
                    "gasLimit": "29941410",
                    "gasAvgPrice": "0.00000006033533087",
                    "state": "",
                    "burnt": "1.5521076103700786",
                    "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 Transaction 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 Ommer block
> gasUsed String gas
> 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 For example: TRON

Query block transaction list

Get the list of transactions in a block under the blockchain

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

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
height String Yes Height
protocolType String No Protocol type
transaction
internal
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 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 Id
> methodId String method Id

Address

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

Query 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

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, e.g. 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": [
        {
            "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "balance": "0.000000000000000001",
            "balanceSymbol": "ETH",
            "transactionCount": "177695079",
            "assetUsdValue": "470992.09106647",
            "firstTransactionTime": "1511831234000",
            "lastTransactionTime": "1694673299000",
            "contractAddress": true,
            "createContractAddress": "0x36928500bc1dcd7af6a2b4008875cc336b927d57",
            "createContractTransactionHash": "0x2f1c5c2b44f771e942a8506148e256f94f1a464babc938ae0690c6e34cd79190",
            "contractCorrespondingToken": "USDT",
            "contractCalls": "4740091",
            "contractCallingAddresses": "776788"
        }
    ]
}

Response Parameters

Parameter Type Description
address String Ordinary address
isValidator BOl Whether it is the contract validator address
balance String Balance
transactionCount String The transaction amount of the address
firstTransactionTime String The time when the first transaction occurred at this address
lastTransactionTime String The last transaction time for this address
contractAddress Bol Whether it is the contract validator address
createContractAddress String Contract Creator
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 address that called the contract the most in the last 30 days.

Query address token balance

Get Token Balance Detail for an address to get information about the balance of all tokens on that address.

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=0xe519e5EB81F92bF19EcFc7e5d9c6418CD8c2E0B9&protocolType=token_20

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 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": "20",
        "page": "1",
        "totalPage": "1",
        "tokenList": [
            {
                "symbol": "SolFi.Vision",
                "tokenContractAddress": "0xd88e87cd53d5b3c88c07bdb4715a39b75d6e7870",
                "holdingAmount": "350",
                "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 Token symbol
> tokenContractAddress String Token Contract Address
> holdingAmount String The holding amount of the token
> tokenId String NFT ID

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

Consumption per query 1

HTTP Request

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

Request Example

GET /api/v5/explorer/address/transaction-list?chainShortName=btc&address=90817bf1d289eb347b6b9b8818db02cb833cbe73efec940fa99852035a665e39

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
startBlockHeight String No startBlockHeight
endBlockHeight String No endBlockHeight
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": "20",
        "page": "1",
        "totalPage": "1",
        "transactionList": [
            {
                    "txId": "0x864d4dbd8fdcfd48a31d0ae30ffc7c882b69a0263c817d9f561ae84eecaa69c4",
                    "methodId": "0x7ff36ab5",
                    "nonce": "39",
                    "gasPrice": "22560736026",
                    "gasLimit": "147775",
                    "gasUsed": "109022",
                    "blockHash": "0x5ec3d59a04f89e239a74f750a8daa002a04eee22d6c6cb96dfe5fc8147622201",
                    "height": "18011883",
                    "transactionTime": "1693210475000",
                    "from": "0xc82b11fd2668a1f3a69a63c4e856a9907ae18edd",
                    "to": "0x03f7724180aa6b939894b5ca4314783b0b36b329",
                    "isFromContract": false,
                    "isToContract": true,
                    "amount": "0.006144186174090496",
                    "symbol": "ETH",
                    "txFee": "0.002459616563026572",
                    "state": "success"
            }
        ]
    }
}

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
> 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

Query address internal transaction list

Get a list of internal transactions associated with an address and return only data for the last year or one year back from the time the last transaction occurred

Consumption per query 1

HTTP Request

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

Request Example

GET /api/v5/explorer/address/internal-list?chainShortName=btc&address=90817bf1d289eb347b6b9b8818db02cb833cbe73efec940fa99852035a665e39

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
startBlockHeight String No startBlockHeight
endBlockHeight String No endBlockHeight
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": "20",
        "page": "1",
        "totalPage": "1",
        "transactionList": [
            {
                    "txId": "0x864d4dbd8fdcfd48a31d0ae30ffc7c882b69a0263c817d9f561ae84eecaa69c4",
                    "operation": "staticcall",
                    "blockHash": "0x5ec3d59a04f89e239a74f750a8daa002a04eee22d6c6cb96dfe5fc8147622201",
                    "height": "18011883",
                    "transactionTime": "1693210475000",
                    "from": "0x03f7724180aa6b939894b5ca4314783b0b36b329",
                    "to": "0xefb47fcfcad4f96c83d4ca676842fb03ef20a477",
                    "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
> amount String Transaction amount
> symbol String Symbol

Query address token transaction list

Get a list of token trading transactions associated with the address, returning only data from the last year or one year back from when the last transaction took place

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=0xB0133f0B1AC13560f8C76F7F698235FcC0DfeED2

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 Contract protocol Type
token_20
token_721
token_1155
tokenContractAddress String No Token Contract Address
startBlockHeight String No startBlockHeight
endBlockHeight String No endBlockHeight
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": "20",
        "page": "1",
        "totalPage": "1",
        "transactionList": [
            {
                    "txId": "0x8a6d1ad9caf280948b59ee4886e779c56299d7cda511819c171adeb8cbd93fdf",
                    "blockHash": "0xb587efc9027625fba5430e6c62b73ce0dae4195bbd2a73936a34a750367040ab",
                    "height": "18011932",
                    "transactionTime": "1693211063000",
                    "from": "0x03f7724180aa6b939894b5ca4314783b0b36b329",
                    "to": "0xefb47fcfcad4f96c83d4ca676842fb03ef20a477",
                    "tokenContractAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "tokenId": "",
                    "amount": "0.023803304822087826",
                    "symbol": "WETH",
                    "isFromContract": true,
                    "isToContract": true
            }
        ]
    }
}

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
> symbol String Token symbol
> tokenId String NFT ID

Batch Query Balances

This API allows for the batch querying of native token balances for up to 100 addresses.

Consumption per query is 10 calls

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 abbreviation, e.g., btc, eth. Queried via GET /api/v5/explorer/blockchain/summary.
Either chainId or chainShortName must be selected.
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
address String Address
balance String Balance of the address

Batch Query Token Balances

This API allows for the batch querying of token balances for up to 50 addresses.

Consumption per query is 5 calls

HTTP Request

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

Request Example

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

Request Example

Parameter Type Required Description
chainShortName String Yes Chain abbreviation, e.g., btc, eth. Queried via GET /api/v5/explorer/blockchain/summary.
Either chainId or chainShortName must be selected.
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

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's necessary to limit the starting block height and the ending block height, the difference between which cannot exceed 10,000 blocks.

Consumption per query is 5 calls

HTTP Request

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

Example Request

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

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain abbreviation, e.g.: btc, eth. Queryable via GET /api/v5/explorer/blockchain/summary
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": "0x571f4a7e8baed990179224d5f49fc22911cfc5dad0e44ad36bc17dbb42ee8ede",
                    "methodId": "0xa9059cbb",
                    "nonce": "0",
                    "blockHash": "0x4eb25eaeb5ac295e6d4469073fdcaa3c66c1731c123a1fb0068fe84694893a6f",
                    "height": "17888998",
                    "transactionTime": "1691724971000",
                    "from": "0xa4533bfb4bab546fc38fc2ad4e0af88c8ad9b1e2",
                    "to": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
                    "isFromContract": false,
                    "isToContract": true,
                    "amount": "0",
                    "symbol": "ETH",
                    "txFee": "0.000594999238402251",
                    "gasLimit": "100000",
                    "gasUsed": "43713",
                    "gasPrice": "13611494027",
                    "state": "success"
                }
            ]
        }
    ]
}

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 nonce
> blockHash String Block hash
> height String Block height of the transaction
> transactionTime String Transaction timestamp; 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 quantity
> 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)
> state String Transaction status: success:success, failed:fail, awaiting confirmation:pending

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.

Consumption per query is 5 calls

HTTP Request

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

Request Example

GET /api/v5/explorer/address/token-transaction-list-multi?chainShortName=eth&address=0xA9D1e08C7793af67e9d92fe308d5697FB81d3E43&endBlockHeight=17940838&startBlockHeight=17940138&limit=1

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain abbreviation, e.g., btc, eth. Query using GET /api/v5/explorer/blockchain/summary
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": "3",
            "limit": "1",
            "totalPage": "675",
            "transactionList": [
                {
                    "txId": "0x83dadd1d0dd8a50e4d86daa91fae41fd000ce8ae12a7afe1d7c4eb0e48c596ee",
                    "blockHash": "0xff0cfe9ba47bff0b609dd130d71730dbcbe89d379f6baa3db7bd72f258f7fd99",
                    "height": "17940834",
                    "operation": "staticcall",
                    "from": "0x74de5d4fcbf63e00296fd95d33236b9794016631",
                    "to": "0x4d224452801aced8b2f0aebe155379bb5d594381",
                    "isFromContract": true,
                    "isToContract": true,
                    "amount": "0",
                }
            ]
        }
    ]
}

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.

Consumption per query is 5 calls

HTTP Request

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

请求示例

GET /api/v5/explorer/address/token-transaction-list-multi?chainShortName=eth&address=0xA9D1e08C7793af67e9d92fe308d5697FB81d3E43&endBlockHeight=17940838&startBlockHeight=17940138&limit=1&tokenContractAddress=0xaa7a9ca87d3694b5755f213b5d04094b8d0f0a6f

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain abbreviation, e.g., btc, eth. Queried via GET /api/v5/explorer/blockchain/summary.
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 type, token_20 for ERC20, token_721 for ERC721, and token_1155 for ERC1155. 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": "2",
            "transactionList": [
                {
                    "txId": "0xa9c4d0c84d3ee008d7c8276c0356e32996c050aea169d92205a0656c8afa82a3",
                    "blockHash": "0xff0cfe9ba47bff0b609dd130d71730dbcbe89d379f6baa3db7bd72f258f7fd99",
                    "height": "17940834",
                    "transactionTime": "1692351551000",
                    "from": "0xa9d1e08c7793af67e9d92fe308d5697fb81d3e43",
                    "to": "0x69467340b04997e8b9a88418f6047f54e70b52e2",
                    "isFromContract": true,
                    "isToContract": false,
                    "amount": "4351.53070979",
                    "tokenId": "",
                    "symbol": "TRAC",
                    "tokenContractAddress": "0xaa7a9ca87d3694b5755f213b5d04094b8d0f0a6f",
                    "state": "success"
                }
            ]
        }
    ]
}

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.

Query address balance details

Get the balance details of an address, you can get other large balance information on the address.

Consumption per query is 1 calls

HTTP Request

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

Request Example

GET /api/v5/explorer/address/address-balance-fills?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
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": "20",
            "totalPage": "1",
            "chainFullName": "OKT Chain",
            "chainShortName": "OKTC",
            "tokenList": [
                {
                    "token": "USDT",
                    "tokenId": "",
                    "holdingAmount": "1960718.5605412568",
                    "totalTokenValue": "106462.468970329788524224",
                    "change24h": "0.00030174",
                    "priceUsd": "1.000706314633",
                    "valueUsd": "1962103.4447517617860780507544",
                    "tokenContractAddress": "0x382bb369d343125bfb2117af9c149795c6c65c50"
                }
            ]
        }
    ]
}

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
> tokenContractAddress String Token contract address
> holdingAmount String Token holdings 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 ID

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.

HTTP Request

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

Consumption per query 1

Request Example

GET /api/v5/explorer/address/address-summary?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g. BTC, 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": "TRON",
            "chainShortName": "TRON",
            "address": "TJBtdYunmQkeK5KninwgcjuK1RPDhyUWBZ",
            "contractAddress": "",
            "balance": "6091.521832",
            "balanceSymbol": "TRX",
            "transactionCount": "536122",
            "verifying": "0",
            "sendAmount": "9999",
            "receiveAmount": "16090.521832",
            "tokenAmount": "70",
            "totalTokenValue": "",
            "createContractAddress": "",
            "createContractTransactionHash": "",
            "firstTransactionTime": "1647822777000",
            "lastTransactionTime": "1666168629000",
            "token": "",
            "bandwidth": "6512,6512",
            "energy": "6802,6802",
            "votingRights": "0,0",
            "unclaimedVotingRewards": "0"
        }
    ]
}

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
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 differentamounts 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. Inversly, withdrawing theirTRX 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)

Top 100 richest addresses

Get the details of the top 100 addresses with the address balance of a public chain or contract.

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,e.g:BTC、ETH ,Request the /api/v5/explorer/blockchain/summary interface to query the chains supported by OKLink
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
rank String Rank
address String Holding Address
amount String Amount
transactionCount String Transactions
holdRatio String Holding Percentage
netWork String Chain

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

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=0xdAC17F958D2ee523a2206206994597C13D831ec7

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
protocolType String No Contract protocol Type
transaction
internal
token_20
token_721
token_1155
token_10 The default is transaction
symbol String No Symbol
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",
            "transactionLists": [
                {
                    "txId": "0x650b848a1cfc337f028752427e556913a7005fc24d3ad105189458d918651e5e",
                    "methodId": "0xa9059cbb",
                    "blockHash": "0x462e4151adb1b0b345d16d5ad72623c4bcd5381eb02ab6ef83dd753654ebe881",
                    "height": "18126655",
                    "transactionTime": "1694599235000",
                    "from": "0xe10aa136b1ca78e4d649cd1934c324f260433e57",
                    "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "isFromContract": false,
                    "isToContract": true,
                    "amount": "0",
                    "transactionSymbol": "ETH",
                    "txFee": "0.001458305786787834",
                    "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;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

Query UTXO

Get UTXO transaction information on an address, only for chains with UTXO models such as BTC and BCH

HTTP Request

GET /api/v5/explorer/address/unspent

Consumption per query 1

Request Example

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

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name,e.g:BTC 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": "9ab07e76093349faae5a4c815d968fcb7e1753f0f441ce439dab27f1242f02f0",
            "height": "788297",
            "amount": "1952.56094525",
            "address": "bc1qmhq4sgtchfgh6ul75x3rsuegt55mef0zx3ehm2",
            "confirm": "",
            "index": "219",
            "transactionIndex": "",
            "balance": "1950.06103047",
            "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 Index
transactionIndex String Transaction index
balance String Address balance
symbol String Symbol

Query address remaining UTXO [explorer-api-address-query-utxo-amount]

Get a breakdown of each UTXO remaining at the address

HTTP Request

GET /api/v5/explorer/address/utxo

Consumption per query 1

Request Example

GET /api/v5/explorer/address/utxo?chainShortName=btc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name,e.g:BTC 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": "20",
            "totalPage": "1",
            "utxoList": [
                {
                    "txid": "9ab07e76093349faae5a4c815d968fcb7e1753f0f441ce439dab27f1242f02f0",
                    "height": "788297",
                    "blockTime": "1683240021",
                    "address": "bc1qmhq4sgtchfgh6ul75x3rsuegt55mef0zx3ehm2",
                    "unspentAmount": "1950.06103047",
                    "index": "1"
                }
            ]
        }
    ]
}

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 Index

Query Cosmos address balance

Query the balance of the address on Cosmos chain

Consumption per query is 1 calls

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 name
address String Yes Address

Response Example

{
    "code": 0,
    "msg": "",
    "detailMsg": "",
    "data": {
        "address": "cosmos1gn52hszvhmhu64hs2mywfj7tr4ps6nwz0snht8",
        "availableBalance": "0.571788",
        "delegated": "0",
        "delegatedReward": "0",
        "rewardRecipientAddress": "cosmos1gn52hszvhmhu64hs2mywfj7tr4ps6nwz0snht8",
        "unbonding": "0",
        "symbol": "COSMOS"
    }
}

Response Parameters

Parameter Type Description
address String Ordinary address
availableBalance String AvailableBalance
delegated String Delegated balance
delegatedReward String Delegated reward
rewardRecipientAddress String Reward recipientaddress
unbonding String unbonding balance
symbol String symbol

Query cosmos token balance

Query for the token balance of cosmos chain address

Consumption per query is 1 calls

HTTP Request

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

Request Example

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

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address
tokenType String tokentype
ibcDenom String ibcDenom
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": "",
    "detailMsg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "11",
        "tokenList": [
            {
                "token": "",
                "ibcDenom": "ibc/B38AAA0F7A3EC4D7C8E12DFA33FF93205FE7A42738A4B0590E2FF15BC60A612B",
                "tokenType": "ibc",
                "holdingAmount": "304820518897426"
            }
        ]
    }
}

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
> ibcDenom String ibcDenom
> holdingAmount String The holding amount of the token

Query cosmos chain normal transaction cosmos

Query for the transaction of cosmos chain address

Consumption per query is 1 calls

HTTP Request

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

Request Example

GET /api/v5/explorer/address/transaction-list?chainShortName=btc&address=90817bf1d289eb347b6b9b8818db02cb833cbe73efec940fa99852035a665e39

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
address String Yes Address
startBlockHeight String No startBlockHeight
endBlockHeight String No endBlockHeight
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": "",
    "detailMsg": "",
    "data": {
        "page": "1",
        "limit": "1",
        "totalPage": "8",
        "transactionList": [
            {
                "symbol": "COSMOS",
                "txId": "60F1DD062BCA7A9E84A57B2DAE61F3F1832CFE9763ECC06DE3E023926344D64E",
                "blockHash": "5EB30717D4EB445DAC960AAC0F22A5970A567D12E728E3791ECD0582C9F7C006",
                "height": "16618150",
                "transactionTime": "1692337365",
                "from": [
                    "cosmos1gn52hszvhmhu64hs2mywfj7tr4ps6nwz0snht8"
                ],
                "to": [
                    "cosmos12xchmahded3q5l667u9quevem9qrtp5tafs87j"
                ],
                "txFee": "0.002388",
                "gasLimit": "95488",
                "gasUsed": "85465",
                "type": [
                    "cosmos.bank.v1beta1.MsgSend"
                ],
                "value": "14414",
                "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
> 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
> symbol String Symbol of the transaction token
> gasLimit String Maximum gas amount
> gasUsed String Actual amount of gas used
> txFee String Transaction fee
> state String Transaction status: success:success, failed:fail, awaiting confirmation:pending
> value String 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.

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": "Ethereum",
            "chainShortName": "ETH",
            "rank": "1",
            "poolName": "ethermine",
            "hashrate": "255.13",
            "ratio": "0.2833",
            "blockCount": "1780",
            "emptyBlockCount": "142",
            "ommerBlockCount": "66",
            "avgBlockSize": "",
            "avgFee": "0.0000000009380955983377118",
            "minerFeeRatio": "0.0469"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name,e.g:Bitcoin
chainShortName String Chain Short name,e.g:BTC
rank String Rank
poolName String Pool name
poolWebsite String Pool website
hashrate String Hashrate
ratio String Ratio
blockCount String Block count
emptyBlockCount String Empty block count
ommerBlockCount String Ommer block count
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

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": "Ethereum",
            "chainShortName": "ETH",
            "rank": "1",
            "poolName": "ethermine",
            "hashrate": "257201499275264",
            "change24h": "-0.0013",
            "luckyRatio": "0.9713"
        },
        {
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "rank": "2",
            "poolName": "F2Pool",
            "hashrate": "137947520549519.375",
            "change24h": "0.0183",
            "luckyRatio": "0.9784"
        }
    ]
}

Response Parameters

Parameter Type Description
chainFullName String Chain full name,e.g:Bitcoin
chainShortName String Chain Short name,e.g:BTC
rank String Rank
poolName String Pool name
hashrate String Hashrate
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.

HTTP Request

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

Consumption per query 1

Request Example

GET /api/v5/explorer/pool/validator-list?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 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":"20",
            "totalPage":"670",
            "validatorList":[
                    {
                        "rank":"1",
                        "validatorName":"victor1",
                        "validatorAddress":"dsfsdfsd",
                        "weightRatio":"0.02",
                        "weight":"115",
                        "blocks":"116",
                        "staked":"1141",
                        "stakedSymbol":"OKT",
                        "reward":"113",
                        "rewardSymbol":"OKT",
                        "state":"1",
                        "firstHeight":""
                        "latestHeight":""
                    }
            ]
        }
    ]
}

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 Rank
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

Transaction

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

Query the list of large value transactions

Get the list of large-value transactions on the public chains currently supported by OKLink.

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

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 N0 Type
BTC:500;1000;2000
ETH:1000;2000;5000
USDT:100000;500000;1000000
ETC:1000;10000;50000 BCH:1000;2000;5000
LTC:1000;2000;5000 DASH:1000;2000;5000
BSC:1000;2000;5000
AVAX:1000;2000;5000
blockHash String N0 Block hash
height String N0 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": "302633",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "transactionList": [
                {
                    "txid": "0xb0571e34a3a3ff1b605fdbb8f966574a6e4d597fa4f52deda998198fb1cbac36",
                    "blockHash": "0x9ce83b3ed962bc9ad2f9d7be361fbc1c9426389aa226ea1f46e26db7b8b5d257",
                    "height": "17193279",
                    "transactionTime": "1683275735000",
                    "input": "0xd2b954a0635096ddaadd7ff1d5a182198f02fcae",
                    "output": "0x4dbd4fc535ac27206064b68ffcf827b0a60bab3f",
                    "isInputContract": false,
                    "isOutputContract": true,
                    "amount": "1000",
                    "transactionSymbol": "ETH",
                    "txfee": "0.007340732607387121",
                    "methodId": "0x439370b1",
                    "transactionType": "2",
                    "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:Bitcoin
chainShortName String Chain Short name,e.g:BTC
transactionList Array Transaction list
> txid String Transaction hash
> blockHash String Block hash
> height String 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 ouput address a contract address
> amount String 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 transaction details

Get the basic transaction information on the public chain currently supported by OKLink

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": "1",
            "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 Height
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
txfee String Transaction fee
index String The position index of the transaction in the block
confirm String confirm
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 Gas consumption
gasPrice String Gas price
totalTransactionSize String Total transaction size
virtualSize String Virtual size
weight String Weight
nonce String Nonce
tokenTransferDetails Array Token transfer details
> index String Index
> token String token
> tokenContractAddress String Token contract address
> symbol String 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 Token id
> amount String Amount
contractDetails Array Contract call transfer details
> index String index
> 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
> amount String Amount
> gasLimit String Gas limit

Query transaction list information

Get the transaction list of the public chains currently supported by OKLink, and only return nearly 10,000 transaction data

HTTP Request

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

Consumption per query 1

Request Example

GET /api/v5/explorer/transaction/transaction-list?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
blockHash String N0 Block hash
height String N0 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": "851810053",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "transactionList": [
                {
                    "txid": "0x6dbabdd5715160bc2b3d36c7368162212ce744c5ae5dac6d81c96759fea37ab8",
                    "blockHash": "0xfdc697f5742b6c31587e18ccd63fe5b9f88ff6aeaa07be8982621c8cbd3aecf0",
                    "height": "15496493",
                    "transactionTime": "1662639200000",
                    "input": "0x69073bfe324df3195cfb332b845b985a56db5491",
                    "output": "0x9cccb6a6d1f65ded19c283e2282110bc4f628869",
                    "amount": "0.04",
                    "transactionSymbol": "ETH",
                    "txfee": "0.002343825046064032",
                    "methodId": "0xf6fd63d4",
                    "transactionType": "2",
                    "state": "success"
                },
                {
                    "txid": "0xf986db8c5eef071ead272a128920c60a71e1029ed2b71c0e58e78e733dbab0ea",
                    "blockHash": "0xfdc697f5742b6c31587e18ccd63fe5b9f88ff6aeaa07be8982621c8cbd3aecf0",
                    "height": "15496493",
                    "transactionTime": "1662639200000",
                    "input": "0xb8de37b107e87c7584114773f0e79a2b6d74eb8c",
                    "output": "0x9cccb6a6d1f65ded19c283e2282110bc4f628869",
                    "amount": "0.02",
                    "transactionSymbol": "ETH",
                    "txfee": "0.001705818112657196",
                    "methodId": "0xa0712d68",
                    "transactionType": "2",
                    "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:Bitcoin
chainShortName String Chain Short name,e.g:BTC
transactionList Array Transaction list
> txid String Transaction hash
> blockHash String Block hash
> height String Height
> transactionTime String Transacation 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 Amount
> transactionSymbol String symbol
> txfee String Transaction fee
> methodId String Method id
> transactionType String Transaction type
0:original transaction type
1:EIP2930
2:EIP1559
> state String transaction
success
fail
pending
> tokenContractAddress String Token Contract Address

Query the list of unconfirmed transactions

Get the list of unconfirmed transactions on the public chains currently supported by OKLink, and only return nearly 10,000 transaction data

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

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": "0",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "transactionList": [
                {
                    "txid": "f624a8a720607c2d745f854345c87654f93a69e36cba33f9c26c0afb89479166",
                    "height": "",
                    "transactionTime": "",
                    "input": "1297zniMJbZE8pN9nhjaMaAVVDMzZV5Gec",
                    "output": "1EkLo9rqzGPAWxxrxzwhhkHvHCcZBBXBX2,3HEZCGyjEFPXZ5RYJsoPzAEv4KcFJLLtqv",
                    "isInputContract": false,
                    "isOutputContract": false,
                    "amount": "0.30555427",
                    "transactionSymbol": "BTC",
                    "txfee": "24728",
                    "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
> blockHash String Block hash
> height String Height
> transactionTime String Transacation time;Unix timestamp format in milliseconds, e.g. 1597026383085
> isInputContract Bol Is the input address a contract address
> isOutputContract Bol Is the ouput address a contract address
> input String Token arrival address
> output String Token transfer out address
> amount String Amount
> transactionSymbol String Symbol
> txfee String Transaction fee
> methodId String Method id
> transactionType String Transaction type
0:original transaction type
1:EIP2930
2:EIP1559
> state String Transaction
success
fail
pending
> randomNumber String RandomNumber

Parse the transaction

Given the packaged transaction signature, the transaction details are reversely parsed. Only BCH, BTC, DASH, and LTC are supported.

HTTP Request

POST /api/v5/explorer/transaction/decode

Consumption per query 5

Request Example

POST /api/v5/explorer/transaction/decode
body
{
    "chainShortName":"eth",
    "signedTx":"12232323"
}

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
signedTx String Yes Transaction signature

Response Example

{
    "code":0,
    "msg":"",
    "data":[
        {
            "txid":"81c8447bf780dacedf67c45908aafcde43c78ae108b3a06a278362ad306f7239",
            "version":"1",
            "size":"224",
            "vsize":"224",
            "weight":"896",
            "locktime":"0",
            "input":[
                {
                    "txid":"2555fe195e9de0a4725c9b76008e93bfb47d7a844309853a27a66a092ecf457c",
                    "index":"1",
                    "sign":{
                        "asm":"12313[ALL]",
                        "hex":"12313"
                    },
                    "sequence":"4294967295"
                }
            ],
            "output":[
                {
                    "amount":"0.00271",
                    "index":"0",
                    "publicKey":{
                        "asm":"OP_HASH160 7cfcfaae9ec7c505538c7bbfe23d6b3c9d7e0e0e OP_EQUAL",
                        "hex":"a9147cfcfaae9ec7c505538c7bbfe23d6b3c9d7e0e0e87",
                        "reqSigs":"1",
                        "type":"scripthash",
                        "address":[
                            "3D5tmdpJe2tdNmosuLGNwMT9bcym34K3LT",
                            "3D5tmdpJe2tdNmosuLGNwMT9bcym34K3LT"
                        ]
                    }
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
txid String Transaction hash
version String Version
transactionSize String Transaction size
virtualSize String Virtual size
weight String Weight
transactionTime String Transaction time;Unix timestamp format in milliseconds, e.g. 1597026383085
inputDetails Array Input details
> txid String Transaction hash
> index String Index
> sequence String Sequence
> sign Obj Sign
>> asm String Asm
>> hex String Hex
outputDetails Array Output details
> amount String Amount
> index String Index
> publicKey Obj PublicKey
>> asm String Asm
>> hex String Hex
>> reqSigs String ReqSigs
>> asmType String AsmType
>> address Array Target address(to)

Query internal transaction detail

Query for internal transaction detail by transaction hash

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 name
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 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
> amount String Transaction amount
> state String trading state

Query token transaction detail

Query for token transfer detail by transaction hash

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 name
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": "1",
            "totalPage": "2",
            "tokenTransferDetails": [
                {
                    "txId": "0x06d35ea1b5ec75fa9f66bb0d481102aad6236a8e70427cd91a1b1c3e754244dc",
                    "from": "0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad",
                    "to": "0xf66369997ae562bc9eec2ab9541581252f9ca383",
                    "height": "18076803",
                    "transactionTime": "1693995971000",
                    "isFromContract": true,
                    "isToContract": true,
                    "tokenContractAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "symbol": "WETH",
                    "amount": "0.002"
                }
            ]
        }
    ]
}

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 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 Token ID

Token

These endpoints from this module retrieve data for a specified token detail. The Tokens module currently supports tokens in ERC-20 like protocol, ERC-721 and ERC-1155.

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.

Consumption per query is 20 calls

HTTP Request

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

Request Example

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

Request Parameters

Parameter Type Required Description
chainId String No Unique identifier of the public chain. Either chainId or chainShortName must be chosen.
chainShortName String No Public chain abbreviation, e.g.: btc, eth. You can query via GET /api/v5/explorer/blockchain/summary. Either chainId or chainShortName must be chosen.
tokenContractAddress String Yes Token Contract Address

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "lastPrice": "7.787",
            "tokenContractAddress": "0x8d983cb9388eac77af0474fa441c4815500cb7bb"
        },
        {
            "lastPrice": "1109.360929491998430075",
            "tokenContractAddress": "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2"
        }
    ]
}

Response Parameters

Parameter Type Description
lastPrice String The latest price of the token, updated every minute.
tokenContractAddress String Token Contract Address

Query token list information

Get basic information about a token on a chain

HTTP Request

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

Consumption per query 1

Request Example

GET /api/v5/explorer/token/token-list?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
protocolType String No Contract Agreement Type
token_20
token_721
token_1155
token_10 Default is token_20
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": "3373",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "tokenList": [
                {
                    "tokenFullName": "Tether USD",
                    "token": "USDT",
                    "precision": "6",
                    "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "protocolType": "ERC20",
                    "addressCount": "4426285",
                    "totalSupply": "69156782826.546173095703125",
                    "circulatingSupply": "67545704102.99471282958984375",
                    "price": "0.9884886816000000298032546197646297514438629150390625",
                    "website": "https://tether.to/",
                    "totalMarketCap": "66792795650.9627685546875"
                }
            ]
        }
    ]
}

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
> precision String Precision
> tokenContractAddress String Token contract address
> protocolType String Protocol type
> addressCount String Address count
> totalSupply String Total supply
> circulatingSupply String Circulating supply
> price String Price,Unit is USD
> website String Website
> totalMarketCap String Total market cap
> issueDate String Issue Date

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

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 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
holderAddress String No Position 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",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "circulatingSupply": "",
            "positionList": [
                {
                    "holderAddress": "0x000000000000000000000000000000000000dead",
                    "amount": "1109086030527",
                    "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 Circulating Supply
positionList Array Position List
> holderAddress String Holder Address
> amount String Holder amount
> valueUsd String Value of positions,Unit: USD
> positionChange24h String 24 hour position changes
> rank String Position Ranking

Query token transfer details

Get details of a specified token transfer from a specified chain

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=0x495f947276749ce646f68ac8c248420045cb7b5e

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": "2",
            "totalPage": "5000",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "totalTransfer": "176187963",
            "transactionList": [
                {
                    "txid": "0xad3076e840f66a1ec557f9be5f37ca3d3f78ffc807c5978b4cd4531b017cabff",
                    "blockHash": "0x0992b24760a1c5a913bd5d29f3ab2b0b059bf15df6487e9d61987a05c85fe7d0",
                    "height": "17193345",
                    "transactionTime": "1683276539000",
                    "from": "0x024dff8673dd26dd20e5f60b19244ba74925cd68",
                    "to": "0x74de5d4fcbf63e00296fd95d33236b9794016631",
                    "isToContract": true,
                    "isFromContract": false,
                    "amount": "100",
                    "transactionSymbol": "USDT",
                    "methodId": "0x5f575529",
                    "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "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 Whether the receiving token address is a contract address
> amount String Transaction Amount
> transactionSymbol String Transaction Symbol
> methodId String Method Id
> tokenContractAddress String Token Contract Address
> protocolType String Protocol Type
> state String Status
success
fail
pending
> tokenId String 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.

Consumption per query is 5 calls

HTTP Request

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

Request Example

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

Request Parameters

Parameter Name Type Required Description
chainShortName String Yes Public chain abbreviation, e.g., btc, eth. Can be queried 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": "575",
            "transactionList": [
                {
                    "txId": "0xe4734cac4c64f1ecf81c34e9cd85b62a2a4a98c1725551747f648f0d0eb9b6cb",
                    "blockHash": "0x679d0c17496a26daf0db04a815f262d6b76e71875592ac267f7dec40392fd49f",
                    "height": "17925771",
                    "transactionTime": "1692169307000",
                    "from": "0x84874a7b71c302707fad5dd386743c5836445794",
                    "to": "0x495fe5bb98d9571b2cd5d8db172636c6cec6ba79",
                    "isFromContract": false,
                    "isToContract": false,
                    "amount": "1",
                    "tokenId": "5082",
                    "symbol": "BAYC",
                    "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
                    "state": "success"
                }
            ]
        }
    ]
}

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 Token ID, applicable for 721 and 1155 tokens.
> symbol String Cryptocurrency symbol corresponding to the amount.
> tokenContractAddress String Token contract address.
> state String Transaction status: success:success, failed:fail, awaiting confirmation:pending.

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=TRX&type=printing

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": "454",
            "recordList": [
                {
                    "stablecoinName": "USDT",
                    "txid": "25a55b38cf113011f285cc9a28466323e10266a5ca0a2635579af2975079a523",
                    "network": "TRX",
                    "height": "42984567",
                    "amount": "1000000000",
                    "sendAddress": "T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb",
                    "receiveAddress": "TBPxhVAsuzoFnKyXtc1o2UySEydPHgATto",
                    "transactionTime": "1659529347000"
                }
            ]
        }
    ]
}

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 Amount
> 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, including OKX, Binance and 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"
                }
            ]
        }
    ]
}

Response Parameters

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

Query Proof of Reserves Histroy

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

Request Parameters

Parameter Type Required Description
institutionName String Yes Exchange Name
time String No 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
> tokenContractAddress String Token contract address
> symbol String symbol
> balance String balance
> balanceUsd String balance、unit: USDT
> time String Data update time

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

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": "2",
            "totalPage": "25",
            "addressDetails": [
                {
                    "balance": "11996000000",
                    "balanceUsd": "11993351024.770172",
                    "chainShortName": "ETH",
                    "symbol": "BUSD",
                    "address": "0xf977814e90da44bfa03b6295a0616a897441acec",
                    "updateTime": "1670918400000"
                },
                {
                    "balance": "7000000108.553991",
                    "balanceUsd": "7002773135.076995",
                    "chainShortName": "TRON",
                    "symbol": "USDT",
                    "address": "TMuA6YqfCeX8EhbfYEg5y7S4DqzSJireY9",
                    "updateTime": "1670918400000"
                }
            ]
        }
    ]
}

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
> symbol String symbol
> balance String Balance
> balanceUsd String balance、unit: USDT
> address String Address
> updateTime String Update time

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": "120499366.7689",
            "totalBurnt": "2911344.1373",
            "inflationRate": "-0.0141",
            "stakingAmount": "16653847.1254",
            "stakingApy": "0.0394"
        }
    ]
}

Response Parameters

Parameter Type Description
circulatingSupply String Current Circulation
totalBurnt String Total Burnt
stakingApy String Staking APY
stakingAmount String Current Staking Amount
inflationRate String Current Annual Inflation Rate,Displayed as a decimal, example: 0.1 = 10%

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": "20",
            "totalPage": "28",
            "stakingHistoryList": [
                {
                    "time": "1676390400000",
                    "totalValidator": "519845",
                    "totalStaked": "16653847.1254",
                    "stakingRatio": "0.1394",
                    "validatorDailyIncome": "1801.91",
                    "apy": "0.0394",
                    "nonEip1559Fee": "138.7061",
                    "baseRewards": "6481.8607",
                    "priorityFee": "588.993"
                }
                    ]
        }
    ]
}

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 Apy
> baseRewards String Base rewards
> priorityFee String Priority fee
> totalStaked String Total staked
> nonEip1559Fee String Non eip1559 fee
> totalValidator String Total validator
> validatorDailyIncome String Validator daily income
> time String Update time,Unix timestamp format in milliseconds, e.g. 1597026383085

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": "2",
            "limit": "20",
            "totalPage": "28",
            "inflationHistoryList": [
                {
                    "supply": "1790.6",
                    "burnt": "2158.7776",
                    "netInflation": "-368.1776",
                    "circulatingSupply": "120517711.781",
                    "inflationRate": "-0.0011",
                    "time": "1674662400000"
                }
    ]
}
 ]
}

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 amount String burnt
> netInflation String Net inflation
> supply String Supply
> inflationRate String Inflation rate
> 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": "20",
            "totalPage": "28",
            "gasHistoryList": [
                {
                    "nonEip1559Fee": "138.7061",
                    "eip1559BaseFee": "6481.8607",
                    "eip1559Tip": "588.993",
                    "totalTransactionCount": "1191785",
                    "maxGasPrice": "814.2265",
                    "minGasPrice": "19.03",
                    "avgGasPrice": "62.0559",
                    "time": "1676390400000"
                }
    ]
}
 ]
}

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 transaction count
> nonEip1559Fee String Non eip1559 Fee
> time String Update time,Unix timestamp format in milliseconds, e.g. 1597026383085

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 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": "5146426",
            "inscriptionsList": [
                {
                    "inscriptionId": "9e54767636589dd70af60b2074d23c1689b68f6a5d8036f9dddaa2bc31a0b5ffi0",
                    "inscriptionNumber": "999922",
                    "location": "9e54767636589dd70af60b2074d23c1689b68f6a5d8036f9dddaa2bc31a0b5ff:0:0",
                    "token": "",
                    "state": "fail",
                    "msg": "amount exceed limit: 1000000000000000000000",
                    "tokenType": "BRC20",
                    "actionType": "mint",
                    "logoUrl": "",
                    "ownerAddress": "bc1pupvkqkxe2wnxg2ytf7twr07pychh8htx0cy5w439yyzzgdu2pzqsukzqwd",
                    "txId": "9e54767636589dd70af60b2074d23c1689b68f6a5d8036f9dddaa2bc31a0b5ff",
                    "blockHeight": "784528",
                    "contentSize": "",
                    "time": "1680975864000"
                }
            ]
        }
    ]
}

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 Inscription
inscriptionsList Array Inscriptions list
> inscriptionId String Inscription Id
> inscriptionNumber String Inscription Number
> token String Tick
> state String Sate , success、fail
> 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 Content Size
> time String 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 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": "10000",
            "tokenList": [
                {
                    "token": "ordi",
                    "deployTime": "1678248991000",
                    "inscriptionId": "b61b0172d95e266c18aea0c624db987e971a5d6d4ebc2aaed85da4642d635735i0",
                    "inscriptionNumber": "348020",
                    "totalSupply": "21000000",
                    "mintAmount": "21000000",
                    "transactionCount": "119202",
                    "holder": "10498",
                    "mintRate": "1"
                }
            ]
        }
    ]
}

返回参数

参数名 类型 描述
page String Current page number
limit String The amount of data
totalPage String Total number of pages
> token String tick
> deployTime String Deploy Time
> inscriptionId String Inscription Id
> inscriptionNumber String Inscription Number
> totalSupply String Total Supply
> mintAmount String Mint Amount
> transactionCount String Transaction Count
> holder String holder
> 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": "30658561856757.1",
            "limitPerMint": "100000000",
            "holder": "8354",
            "deployAddress": "bc1prtawdt82wfgrujx6d0heu0smxt4yykq440t447wan88csf3mc7csm3ulcn",
            "logoUrl": "",
            "txId": "9b664bdd6f5ed80d8d88957b63364c41f3ad4efb8eee11366aa16435974d9333",
            "inscriptionId": "9b664bdd6f5ed80d8d88957b63364c41f3ad4efb8eee11366aa16435974d9333i0",
            "deployHeight": "779971",
            "deployTime": "1678339934000",
            "inscriptionNumber": "357097",
            "state": "success",
            "tokenType": "BRC20",
            "msg": ""
        }
    ]
}

Response Parameters

Parameter Type Description
token String 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
txId String Transaction Hash
inscriptionId String Inscription Id
deployHeight String Deploy Height
deployTime String Deploy Time
inscriptionNumber String Inscription Number
state String state success、fail
tokenType String Token Type;e.g 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

Request Parameters

Parameter Type Required Description
token String Yes 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": "4180",
            "positionList": [
                {
                    "holderAddress": "bc1ph0057nc25ka94z8ydg43j8tnnp38u3hxpadutnt4n3jyfrmjzmcqw99mk2",
                    "amount": "1350000000000",
                    "rank": "1"
                },
                {
                    "holderAddress": "bc1pkucershsndc8suumwqfq6g9u38rma8uxwzqherq2k23e5p2jda9s6jdpr2",
                    "amount": "666000000000",
                    "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 amount
> rank String 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 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": "2",
            "totalTransaction": "2",
            "inscriptionsList": [
                {
                    "txId": "15f3bad7d7eeac1fad3cffa22812ab43aeaf8f4f6fad83732fc30b2273a0ffd6",
                    "blockHeight": "791466",
                    "state": "success",
                    "tokenType": "BRC20",
                    "actionType": "inscribeTransfer",
                    "fromAddress": "",
                    "toAddress": "bc1p40d22fknr7gu29vswn2r40v3dd39uwavtsnltmdj6sp5lju5davqgwdajy",
                    "amount": "5000",
                    "token": "OXBT",
                    "inscriptionId": "15f3bad7d7eeac1fad3cffa22812ab43aeaf8f4f6fad83732fc30b2273a0ffd6i0",
                    "inscriptionNumber": "9244252",
                    "index": "0",
                    "location": "15f3bad7d7eeac1fad3cffa22812ab43aeaf8f4f6fad83732fc30b2273a0ffd6:0:0",
                    "msg": "",
                    "time": "1685092041000"
                }
            ]
        }
    ]
}

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 Transaction
transactionList Array Transaction List
> txid String Transaction Hash
> blockHeight String Block Height
> state String State , success、fail
> tokenType String Token Type, e.g BRC20
> actionType String Action Type:deploy、mint、inscribeTransfer、transfer
> fromAddress String Sender BTC Address
> toAddress String Receiver BTC Address
> amount String 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 tick
> inscriptionId String Inscription Id
> inscriptionNumber String Inscription Number
> msg String Msg
> time String 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 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 Tick
> tokenType String Token type e.g:BRC20
> balance String 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 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 Tick
tokenType String Token type e.g:BRC20
balance String balance
availableBalance String Available balance
transferBalance String Transfer balance
transferBalanceList Array Transfer balance list
> inscriptionId String Inscription Id
> inscriptionNumber String Inscription Number
> amount String amount

Domain risk scanner

This endpoint scans the internet domain risk and retrieves risk level and detail information associated with specific domain address.

Risk Levels

Risk Levels Rules Description
SEVERE Hit Blacklist Domain Database We consider the domain you tested to have a high level of risk. We recommend that you take appropriate measures.
HIGH Precision Matching Strategy for Keyword Matching We believe that the domain you tested shares key words with official domain names, indicating a potential phishing website. Please exercise caution.
MEDIUM Fuzzy Matching Strategy for Keyword Matching We believe that the tested domain poses a risk and may require attention.
LOW Matched White List or No Rule Matched Our assessment does not guarantee that the domain is completely risk-free. It is possible that our risk detection strategies or domain databases do not have any records for it.

Domain

By using this interface, you can screen domain name risks and reduce the risk of users falling victim to phishing websites through an extensive black domain name database and the identification of risk features associated with phishing.

HTTP Request

GET /api/v5/tracker/domainscanner/domain-risk-scanning

Consumption per query 1

Request Example

GET /api/v5/tracker/domainscanner/domain-risk-scanning?domain=www.oklink.com

Request Parameters

Parameter Type Required Description
domain String Yes Domain name, for example: www.oklink.com
Batch query supports up to 5 domains, separated by commas.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "domain": "www.oklink.com",
            "level": "LOW"
        }
    ]
}

Response Parameters

Parameter Type Description
domain String domain
level String Risk Level ;SEVERE ;HIGH ;MEDIUM ;LOW

Send transaction

Send transaction on the chain function module interface, based on OKlink's powerful node service capability, to broadcast user-packaged transactions to the blockchain

Send raw transaction

Broadcast your completed signed transaction to the specified blockchain through this interface, sending it to the node to verify this transaction.

HTTP Request

POST /api/v5/explorer/transaction/publish-tx

Consumption per query 5

Request Example

POST /api/v5/explorer/transaction/publish-tx
body
{
    "chainShortName":"eth",
    "signedTx":"12232323"
}

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
signedTx String Yes Transaction signature

Response Example

{
    "code":"0",
    "msg":"",
    "data":[
     {
        "chainFullName":"Bitcoin",
        "chainShortName":"BTC",
        "txid":"5e95ebfe52c50758e69bbac1d2cc4224dc520498e38505bc958fae8bcd5e8366"
     }
  ]
}

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

History balance

The endpoint from this module retrieves address balance for targeting block height and the balance data updates hourly.

Query address history balance

The interface updates the height of searchable blocks on an hourly basis.

HTTP Request

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

Consumption per query 1

Request Example

GET https://www.oklink.com/api/v5/explorer/block/address-balance-history?chainShortName=Optimism&height=15994188&address=0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1&tokenContractAddress=0xdac17f958d2ee523a2206206994597c13d831ec7

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name,e.g ETH、TRON、Polygon、AVAXC、OPTIMISM、Arbitrum
height String Yes Height
address String Yes Address where you need to check your 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": "0x99c9fc46f92e8a1c0dec1b1747d010903e884be1",
            "height": "15994188",
            "balance": "119950111.212534",
            "balanceSymbol": "USDT",
            "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "blockTime": "1668741827000"
        }
    ]
}

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, this field 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

Beacon data module

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

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?pubkey=0x942e9c652f1e7105f87ec443ef45d3eea3425cd04268794c9f5b712a47ddbfb6c0d15be5c33784501253891fea6fb7a8&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": "1",
            "depositList": [
                {
                    "epoch": "210273",
                    "slot": "6728739",
                    "state": "active",
                    "index": "795613",
                    "pubkey": "0x942e9c652f1e7105f87ec443ef45d3eea3425cd04268794c9f5b712a47ddbfb6c0d15be5c33784501253891fea6fb7a8",
                    "time": "1687568891000",
                    "beaconDepositsReceived": "32",
                    "withdrawalCredential": "0x010000000000000000000000882e747c5c2e0366d4fd6f9f95780467c6549732"
                }
            ]
        }
    ]
}

返回参数

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 Quantity of staked ETH
> withdrawalCredential String Withdrawal certificate

Beacon Chain withdrawal Record Query

Retrieve withdrawal record data from the Beacon Chain.

Each call costs 1 point.

HTTP Request

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

Sample Request

GET /api/v5/explorer/beacon/beacon-withdrawal-list?pubkey=0x942e9c652f1e7105f87ec443ef45d3eea3425cd04268794c9f5b712a47ddbfb6c0d15be5c33784501253891fea6fb7a8&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": "7",
            "withdrawalList": [
                {
                    "epoch": "229213",
                    "slot": "7334839",
                    "state": "active",
                    "index": "795613",
                    "pubkey": "0x942e9c652f1e7105f87ec443ef45d3eea3425cd04268794c9f5b712a47ddbfb6c0d15be5c33784501253891fea6fb7a8",
                    "time": "1694842091000",
                    "beaconWithdrawalReceived": "0.01590899",
                    "address": "0x882e747c5c2e0366d4fd6f9f95780467c6549732",
                    "withdrawalCredential": "0x010000000000000000000000882e747c5c2e0366d4fd6f9f95780467c6549732"
                }
            ]
        }
    ]
}

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.
> beaconDepositsReceived String Amount of ETH staked.
> withdrawalCredential String Withdrawal credential.

Beacon Chain Slot List

Retrieve the validator details of the Beacon Chain.

Each call costs 1 point.

HTTP Request

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

Request Example

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

请求参数

Parameter Type Required Description
slot String no slot, if none are filled in, default to slot order, with the latest at the top
epoch String no epoch
index String no index of 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":[
        {
            "chainFullName":"Beacon Chain",
            "chainShortName":"BEACON",
            "issueDate":"1662631619000",
            "consensus":"Pos",
            "finalizedEpoch":"166263",
            "finalizedSlot":"643"
            ]
        }
    ]
}

返回参数

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 validators
> epoch String Epoch to which the slot belongs
> slot String Slot slot
> 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 Basic Information

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

Each call consumes 1 point

HTTP Request

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

Sample Request

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

Response Sample

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

#### Return Parameters

Parameter Type Description
chainFullName String Full name of the public chain, e.g., Beacon Chain
chainShortName String Abbreviation of the public chain, 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 Validator Details

Retrieve details of the validator on the beacon chain.

Each call consumes 1 point

HTTP Request

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

Sample Request

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

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":[
        {
            "chainFullName":"Beacon Chain",
            "chainShortName":"BEACON",
            "issueDate":"1662631619000",
            "consensus":"Pos",
            "finalizedEpoch":"166263",
            "finalizedSlot":"643"
            ]
        }
    ]
}

Return 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
> state String Validator state: online - had voting or block production actions in the last 2 Epochs; offline - had no actions in the last 2 Epochs
> holdingAmount String Validator balance in ETH
> totalIncome String Total income of the validator
> proposals String Number of blocks produced
> activationEpoch String Epoch when the validator was activated; for genesis block, use "0". If not activated, return empty string
> 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 List Query [explorer-api-explorer-chain-beacon-summary]

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.

Each call costs 1 point

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":[
        {
            "chainFullName":"Beacon Chain",
            "chainShortName":"BEACON",
            "issueDate":"1662631619000",
            "consensus":"Pos",
            "finalizedEpoch":"166263",
            "finalizedSlot":"643",
            "lastCheckpoint":"1703527016",
            "validators":[
                {
                    "totalValidators":"626316",
                    "newTotalValidators":"1619000",
                    .....
                }
            ],
            "staking":[
                {
                    "totalDeposits":"626316",
                    "newTotalDeposits":"-1600",
                    ....
                }
            ]
        }
    ]

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

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"
        }
    ]

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": "7369675480.531343",
            "totalHolder": "12769549",
            "dailyTradingVolume": "27488649.434369143",
            "dailyTransaction": "32618"
        }
    ]
}

Response Parameters

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

The nft held by the address

Get the list of NFTs held by the specified address

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

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name,e.g btc、eth
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": "20",
            "totalPage": "1",
            "tokenList": [
                {
                    "tokenContractAddress": "0xbf6151766f379f929ca4860d64dc0f4315c8fac7",
                    "tokenId": "76945287619620490040827884781356597586807125026349729228193629222468205936641",
                    "protocolType": "token_721",
                    "amount": "1",
                    "token": "OKXAI",
                    "logoUrl": "https://static.oklink.com/cdn/nft/a12b0503-3ab9-493c-b1fb-cebe449b81a3.jpeg"
                }
            ]
        }
    ]
}

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
> tokenId String NFT id
> protocolType String Protocol type
> amount String amount
> token String token
> logoUrl String logo Url

Historical transactions of the NFT

Get the list of NFT holder addresses

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 name,e.g btc、eth
tokenContractAddress String Yes Contract address for the collection
tokenId String Yes NFT 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": "0xdf9a2981ecd42aabf0b4e085e9c29016864432fc",
                    "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 Hold the address of this nft
> logoUrl String NFT's logo
> amount String Number of NFTs held at this address

Position list

List of position addresses in the collection.

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 name
tokenContractAddress String Yes Contract address for the collection
holderAddress String No 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": "20",
            "totalPage": "1",
            "chainFullName": "Ethereum",
            "chainShortName": "ETH",
            "circulatingSupply": "",
            "positionList": [
                {
                    "holderAddress": "0x000000000000000000000000000000000000dead",
                    "amount": "1109086030527",
                    "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:Ethereum
chainShortName String Chain Short name,e.g:ETH
circulatingSupply String Circulating supply
positionList Array Position list
> holderAddress String Holder address
> amount String Number of positions
> valueUsd String Position value in usd
> positionChange24h String 24-hour position change
> rank String rank

NFT details

Get detailed information about a particular NFT, including the floor price, attributes and rarity of the attributes.

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 name
tokenContractAddress String Yes Contract address for the collection
tokenId String Yes NFT ID

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "collectionName": "BoredApeYachtClub",
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "tokenId": "3481",
            "protocolType": "token_721",
            "token": "BAYC",
            "ownerAddress": "0xdf9a2981ecd42aabf0b4e085e9c29016864432fc",
            "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": "62",
            "minterAddress": "0xee402489d83e2b22d496910f8c810d35a3ad7b25",
            "mintTime": "1619853826000",
            "floorPrice": "45.948",
            "attributes": [
                {
                    "traitType": "Background",
                    "value": "Gray",
                    "prevalence": "0.117"
                },
                {
                    "traitType": "Mouth",
                    "value": "Bored Unshaven",
                    "prevalence": "0.1551"
                },
                {
                    "traitType": "Clothes",
                    "value": "Striped Tee",
                    "prevalence": "0.0412"
                },
                {
                    "traitType": "Eyes",
                    "value": "Bloodshot",
                    "prevalence": "0.0846"
                },
                {
                    "traitType": "Hat",
                    "value": "Halo",
                    "prevalence": "0.0324"
                },
                {
                    "traitType": "Fur",
                    "value": "Gray",
                    "prevalence": "0.0496"
                }
            ]
        }
    ]
}

Response Parameters

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

Collection info

Gets the overview information of the collection.

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 name
tokenContractAddress String Yes Contract address for the collection

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "tokenContractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "collectionName": "BoredApeYachtClub",
            "token": "BAYC",
            "protocolType": "token_721",
            "collectionLogo": "https://static.oklink.com/cdn/explorer/nft/boredapeyachtclub.png",
            "website": "",
            "createContractAddress": "0xaba7161a7fb69c88e16ed9f455ce62b791ee4d03",
            "collectionType": "top_collectibles",
            "totalSupply": "10000"
        }
    ]
}

Response Parameters

Parameter Type Description
collectionName String Collection name
collectionLogoUrl String Collection logo
tokenContractAddress String Contract address for the collection
token String token
protocolType String Protocol type; token_721 、token_1155
webSite String WebSite
creatContractAddress String Creat contract address
collectionType String Collection type:
art
sports
music
domain_names
virtual_places
trading_cards
top_collectibles
utility_nfts
totalSupply String Total supply

Collection details

Get detailed information about the collection, including the floor price, etc.

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 name
tokenContractAddress String Yes Contract address for the collection

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "collectionName": "Azuki",
            "tokenContractAddress": "0xed5af388653567af2f388e6224dc7c4b3241c544",
            "totalSupply": "10000",
            "holder": "4535",
            "avgPrice": "29115.05993895789",
            "transactionNumber": "",
            "activeUser": "",
            "transactionVolume": "1106372.2776803998",
            "transactionVolumeUsd": "1929269850.3735275",
            "floorPrice": "16.59",
            "lastPrice": "16.61"
        }
    ]
}

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

Collection NFT List

Get the NFT list of the collection

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

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name
tokenContractAddress String Yes Contract address for the collection
filterType String No filter
maximum_number_of_transfer
price_high
price_low
latest_transaction_time
maximum_number_of_transfer
tokenId String No NFT 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": "6930",
                    "holdingAddressAmount": "1",
                    "logoUrl": "https://static.coinall.ltd/cdn/nft/files/c6ee2a7f-d372-4b10-a1d9-a124fe4cfe2d.webp",
                    "protocolType": "token_721",
                    "lastTransactionTime": "1686728555000",
                    "lastPrice": "45.34",
                    "lastPriceUnit": "ETH",
                    "transactionCount": "53",
                    "mintTime": "1631463191000"
                }
            ]
        }
    ]
}

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的tokenid
> holdingAddressAmount String Holding address amount
> logoUrl String NFT logo
> protocolType String 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

Collection Floor Price

Retrieve the floor price of the collection across various NFT marketplaces.

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=0x60e4d786628fea6478f785a6d7e704777c86a7c6

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": "X2Y2",
            "floorPrice": "63",
            "priceSymbol": "ETH",
            "updateTime": "1686687612000"
        },
        {
            "marketplace": "LooksRare",
            "floorPrice": "46.98",
            "priceSymbol": "ETH",
            "updateTime": "1686692396000"
        },
        {
            "marketplace": "Blur",
            "floorPrice": "45.948",
            "priceSymbol": "ETH",
            "updateTime": "1686666755000"
        },
        {
            "marketplace": "OpenSea",
            "floorPrice": "45.55",
            "priceSymbol": "ETH",
            "updateTime": "1686730667000"
        }
    ]
}

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 trader history

Get nft trade history

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=OPTIMISM&tokenContractAddress=0x4454ee4f432f15e0d6479cfe5954e08bf0a08b02&tokenId=87605128674254524374094714059163049597322254422825169623436190981442272134141&activeType=sale

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name,e.g btc、eth
tokenContractAddress String Yes Contract address for the collection
tokenId String Yes NFT 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": "20",
            "totalPage": "0",
            "collectionName": "Optimism Name Service",
            "tokenContractAddress": "0x4454ee4f432f15e0d6479cfe5954e08bf0a08b02",
            "tokenId": "87605128674254524374094714059163049597322254422825169623436190981442272134141",
            "token": "OPNS",
            "listingList": [
                {
                    "amount": "1",
                    "createTime": "1682003228000",
                    "fromAddress": "0xb66e1f1a08e23c4ae007b971c5a64cc3d8c87579",
                    "toAddress": "0x2e60df1caf287b15347d67f0b6cd728b241535ec",
                    "price": "0.000180000000000000011",
                    "priceSymbol": "ETH",
                    "usdPrice": "0.354209400000000008",
                    "marketplace": "OpenSea",
                    "activeType": "sale",
                    "txId": "0x4a028b967de2d748d54f9026cac972a800fecb1f814b73d4d2f883c705988d62",
                    "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 project name
tokenContractAddress String Project contract address
tokenId String NFT token ID
token String Token name
logoUrl String Image link for the NFT
listingList Array Historical data list
> amount String Quantity
> createTime String 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.

HTTP Request

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

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 Blockchain abbreviation.
tokenContractAddress String Yes Collection's contract address.
tokenId String Yes NFT 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": "10",
            "collectionName": "Azuki",
            "tokenContractAddress": "0xed5af388653567af2f388e6224dc7c4b3241c544",
            "tokenId": "7034",
            "token": "AZUKI",
            "offerList": [
                {
                    "amount": "655",
                    "createTime": "1686719124000",
                    "validTime": "2147443200000",
                    "price": "16.41",
                    "priceSymbol": "Blur_ETH",
                    "priceSymbolContractAddress": "",
                    "orderHash": "0x98bbc25f543840490cb58485f9ff4f49684bd4c4d74600199e70dfc51ec0ef18",
                    "ownerAddress": "blur.io",
                    "marketplace": "Blur",
                    "usdPrice": "28586.8764"
                }
            ]
        }
    ]
}

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 project name
tokenContractAddress String Project contract address
tokenId String NFT token ID
token String Token name
offerList Array List of bids
> amount String Quantity
> createTime String Order listing 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.

HTTP Request

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

Consumption per query 1

Request Example

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

Request Parameters

Parameter Type Required Description
chainShortName String Yes Blockchain abbreviation.
tokenContractAddress String Yes Collection's contract address.
tokenId String Yes NFT 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": "3",
            "collectionName": "Azuki",
            "tokenContractAddress": "0xed5af388653567af2f388e6224dc7c4b3241c544",
            "tokenId": "5954",
            "token": "AZUKI",
            "listingList": [
                {
                    "amount": "1",
                    "createTime": "1691542042000",
                    "validTime": "1691563634000",
                    "price": "4.999",
                    "priceSymbol": "ETH",
                    "priceSymbolContractAddress": "",
                    "orderHash": "0xf90de159b6fe6aa3ee9b6455a0f58be8d16018628e92f3d4e00db5212566396b",
                    "ownerAddress": "0x9de416ab881b322ee0b4c189c2de624090280cf2",
                    "marketplace": "OpenSea",
                    "usdPrice": "9133.6729"
                }
            ]
        }
    ]
}

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 project name
tokenContractAddress String Project contract address
tokenId String NFT token ID
token String Token name
listingList Array List of bids
> amount String Quantity
> createTime String Order listing 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

DeFi API

These endpoints from this module retrieve authorization list for this address. Defi module currently supports ERC-721 and ERC-20 like protocols.

Address Authorized Tokens List

Use this API interface to query the list of token contracts authorized for an address, including authorization information for 20 tokens and 721 tokens.

HTTP Request

https://www.oklink.com/api/v5/tracker/contractscanner/token-authorized-list

Consumption per query 1

Request Example

GET /api/v5/tracker/contractscanner/token-authorized-list?address=0xb011c3F34edbDE3703C25B7eDF2E22a3b4fed08b&chainShortName=oktc

Request Parameters

Parameter Type Required Description
chainShortName String Yes Chain name, e.g ETH、BSC、Polygon、Arbitrum、Fantom、AVAX、OKC
address String Yes Address
protocolType String No Protocol type,
token_20
token_721
token_1155
Default query 20 tokens authorization information

Response Example

{
    "code":"0",
    "msg":"",
    "data":[
        {
            "chainShortName":"OKTC",
            "protocolType":"token_20",
            "tokenContractAddress":"0xef71ca2ee68f45b9ad6f72fbdb33d707b872315c",
            "authorizationAddress":"0xb011c3f34edbde3703c25b7edf2e22a3b4fed08b",
            "precision":"18",
            "tokenFullName":"ETHK",
            "token":"ETHK",
            "holdingAmount":"0.000350583522876767",
            "authorizedList":[
                {
                    "approvedContractAddress":"0xb45a2dda996c32e93b8c47098e90ed0e7ab18e39",
                    "approvedAmount":"unlimited",
                    "tokenId":"",
                    "approvedTime":"1681249168000",
                    "approvedTxId":"0x0c3add00acaa8aa641bbf05727d3c34300d1a44e858a49741c079b2d67655380",
                    "approvedProjectName":""
                }
            ]
        }
    ]
}

Response Parameters

Parameter Type Description
chainShortName String Chain name, Support chain ETH、BSC、Polygon、Arbitrum、Fantom、AVAX、OKC
protocolType String Protocol type
tokenContractAddress String Contract address
authorizationAddress String Authorization address
precision String precision
tokenFullName String Token full name
token String Token name
holdingAmount String Holding amount
authorizedList Array Authorized List
> approvedContractAddress String Approved contract address
> tokenId String Token Id
> approvedAmount String Approved amount , unlimited or amount
> approvedTime String Approved time
> approvedTxId String Approved TxId
> approvedProjectName String Approved Project Name, e.g unswap V3

Market data

`The K line data 'function module interface provides full currency token market data for 150 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.

Token list

Query the list of 150+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": "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 150 public chain tokens.

HTTP Request

GET /api/v5/explorer/tokenprice/historical

Consumption per query 1

Request Example

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

Request Parameters

Parameter Type Required Description
chainId String Yes Chain id
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]

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "price": "5.63",
            "time": "1686844800000"
        }
    ]
}

Response Parameters

Parameter Type Description
price String Price
time String Update time

Token Market data

It supports the query of Market data information of 150+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
tokenContractAddress String No Token contract address, do not fill in this parameter, default to querying the historical data of this token.

Response Example

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "lastPrice": "5.908",
            "totalSupply": "123921000",
            "circulatingSupply": "21000000",
            "volume24h": "32832.857439353",
            "marketCap": "123921000",
            "high24h": "5.98",
            "low24h": "5.449"
        }
    ]
}

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

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

Request Parameters

Parameter Type Required Description
chainId String Yes Chain id
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": "1",
            "totalPage": "10000",
            "transactionList": [
                {
                    "txId": "0x579daacaaa8c1ff25a5d0e4547b07b2e39caf83e3a628a32c6e05ae27a441ec7",
                    "poolAddress": "0x4ff4c7c8754127cc097910cf9d80400adef5b65d",
                    "tokenInAmount": "501331140598753.6",
                    "tokenInContractAddress": "0xe0a458bf4acf353cb45e211281a334bb1d837885",
                    "tokenOutAmount": "0.029930133316652997",
                    "tokenOutContractAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
                    "dexName": "Uniswap V2",
                    "factoryAddress": "0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f",
                    "transactionAmountUsd": "49.833318037797305",
                    "transactionTime": "1686887603000",
                    "height": "17489850",
                    "traderAddress": "0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f",
                    "index": "246"
                }
            ]
        }
    ]
}

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

Chain ID

chainId chain name
1 ETH
10 OPTIMISM
13 ZKSPACE
56 BSC
66 OKTC
137 POLYGON
195 TRON
250 FTM
324 ERA
805 ZKSYNC
1030 CFX
10001 ETHW
42161 ARBITRUM
43114 AVAXC

Error Code

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

Public

Error Code from 50000 to 53999

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. 429 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. 200 50030
You are not currently on the whitelist, please contact customer service 200 50034
Parameter %s error. 200 50036
Token does not exist. 200 50037
This endpoint requires that APIKey must be bound to IP 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 200 50044

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 405 50117

Trade Class

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