Account

?module=account

https://instance_base_url/api?module=account

Return balance from a provided block

eth_get_balance

Mimics Ethereum JSON RPC's eth_getBalance

Example:

https://instance_base_url/api
   ?module=account
   &action=eth_get_balance
   &address={addressHash}
Parameter
Description

address

string containing the address hash.

block

optional. Block number as a string, or latest, earliest or pending Latest is the latest balance in a consensus block. Earliest is the first recorded balance for the address. Pending is the latest balance in a consensus or nonconsensus block.

Get the native token balance for an address

balance

Many chains use their own native tokens. On Ethereum, this will return the result in "Ether", on Gnosis it will be "xDai", etc. Results are returned in wei.

Example:

https://instance_base_url/api
   ?module=account
   &action=balance
   &address={addressHash}
Parameter
Description

address

string containing the address hash.

Also available through a GraphQL address query.

If the balance hasn't been updated recently, the node is double-checked to fetch the absolute latest balance. This will not be reflected in the current request, but once it is updated, subsequent requests will show the updated balance. If you want to know if there is a check for another balance, use the balancemulti action. That contains a property called stale that will let you know to recheck that balance in the near future.

Get balance for multiple addresses

balancemulti

Example:

https://instance_base_url/api
   ?module=account
   &action=balancemulti
   &address={addressHash1,addressHash2,addressHash3}
Parameter
Description

address

string containing the address hash, comma separated. Max 20 addresses.

Also available through a GraphQL 'addresses' query

If the balance hasn't been updated in a long time, the node is double checked to fetch the absolute latest balance. This is not reflected in the current request, but once it is updated, subsequent requests will show the updated balance. The stale attribute will be set to true if a new balance is being fetched.

Get pending transactions by address

pendingtxlist

Example:

https://instance_base_url/api
   ?module=account
   &action=pendingtxlist
   &address={addressHash}
   &page=1
   &offset=5
Parameter
Description

address

string containing the address hash.

page

optional integer representing the page number used for pagination. 'offset' must also be provided.

offset

optional integer representing number of transactions returned per page. page must also be provided.

Get transactions by address

txlist

Maximum of 10,000 transactions. Also available through a GraphQL 'address' query. For faster results, specify a smaller block range to search using the startblock and endblock parameters

Example:

https://instance_base_url/api
   ?module=account
   &action=txlist
   &address={addressHash}
   &startblock=555555
   &endblock=666666
   &page=1
   &offset=5
   &sort=asc
Parameter
Description

address

string containing the address hash.

sort

optional sorting preference, asc for ascending and desc for descending. Descending is default.

startblock

optional integer block number to start transaction search

endblock

optionalinteger block number to stop transaction search.

page

optional integer representing the page number used for pagination. offset must also be provided.

offset

optional integer representing number of transactions returned per page. page must also be provided.

filter_by

optional string representing the field to filter by. Values include to and from. If none provided returns transactions that match to, from, or contract address.

start_timestamp

optional starting block unix timestamp.

end_timestamp

optional ending block unix timestamp.

Get internal transactions by transaction or address hash

txlistinternal

Up to a maximum of 10,000 internal transactions. Also available through a GraphQL 'transaction' query. For faster results, specify a smaller block range to search using the start_block and end_block parameters.

Example:

https://instance_base_url/api
   ?module=account
   &action=txlistinternal
   &txhash={transactionHash}
   &startblock=555555
   &endblock=666666
   &page=1
   &offset=5
   &sort=asc
Parameter
Description

txhash

string representing the transaction hash to check for internal transactions

address

optional string containing the address hash.

sort

optional sorting preference, asc for ascending and desc for descending. Descending is default. Only available if 'address' is provided.

startblock

optional integer block number to start transaction search. Only available if 'address' is provided.

endblock

optionalinteger block number to stop transaction search. Only available if 'address' is provided.

page

optional integer representing the page number used for pagination. offset must also be provided. Only available if 'address' is provided.

offset

optional integer representing number of transactions returned per page. page must also be provided. Only available if 'address' is provided.

Get token transfer events by address

tokentx

Up to a maximum of 10,000 token transfer events. Also available through the GraphQL token_transfers query.

Example:

https://instance_base_url/api
   ?module=account
   &action=tokentx
   &address={addressHash}
   &page=1
   &offset=10
   &sort=asc
Parameter
Description

address

string containing the address hash.

contract address

optional string with the token contract address to identify a contract.

sort

optional sorting preference, asc for ascending and desc for descending. Descending is default.

startblock

optional integer block number to start transaction search

endblock

optionalinteger block number to stop transaction search.

page

optional integer representing the page number used for pagination. offset must also be provided.

offset

optional integer representing number of transactions returned per page. page must also be provided.

Get ERC-721 token transfer events by address

tokennfttx

Example:

https://instance_base_url/api
   ?module=account
   &action=tokennfttx
   &address={addressHash}
   &page=1
   &offset=10
   &sort=asc
Parameter
Description

address

string containing the address hash.

contractaddress

optional string with the token contract address to identify a contract.

sort

optional sorting preference, asc for ascending and desc for descending. Descending is default.

startblock

optional integer block number to start transaction search

endblock

optional integer block number to stop transaction search.

page

optional integer representing the page number used for pagination. offset must also be provided.

offset

optional integer representing number of transactions returned per page. page must also be provided.

Usage:

  • To fetch ERC-721 token transfers by address, specify address parameter

  • To fetch ERC-721 token transfers by token, specify contractaddress parameter

  • To fetch ERC-721 token transfers by address filtered by token, specify both address and contractaddress parameters

Get token account balance for token contract address

tokenbalance

Example:

https://instance_base_url/api
   ?module=account
   &action=tokenbalance
   &contractaddress={contractAddressHash}
   &address={addressHash}
Parameter
Description

contract address

string containing the contract address hash.

address

string containing the account address hash to retrieve balance for.

Get list of tokens owned by address

tokenlist

Example:

https://instance_base_url/api
   ?module=account
   &action=tokenlist
   &address={addressHash}
Parameter
Description

address

string containing the account address hash.

Get list of blocks mined by address

getminedblocks

Example:

https://instance_base_url/api
   ?module=account
   &action=getminedblocks
   &address={addressHash}
Parameter
Description

address

string containing the address hash.

page

optional integer representing the page number used for pagination. 'offset' must also be provided.

offset

optional integer representing number of transactions returned per page. page must also be provided.

Get a list of accounts and their balances

listaccounts

Lists accounts and native balances, sorted ascending by the time they were first seen by the explorer.

Example:

https://instance_base_url/api
   ?module=account
   &action=listaccounts
   &address={addressHash}
   &page=1
   &offset=3
Parameter
Description

page

optional integer representing the page number used for pagination. 'offset' must also be provided.

offset

optional integer representing number of transactions returned per page. page must also be provided.

If the balance hasn't been updated in a long time, the node is double checked to fetch the absolute latest balance. This is not reflected in the current request, but once it is updated, subsequent requests will show the updated balance. The stale attribute will be set to true if a new balance is being fetched.

Last updated

Logo

Copyright © Blockscout Limited 2023-2024