IoTeXscan API

Overview

At IoTeX, we provide a powerful block explorer, IoTeXScan, which allows users and developers to easily query data on the IoTeX blockchain. To make it even easier for developers familiar with Ethereum tools, we’ve implemented the same Etherscan API on IoTeXScan.

This guide provides a quick overview of how to get started with our IoTeXScan API and the available endpoints.

Getting Started

You can use IoTeXScan’s API just as you would use the Etherscan API. The API allows developers to retrieve blockchain data programmatically, such as transaction details, block information, account balances, and much more.

Here are the key steps to start using the API:

Base URL: https://index.iotexscan.io/api

API Key: To interact with the IoTeXScan API, no API key is required. However, queries are rate-limited to 1 request per second.

Example endpoint:

https://index.iotexscan.io/api?module=account&action=balance&address=0x139929a597b91ea89f41026b65b281611890f13b

Complete API

GET/api?module=contract&action=getabi

Query parameters

Response

200

Successful response

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('/api?module=contract&action=getabi?address=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

GET/api?module=contract&action=getcontractcreation

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=contract&action=getcontractcreation?contractaddresses=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=contract&action=getsourcecode

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=contract&action=getsourcecode?address=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=contract&action=checkverifystatus

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=contract&action=checkverifystatus?guid=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

POST/api?module=contract&action=verifysourcecode

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=contract&action=verifysourcecode?contractaddress=text&sourceCode=text&compilerversion=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

GET/api?module=transaction&action=getstatus

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=transaction&action=getstatus?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=gastraker&action=dailyavggasprice

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=gastraker&action=dailyavggasprice?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=gastraker&action=dailygasused

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=gastraker&action=dailygasused?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=gastraker&action=dailyavggaslimit

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=gastraker&action=dailyavggaslimit?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=token&action=addresstokennftinventory

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=token&action=addresstokennftinventory?address=0x3c5025d2b1aa4072996cba62094d01db57ffe2d3&contractaddress=0x9756e951dd76e933e34434db4ed38964951e588b', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=token&action=addresstokennftbalance

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=token&action=addresstokennftbalance?address=0x3c5025d2b1aa4072996cba62094d01db57ffe2d3', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=token&action=addresstokenbalance

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=token&action=addresstokenbalance?address=0x53bdd401a871bd0f84e94619edcc0c24489d4aab', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=token&action=tokeninfo

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=token&action=tokeninfo?contractaddress=0x9756e951dd76e933e34434db4ed38964951e588b', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=token&action=tokenholderlist

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=token&action=tokenholderlist?contractaddress=0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=iotxdailyprice

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=iotxdailyprice?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=dailytx

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=dailytx?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=dailynewaddress

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=dailynewaddress?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=dailytxnfee

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=dailytxnfee?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=iotxprice

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=iotxprice', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=dailyblockrewards

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=dailyblockrewards?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=dailyblkcount

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=dailyblkcount?startdate=2024-11-08&enddate=2024-11-15', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=stats&action=tokensupply

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=stats&action=tokensupply?contractaddress=0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=log&action=getLogs

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=log&action=getLogs?address=text&fromBlock=10000&toBlock=10000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=block&action=getblocknobytime

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=block&action=getblocknobytime?timestamp=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=block&action=getblockreward

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=block&action=getblockreward?blockno=10000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=addresstokennftinventory

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=addresstokennftinventory?address=text&convertAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=addresstokennftbalance

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=addresstokennftbalance?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=tokenbalancehistory

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=tokenbalancehistory?contractaddress=text&address=text&blockno=10000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=tokensupplyhistory

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=tokensupplyhistory?contractaddress=text&blockno=10000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=tokenbalance

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=tokenbalance?contractaddress=text&address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=token1155tx

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=token1155tx?address=0x9564dfb4f3c85f5604c6bd862de6f1b172caa982', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=tokennfttx

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=tokennfttx?address=0xd16a5552e51941486deb36109586ae4afc1d6946', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=tokentx

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=tokentx?address=0xe4650c74dfd5c20fee8dbb9beaf61820aa39ad8a', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=txlistinternal

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=txlistinternal', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=txlist

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=txlist?address=0xa00744882684c3e4747faefd68d283ea44099d03', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=balancemulti

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=balancemulti?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=account&action=balance

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=account&action=balance?address=0xa00744882684c3e4747faefd68d283ea44099d03', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_estimateGas

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_estimateGas?data=0x0&to=text&value=0x0&gasPrice=0x0&gas=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_gasPrice

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_gasPrice', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getStorageAt

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getStorageAt?address=text&position=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getCode

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getCode?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_call

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_call?to=text&data=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getTransactionReceipt

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getTransactionReceipt?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_sendRawTransaction

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_sendRawTransaction?hex=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getTransactionCount

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getTransactionCount?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getTransactionByBlockNumberAndIndex

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getTransactionByBlockNumberAndIndex?tag=0x0&index=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getTransactionByHash

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getTransactionByHash?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getBlockTransactionCountByNumber

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getBlockTransactionCountByNumber?tag=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getUncleByBlockNumberAndIndex

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getUncleByBlockNumberAndIndex?tag=0x0&index=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_getBlockByNumber

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_getBlockByNumber?tag=0x0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=proxy&action=eth_blockNumber

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=proxy&action=eth_blockNumber', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

GET/api?module=transaction&action=gettxreceiptstatus

Query parameters

Response

200

Successful response

Body

application/json

nullable any

Request

JavaScriptCurlPython

const response = await fetch('/api?module=transaction&action=gettxreceiptstatus?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6', {
    method: 'GET',
    headers: {},
});
const data = await response.json();