IoTeXscan API | IoTeX Documentation

Overview

At IoTeX, we provide a powerful block explorer, , 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:

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

Query parameters

addressstringRequired

Eth Address or Io Address

Example: 0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682

Responses

200

Successful response

application/json

Responsestring

get

GET /api?module=contract&action=getabi?address=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682 HTTP/1.1
Host: 
Accept: */*

200

Successful response

text

get

Query parameters

contractaddressesstringRequired

Eth Address or Io Address

Example: 0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=contract&action=getcontractcreation?contractaddresses=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

Example: 0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=contract&action=getsourcecode?address=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

guidstringRequired

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=contract&action=checkverifystatus?guid=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

post

Query parameters

contractaddressstringRequired

Eth Address or Io Address

sourceCodestringRequired

compilerversionstringRequired

Responses

200

Successful response

application/json

Responseany | nullable

post

POST /api?module=contract&action=verifysourcecode?contractaddress=text&sourceCode=text&compilerversion=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

txhashstringRequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=transaction&action=getstatus?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

Example: 0x53bdd401a871bd0f84e94619edcc0c24489d4aab

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=token&action=addresstokenbalance?address=0x53bdd401a871bd0f84e94619edcc0c24489d4aab HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringRequired

Eth Address or Io Address

Example: 0x9756e951dd76e933e34434db4ed38964951e588b

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=token&action=tokeninfo?contractaddress=0x9756e951dd76e933e34434db4ed38964951e588b HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringRequired

Eth Address or Io Address

Example: 0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=token&action=tokenholderlist?contractaddress=0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

startdatestringRequired

Start date

Default: 2025-04-20Example: 2025-04-20

enddatestringRequired

End date

Default: 2025-04-27Example: 2025-04-27

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=iotxdailyprice?startdate=2025-04-20&enddate=2025-04-27 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

startdatestringRequired

Start date

Default: 2025-04-20Example: 2025-04-20

enddatestringRequired

End date

Default: 2025-04-27Example: 2025-04-27

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=dailytx?startdate=2025-04-20&enddate=2025-04-27 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

startdatestringRequired

Start date

Default: 2025-04-20Example: 2025-04-20

enddatestringRequired

End date

Default: 2025-04-27Example: 2025-04-27

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=dailynewaddress?startdate=2025-04-20&enddate=2025-04-27 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

startdatestringRequired

Start date

Default: 2025-04-20Example: 2025-04-20

enddatestringRequired

End date

Default: 2025-04-27Example: 2025-04-27

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=dailytxnfee?startdate=2025-04-20&enddate=2025-04-27 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=iotxprice HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

startdatestringRequired

Start date

Default: 2025-04-20Example: 2025-04-20

enddatestringRequired

End date

Default: 2025-04-27Example: 2025-04-27

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=dailyblockrewards?startdate=2025-04-20&enddate=2025-04-27 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

startdatestringRequired

Start date

Default: 2025-04-20Example: 2025-04-20

enddatestringRequired

End date

Default: 2025-04-27Example: 2025-04-27

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=dailyblkcount?startdate=2025-04-20&enddate=2025-04-27 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringRequired

Eth Address or Io Address

Example: 0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=stats&action=tokensupply?contractaddress=0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

fromBlockstringRequired

Block number

Example: 10000

toBlockstringRequired

Block number

Example: 10000

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=log&action=getLogs?address=text&fromBlock=10000&toBlock=10000 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

timestampstringRequired

Unix timestamp

Example: 1745747717

closeststring · enumOptional

Before timestamp or after timestamp, default 'before'

Default: beforePossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=block&action=getblocknobytime?timestamp=1745747717 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

blocknostringRequired

Block number

Example: 10000

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=block&action=getblockreward?blockno=10000 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

convertAddressstringRequired

Eth Address or Io Address

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=addresstokennftinventory?address=text&convertAddress=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=addresstokennftbalance?address=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringRequired

Eth Address or Io Address

addressstringRequired

Eth Address or Io Address

blocknostringRequired

Block number

Example: 10000

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=tokenbalancehistory?contractaddress=text&address=text&blockno=10000 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringRequired

Eth Address or Io Address

blocknostringRequired

Block number

Example: 10000

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=tokensupplyhistory?contractaddress=text&blockno=10000 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringRequired

Eth Address or Io Address

addressstringRequired

Eth Address or Io Address

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=tokenbalance?contractaddress=text&address=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringOptional

Eth Address or Io Address

Example: 0x36fb3f6d43460293419bd58655f675f2fce17fef

addressstringRequired

Eth Address or Io Address

Example: 0x9564dfb4f3c85f5604c6bd862de6f1b172caa982

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

startblockstringOptional

Start block number

endblockstringOptional

End block number

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=token1155tx?address=0x9564dfb4f3c85f5604c6bd862de6f1b172caa982 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringOptional

Eth Address or Io Address

Example: 0xec0cd5c1d61943a195bca7b381dc60f9f545a540

addressstringRequired

Eth Address or Io Address

Example: 0xd16a5552e51941486deb36109586ae4afc1d6946

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

startblockstringOptional

Start block number

endblockstringOptional

End block number

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=tokennfttx?address=0xd16a5552e51941486deb36109586ae4afc1d6946 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

contractaddressstringOptional

Eth Address or Io Address

Example: 0x6c0bf4b53696b5434a0d21c7d13aa3cbf754913e

addressstringRequired

Eth Address or Io Address

Example: 0xe4650c74dfd5c20fee8dbb9beaf61820aa39ad8a

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

startblockstringOptional

Start block number

endblockstringOptional

End block number

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=tokentx?address=0xe4650c74dfd5c20fee8dbb9beaf61820aa39ad8a HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringOptional

Eth Address or Io Address

txhashstringOptional

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

startblockstringOptional

Start block number

endblockstringOptional

End block number

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=txlistinternal HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

Default: 0xa00744882684c3e4747faefd68d283ea44099d03Example: 0xa00744882684c3e4747faefd68d283ea44099d03

pagestringOptional

Page number, default 1

Default: 1Example: 1

offsetstringOptional

Number of items per page, default 10

Default: 10Example: 10

sortstring · enumOptional

Sort order, default 'asc

Default: ascPossible values:

startblockstringOptional

Start block number

endblockstringOptional

End block number

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=txlist?address=0xa00744882684c3e4747faefd68d283ea44099d03 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

tagstring · enumOptional

Block tag, default 'latest

Default: latestPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=balancemulti?address=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

Default: 0xa00744882684c3e4747faefd68d283ea44099d03Example: 0xa00744882684c3e4747faefd68d283ea44099d03

tagstring · enumOptional

Block tag, default 'latest

Default: latestPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=account&action=balance?address=0xa00744882684c3e4747faefd68d283ea44099d03 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

datastringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

tostringRequired

Eth Address or Io Address

valuestringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

gasPricestringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

gasstringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_estimateGas?data=0x0&to=text&value=0x0&gasPrice=0x0&gas=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_gasPrice HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

positionstringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

tagstring · enumOptional

Block tag, default 'latest

Default: latestPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getStorageAt?address=text&position=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

tagstring · enumOptional

Block tag, default 'latest

Default: latestPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getCode?address=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

tostringRequired

Eth Address or Io Address

datastringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

tagstring · enumOptional

Block tag, default 'latest

Default: latestPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_call?to=text&data=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

txhashstringRequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getTransactionReceipt?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

hexstringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_sendRawTransaction?hex=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

addressstringRequired

Eth Address or Io Address

tagstring · enumOptional

Block tag, default 'latest

Default: latestPossible values:

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getTransactionCount?address=text HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

tagstringRequired

block height in hex string

Example: 0x0Pattern: ^0x[0-9a-fA-F]+$

indexstringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getTransactionByBlockNumberAndIndex?tag=0x0&index=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

txhashstringRequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getTransactionByHash?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

tagstringRequired

block height in hex string

Example: 0x0Pattern: ^0x[0-9a-fA-F]+$

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getBlockTransactionCountByNumber?tag=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

tagstringRequired

block height in hex string

Example: 0x0Pattern: ^0x[0-9a-fA-F]+$

indexstringRequiredExample: 0x0Pattern: ^0x[0-9a-fA-F]+$

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getUncleByBlockNumberAndIndex?tag=0x0&index=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

tagstringRequired

block height in hex string

Example: 0x0Pattern: ^0x[0-9a-fA-F]+$

booleanbooleanOptional

If true, returns the full transaction objects, if false only the hashes of the transactions, default 'false

Default: falseExample: false

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_getBlockByNumber?tag=0x0 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=proxy&action=eth_blockNumber HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content

get

Query parameters

txhashstringRequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

200

Successful response

application/json

Responseany | nullable

get

GET /api?module=transaction&action=gettxreceiptstatus?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6 HTTP/1.1
Host: 
Accept: */*

200

Successful response

No content