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

?module=contract&action=getabi

Query parameters

addressstringrequired

Eth Address or Io Address

Example: 0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=contract&action=getabi?address=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682'

200

200

text

Successful response

get

?module=contract&action=getcontractcreation

Query parameters

contractaddressesstringrequired

Eth Address or Io Address

Example: 0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=contract&action=getcontractcreation?contractaddresses=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682'

200

200

No body

Successful response

get

?module=contract&action=getsourcecode

Query parameters

addressstringrequired

Eth Address or Io Address

Example: 0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=contract&action=getsourcecode?address=0x883cb2e2d9c5d4d9af5b0d37fc39fa2284405682'

200

200

No body

Successful response

get

?module=contract&action=checkverifystatus

Query parameters

guidstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=contract&action=checkverifystatus?guid=text'

200

200

No body

Successful response

post

?module=contract&action=verifysourcecode

Query parameters

contractaddressstringrequired

Eth Address or Io Address

sourceCodestringrequired

compilerversionstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api?module=contract&action=verifysourcecode?contractaddress=text&sourceCode=text&compilerversion=text'

200

200

No body

Successful response

get

?module=transaction&action=getstatus

Query parameters

txhashstringrequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=transaction&action=getstatus?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6'

200

200

No body

Successful response

get

?module=token&action=addresstokenbalance

Query parameters

addressstringrequired

Eth Address or Io Address

Example: 0x53bdd401a871bd0f84e94619edcc0c24489d4aab

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=token&action=addresstokenbalance?address=0x53bdd401a871bd0f84e94619edcc0c24489d4aab'

200

200

No body

Successful response

get

?module=token&action=tokeninfo

Query parameters

contractaddressstringrequired

Eth Address or Io Address

Example: 0x9756e951dd76e933e34434db4ed38964951e588b

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=token&action=tokeninfo?contractaddress=0x9756e951dd76e933e34434db4ed38964951e588b'

200

200

No body

Successful response

get

?module=token&action=tokenholderlist

Query parameters

contractaddressstringrequired

Eth Address or Io Address

Example: 0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=token&action=tokenholderlist?contractaddress=0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1'

200

200

No body

Successful response

get

?module=stats&action=iotxdailyprice

Query parameters

startdatestring · default: 2025-02-28required

Start date

Example: 2025-02-28

enddatestring · default: 2025-03-07required

End date

Example: 2025-03-07

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=iotxdailyprice?startdate=2025-02-28&enddate=2025-03-07'

200

200

No body

Successful response

get

?module=stats&action=dailytx

Query parameters

startdatestring · default: 2025-02-28required

Start date

Example: 2025-02-28

enddatestring · default: 2025-03-07required

End date

Example: 2025-03-07

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=dailytx?startdate=2025-02-28&enddate=2025-03-07'

200

200

No body

Successful response

get

?module=stats&action=dailynewaddress

Query parameters

startdatestring · default: 2025-02-28required

Start date

Example: 2025-02-28

enddatestring · default: 2025-03-07required

End date

Example: 2025-03-07

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=dailynewaddress?startdate=2025-02-28&enddate=2025-03-07'

200

200

No body

Successful response

get

?module=stats&action=dailytxnfee

Query parameters

startdatestring · default: 2025-02-28required

Start date

Example: 2025-02-28

enddatestring · default: 2025-03-07required

End date

Example: 2025-03-07

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=dailytxnfee?startdate=2025-02-28&enddate=2025-03-07'

200

200

No body

Successful response

get

?module=stats&action=iotxprice

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=iotxprice'

200

200

No body

Successful response

get

?module=stats&action=dailyblockrewards

Query parameters

startdatestring · default: 2025-02-28required

Start date

Example: 2025-02-28

enddatestring · default: 2025-03-07required

End date

Example: 2025-03-07

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=dailyblockrewards?startdate=2025-02-28&enddate=2025-03-07'

200

200

No body

Successful response

get

?module=stats&action=dailyblkcount

Query parameters

startdatestring · default: 2025-02-28required

Start date

Example: 2025-02-28

enddatestring · default: 2025-03-07required

End date

Example: 2025-03-07

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=dailyblkcount?startdate=2025-02-28&enddate=2025-03-07'

200

200

No body

Successful response

get

?module=stats&action=tokensupply

Query parameters

contractaddressstringrequired

Eth Address or Io Address

Example: 0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=stats&action=tokensupply?contractaddress=0x6fbcdc1169b5130c59e72e51ed68a84841c98cd1'

200

200

No body

Successful response

get

?module=log&action=getLogs

Query parameters

addressstringrequired

Eth Address or Io Address

fromBlockstringrequired

Block number

Example: 10000

toBlockstringrequired

Block number

Example: 10000

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=log&action=getLogs?address=text&fromBlock=10000&toBlock=10000'

200

200

No body

Successful response

get

?module=block&action=getblocknobytime

Query parameters

timestampstringrequired

Unix timestamp

Example: 1741323239

closeststring · enum · default: before

Before timestamp or after timestamp, default 'before'

Options: before, after

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=block&action=getblocknobytime?timestamp=1741323239'

200

200

No body

Successful response

get

?module=block&action=getblockreward

Query parameters

blocknostringrequired

Block number

Example: 10000

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=block&action=getblockreward?blockno=10000'

200

200

No body

Successful response

get

?module=account&action=addresstokennftinventory

Query parameters

addressstringrequired

Eth Address or Io Address

convertAddressstringrequired

Eth Address or Io Address

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=addresstokennftinventory?address=text&convertAddress=text'

200

200

No body

Successful response

get

?module=account&action=addresstokennftbalance

Query parameters

addressstringrequired

Eth Address or Io Address

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=addresstokennftbalance?address=text'

200

200

No body

Successful response

get

?module=account&action=tokenbalancehistory

Query parameters

contractaddressstringrequired

Eth Address or Io Address

addressstringrequired

Eth Address or Io Address

blocknostringrequired

Block number

Example: 10000

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=tokenbalancehistory?contractaddress=text&address=text&blockno=10000'

200

200

No body

Successful response

get

?module=account&action=tokensupplyhistory

Query parameters

contractaddressstringrequired

Eth Address or Io Address

blocknostringrequired

Block number

Example: 10000

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=tokensupplyhistory?contractaddress=text&blockno=10000'

200

200

No body

Successful response

get

?module=account&action=tokenbalance

Query parameters

contractaddressstringrequired

Eth Address or Io Address

addressstringrequired

Eth Address or Io Address

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=tokenbalance?contractaddress=text&address=text'

200

200

No body

Successful response

get

?module=account&action=token1155tx

Query parameters

contractaddressstring

Eth Address or Io Address

Example: 0x36fb3f6d43460293419bd58655f675f2fce17fef

addressstringrequired

Eth Address or Io Address

Example: 0x9564dfb4f3c85f5604c6bd862de6f1b172caa982

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

startblockstring

Start block number

endblockstring

End block number

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=token1155tx?address=0x9564dfb4f3c85f5604c6bd862de6f1b172caa982'

200

200

No body

Successful response

get

?module=account&action=tokennfttx

Query parameters

contractaddressstring

Eth Address or Io Address

Example: 0xec0cd5c1d61943a195bca7b381dc60f9f545a540

addressstringrequired

Eth Address or Io Address

Example: 0xd16a5552e51941486deb36109586ae4afc1d6946

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

startblockstring

Start block number

endblockstring

End block number

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=tokennfttx?address=0xd16a5552e51941486deb36109586ae4afc1d6946'

200

200

No body

Successful response

get

?module=account&action=tokentx

Query parameters

contractaddressstring

Eth Address or Io Address

Example: 0x6c0bf4b53696b5434a0d21c7d13aa3cbf754913e

addressstringrequired

Eth Address or Io Address

Example: 0xe4650c74dfd5c20fee8dbb9beaf61820aa39ad8a

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

startblockstring

Start block number

endblockstring

End block number

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=tokentx?address=0xe4650c74dfd5c20fee8dbb9beaf61820aa39ad8a'

200

200

No body

Successful response

get

?module=account&action=txlistinternal

Query parameters

addressstring

Eth Address or Io Address

txhashstring

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

startblockstring

Start block number

endblockstring

End block number

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=txlistinternal'

200

200

No body

Successful response

get

?module=account&action=txlist

Query parameters

addressstring · default: 0xa00744882684c3e4747faefd68d283ea44099d03required

Eth Address or Io Address

Example: 0xa00744882684c3e4747faefd68d283ea44099d03

pagestring · default: 1

Page number, default 1

Example: 1

offsetstring · default: 10

Number of items per page, default 10

Example: 10

sortstring · enum · default: asc

Sort order, default 'asc

Options: asc, desc

startblockstring

Start block number

endblockstring

End block number

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=txlist?address=0xa00744882684c3e4747faefd68d283ea44099d03'

200

200

No body

Successful response

get

?module=account&action=balancemulti

Query parameters

addressstringrequired

Eth Address or Io Address

tagstring · enum · default: latest

Block tag, default 'latest

Options: latest, earliest, pending, safe, finalized

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=balancemulti?address=text'

200

200

No body

Successful response

get

?module=account&action=balance

Query parameters

addressstring · default: 0xa00744882684c3e4747faefd68d283ea44099d03required

Eth Address or Io Address

Example: 0xa00744882684c3e4747faefd68d283ea44099d03

tagstring · enum · default: latest

Block tag, default 'latest

Options: latest, earliest, pending, safe, finalized

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=account&action=balance?address=0xa00744882684c3e4747faefd68d283ea44099d03'

200

200

No body

Successful response

get

?module=proxy&action=eth_estimateGas

Query parameters

datastringrequired

Example: 0x0

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

tostringrequired

Eth Address or Io Address

valuestringrequired

Example: 0x0

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

gasPricestringrequired

Example: 0x0

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

gasstringrequired

Example: 0x0

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_estimateGas?data=0x0&to=text&value=0x0&gasPrice=0x0&gas=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_gasPrice

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_gasPrice'

200

200

No body

Successful response

get

?module=proxy&action=eth_getStorageAt

Query parameters

addressstringrequired

Eth Address or Io Address

positionstringrequired

Example: 0x0

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

tagstring · enum · default: latest

Block tag, default 'latest

Options: latest, earliest, pending, safe, finalized

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getStorageAt?address=text&position=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_getCode

Query parameters

addressstringrequired

Eth Address or Io Address

tagstring · enum · default: latest

Block tag, default 'latest

Options: latest, earliest, pending, safe, finalized

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getCode?address=text'

200

200

No body

Successful response

get

?module=proxy&action=eth_call

Query parameters

tostringrequired

Eth Address or Io Address

datastringrequired

Example: 0x0

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

tagstring · enum · default: latest

Block tag, default 'latest

Options: latest, earliest, pending, safe, finalized

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_call?to=text&data=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_getTransactionReceipt

Query parameters

txhashstringrequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getTransactionReceipt?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6'

200

200

No body

Successful response

get

?module=proxy&action=eth_sendRawTransaction

Query parameters

hexstringrequired

Example: 0x0

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_sendRawTransaction?hex=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_getTransactionCount

Query parameters

addressstringrequired

Eth Address or Io Address

tagstring · enum · default: latest

Block tag, default 'latest

Options: latest, earliest, pending, safe, finalized

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getTransactionCount?address=text'

200

200

No body

Successful response

get

?module=proxy&action=eth_getTransactionByBlockNumberAndIndex

Query parameters

tagstringrequired

block height in hex string

Example: 0x0

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

indexstringrequired

Example: 0x0

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getTransactionByBlockNumberAndIndex?tag=0x0&index=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_getTransactionByHash

Query parameters

txhashstringrequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getTransactionByHash?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6'

200

200

No body

Successful response

get

?module=proxy&action=eth_getBlockTransactionCountByNumber

Query parameters

tagstringrequired

block height in hex string

Example: 0x0

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getBlockTransactionCountByNumber?tag=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_getUncleByBlockNumberAndIndex

Query parameters

tagstringrequired

block height in hex string

Example: 0x0

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

indexstringrequired

Example: 0x0

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getUncleByBlockNumberAndIndex?tag=0x0&index=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_getBlockByNumber

Query parameters

tagstringrequired

block height in hex string

Example: 0x0

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

booleanboolean · default: false

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

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_getBlockByNumber?tag=0x0'

200

200

No body

Successful response

get

?module=proxy&action=eth_blockNumber

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=proxy&action=eth_blockNumber'

200

200

No body

Successful response

get

?module=transaction&action=gettxreceiptstatus

Query parameters

txhashstringrequired

Hash

Example: 0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api?module=transaction&action=gettxreceiptstatus?txhash=0xbe9126db27c58dd5df01340d7c3cd209481440920bddc2b7314b7123a065dda6'

200

200

No body

Successful response