API Documentation
[ Base URL: https://localhost:80/api ]
This API is provided for developers transitioning their applications from Etherscan to BlockScout. It supports GET and POST requests.
Account ?module=account
Mimics Ethereum JSON RPC's eth_getBalance. Returns the balance as of the provided block (defaults to latest)
?module=account&action=eth_get_balance&address={addressHash}
eth_get_balance
Parameters
Name
Description
Module *required
string (query)
A string with the name of the module to be invoked.
Must be set to: account
Action *required
string (query)
A string with the name of the action to be invoked.
Must be set to: eth_get_balance
address *required
string (query)
The address of the account.
block
string (query)
Either the block number as a string, or one of latest, earliest or pending latest will be the latest balance in a *consensus* block. earliest will be the first recorded balance for the address. pending will be the latest balance in consensus *or* nonconcensus blocks.
Curl
Request URL
Server Response
Code
Details
Response Body
Responses
Code
Description
successful operation
Result {
- id
-
string
example: "1"
- jsonrpc
-
string
example: "2.0"
- result
-
string
example: "767969"
}
Get balance for address. Also available through a GraphQL 'addresses' query. If the balance hasn't been updated in a long time, we will double check with the node 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 whether or not we are checking 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.
?module=account&action=balance&address={addressHash}
balance
Parameters
Name
Description
Module *required
string (query)
A string with the name of the module to be invoked.
Must be set to: account
Action *required
string (query)
A string with the name of the action to be invoked.
Must be set to: balance
address *required
string (query)
A 160-bit code used for identifying Accounts.
Curl
Request URL
Server Response
Code
Details
Response Body
Responses
Code
Description
successful operation
Result {
- message
-
string
example: "OK"
- result
-
wei
example: "663046792267785498951364"
- status
-
status
enum: ["0", "1"]
- enum
- interpretation
- "0"
- error
- "1"
- ok
- enum
}
error
Get balance for multiple addresses. Also available through a GraphQL 'addresses' query. If the balance hasn't been updated in a long time, we will double check with the node 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. You can know that this is taking place via the `stale` attribute, which is set to `true` if a new balance is being fetched.
?module=account&action=balancemulti&address={addressHash1,addressHash2,addressHash3}
balancemulti
Parameters
Name
Description
Module *required
string (query)
A string with the name of the module to be invoked.
Must be set to: account
Action *required
string (query)
A string with the name of the action to be invoked.
Must be set to: balancemulti
address *required
string (query)
A 160-bit code used for identifying Accounts. Separate addresses by comma. Maximum of 20 addresses.
Curl
Request URL
Server Response
Code
Details
Response Body
Responses
Code
Description
successful operation
Result {
- message
-
string
example: "OK"
- result
-
array
[AddressBalance]
- status
-
status
enum: ["0", "1"]
- enum
- interpretation
- "0"
- error
- "1"
- ok
- enum
}
AddressBalance {
- address
-
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
- balance
-
wei
example: "663046792267785498951364"
- stale
-
boolean
example: true
}
error
Get pending transactions by address.
?module=account&action=pendingtxlist&address={addressHash}
pendingtxlist
Parameters
Name
Description
Module *required
string (query)
A string with the name of the module to be invoked.
Must be set to: account
Action *required
string (query)
A string with the name of the action to be invoked.
Must be set to: pendingtxlist
address *required
string (query)
A 160-bit code used for identifying Accounts.
page
integer (query)
A nonnegative integer that represents the page number to be used for pagination. 'offset' must be provided in conjunction.
offset
integer (query)
A nonnegative integer that represents the maximum number of records to return when paginating. 'page' must be provided in conjunction.
Curl
Request URL
Server Response
Code
Details
Response Body
Responses
Code
Description
successful operation
Result {
- message
-
string
example: "OK"
- result
-
array
[Transaction]
- status
-
status
enum: ["0", "1"]
- enum
- interpretation
- "0"
- error
- "1"
- ok
- enum
}
Transaction {
- blockHash
-
block hash
example: "0xd3cabad6adab0b52eb632c386ea194036805713682c62cb589b5abcd76de2159"
- blockNumber
-
block number
example: "34092"
- confirmations
-
confirmations
example: "6005998"
- contractAddress
-
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
- cumulativeGasUsed
-
gas
example: "122261"
- from
-
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
- gas
-
gas
example: "122261"
- gasPrice
-
wei
example: "663046792267785498951364"
- gasUsed
-
gas
example: "122261"
- hash
-
transaction hash
example: "0x9c81f44c29ff0226f835cd0a8a2f2a7eca6db52a711f8211b566fd15d3e0e8d4"
- input
-
input
example: "0x797af627d02e23b68e085092cd0d47d6cfb54be025f37b5989c0264398f534c08af7dea9"
- isError
-
error
enum: ["0", "1"]
- enum
- interpretation
- "0"
- ok
- "1"
- error
- enum
- nonce
-
nonce
example: "0"
- timeStamp
-
timestamp
example: "1439232889"
- to
-
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
- transactionIndex
-
transaction index
example: "0"
- txreceipt_status
-
status
enum: ["0", "1"]
- enum
- interpretation
- "0"
- error
- "1"
- ok
- enum
- value
-
wei
example: "663046792267785498951364"
}
error
Get transactions by address. Up to a maximum of 10,000 transactions. Also available through a GraphQL 'address' query.
?module=account&action=txlist&address={addressHash}
txlist
Parameters
Name
Description
Module *required
string (query)
A string with the name of the module to be invoked.
Must be set to: account
Action *required
string (query)
A string with the name of the action to be invoked.
Must be set to: txlist
address *required
string (query)
A 160-bit code used for identifying Accounts.
sort
string (query)
A string representing the order by block number direction. Defaults to descending order. Available values: asc, desc
startblock
integer (query)
A nonnegative integer that represents the starting block number.
endblock
integer (query)
A nonnegative integer that represents the ending block number.
page
integer (query)
A nonnegative integer that represents the page number to be used for pagination. 'offset' must be provided in conjunction.
offset
integer (query)
A nonnegative integer that represents the maximum number of records to return when paginating. 'page' must be provided in conjunction.
filterby
string (query)
A string representing the field to filter by. If none is given it returns transactions that match to, from, or contract address. Available values: to, from
starttimestamp
unix timestamp (query)
Represents the starting block timestamp.
endtimestamp
unix timestamp (query)
Represents the ending block timestamp.
Curl
Request URL
Server Response
Code
Details
Response Body
Responses
Code
Description
successful operation