API Documentation

[ Base URL: https://blockscout.com/eth/goerli/api ]

This API is provided for developers transitioning their applications from Etherscan to BlockScout. It supports GET and POST requests.

Account ?module=account

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
200
successful operation

Result {

message
string
example: "OK"
result
wei
example: "663046792267785498951364"
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

200
error

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
200
successful operation

Result {

message
string
example: "OK"
result
array
[AddressBalance]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

AddressBalance {

address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
balance
wei
example: "663046792267785498951364"

}

200
error

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 ascending 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
200
successful operation

Result {

message
string
example: "OK"
result
array
[Transaction]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

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
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
value
wei
example: "663046792267785498951364"

}

200
error

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: txlistinternal
txhash * required
string (query)
Transaction hash. Hash of contents of the transaction. A transcation hash or address hash is required.
address
string (query)
A 160-bit code used for identifying accounts. An address hash or transaction hash is required.
sort
string (query)
A string representing the order by block number direction. Defaults to ascending order. Available values: asc, desc. WARNING: Only available if 'address' is provided.
startblock
integer (query)
A nonnegative integer that represents the starting block number. WARNING: Only available if 'address' is provided.
endblock
integer (query)
A nonnegative integer that represents the ending block number. WARNING: Only available if 'address' is provided.
page
integer (query)
A nonnegative integer that represents the page number to be used for pagination. 'offset' must be provided in conjunction. WARNING: Only available if 'address' is provided.
offset
integer (query)
A nonnegative integer that represents the maximum number of records to return when paginating. 'page' must be provided in conjunction. WARNING: Only available if 'address' is provided.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
array
[InternalTransaction]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

InternalTransaction {

blockNumber
block number
example: "34092"
contractAddress
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
errCode
string
example: "Out of gas"
from
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
gas
gas
example: "122261"
gasUsed
gas
example: "122261"
input
input
example: "0x797af627d02e23b68e085092cd0d47d6cfb54be025f37b5989c0264398f534c08af7dea9"
isError
error
enum: ["0", "1"]
enum
interpretation
"0"
ok
"1"
rejected/cancelled
timeStamp
timestamp
example: "1439232889"
to
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
type
type
example: "create"
value
wei
example: "663046792267785498951364"

}

200
error

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: tokentx
address * required
string (query)
A 160-bit code used for identifying accounts.
contractaddress
string (query)
A 160-bit code used for identifying contracts.
sort
string (query)
A string representing the order by block number direction. Defaults to ascending 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.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
array
[TokenTransfer]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

TokenTransfer {

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"
nonce
nonce
example: "0"
timeStamp
timestamp
example: "1439232889"
to
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
tokenDecimal
integer
example: "18"
tokenName
string
example: "Some Token Name"
tokenSymbol
string
example: "SYMBOL"
transactionIndex
transaction index
example: "0"
value
integer
example: "663046792267785498951364"

}

200
error

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: tokenbalance
contractaddress * required
string (query)
A 160-bit code used for identifying contracts.
address * required
string (query)
A 160-bit code used for identifying accounts.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
integer
example: "135499"
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

200
error

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: tokenlist
address * required
string (query)
A 160-bit code used for identifying accounts.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
array
[TokenBalance]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

TokenBalance {

balance
integer
example: "135499"
contractAddress
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
decimals
integer
example: "18"
name
string
example: "Some Token Name"
symbol
string
example: "SYMBOL"

}

200
error

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: getminedblocks
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
200
successful operation

Result {

message
string
example: "OK"
result
array
[Block]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

Block {

blockNumber
block number
example: "34092"
blockReward
block reward
example: "5003251945421042780"
timeStamp
timestamp
example: "1480072029"

}

200
error

Logs ?module=logs

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: logs
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: getLogs
fromBlock * required
integer (query)
A nonnegative integer that represents the starting block number. The use of 'latest' is also supported.
toBlock * required
integer (query)
A nonnegative integer that represents the ending block number. The use of 'latest' is also supported.
address * required
string (query)
A 160-bit code used for identifying contracts. An address and/or topic{x} is required.
topic0 * required
string (query)
A string equal to the first topic. A topic{x} and/or address is required.
topic1
string (query)
A string equal to the second topic. A topic{x} and/or address is required.
topic2
string (query)
A string equal to the third topic. A topic{x} and/or address is required.
topic3
string (query)
A string equal to the fourth topic. A topic{x} and/or address is required.
topic0_1_opr
string (query)
A string representing the and|or operator for topic0 and topic1. Required if topic0 and topic1 is used. Available values: and, or
topic0_2_opr
string (query)
A string representing the and|or operator for topic0 and topic2. Required if topic0 and topic2 is used. Available values: and, or
topic0_3_opr
string (query)
A string representing the and|or operator for topic0 and topic3. Required if topic0 and topic3 is used. Available values: and, or
topic1_2_opr
string (query)
A string representing the and|or operator for topic1 and topic2. Required if topic1 and topic2 is used. Available values: and, or
topic1_3_opr
string (query)
A string representing the and|or operator for topic1 and topic3. Required if topic1 and topic3 is used. Available values: and, or
topic2_3_opr
string (query)
A string representing the and|or operator for topic2 and topic3. Required if topic2 and topic3 is used. Available values: and, or
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
array
[Log]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

Log {

address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
blockNumber
block number
example: "0x5c958"
data
data
example: "0x"
gasPrice
wei
example: "0xba43b7400"
gasUsed
gas
example: "0x10682"
logIndex
hexadecimal
example: "0x"
timeStamp
timestamp
example: "0x561d688c"
topics
topics
example: ["0xf63780e752c6a54a94fc52715dbc5518a3b4c3c2833d301a204226548a2a8545"]
transactionHash
transaction hash
example: "0x9c81f44c29ff0226f835cd0a8a2f2a7eca6db52a711f8211b566fd15d3e0e8d4"
transactionIndex
hexadecimal
example: "0x"

}

200
error

Token ?module=token

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: token
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: getToken
contractaddress * required
string (query)
A 160-bit code used for identifying contracts.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
Token
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

Token {

cataloged
boolean
example: true
contractAddress
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
decimals
integer
example: "18"
name
string
example: "Some Token Name"
symbol
string
example: "SYMBOL"
totalSupply
integer
example: "1000000000"
type
token type
enum: ["ERC-20", "ERC-721"]
enum
interpretation
"ERC-20"
ERC-20 token standard
"ERC-721"
ERC-721 token standard

}

200
error

Stats ?module=stats

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: stats
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: tokensupply
contractaddress * required
string (query)
A 160-bit code used for identifying contracts.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
integer
example: "1000000000"
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

200
error

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: stats
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: ethsupply
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
integer
example: "101959776311500000000000000"
description: The total supply.
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: stats
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: ethprice
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
EthPrice
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

EthPrice {

ethbtc
ethbtc
example: "0.03161"
ethbtc_timestamp
timestamp
example: "1537234460"
ethusd
ethusd
example: "197.57"
ethusd_timestamp
timestamp
example: "1537234460"

}

Block ?module=block

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: block
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: getblockreward
blockno * required
integer (query)
A nonnegative integer that represents the block number.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
BlockReward
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

BlockReward {

blockMiner
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
blockNumber
block number
example: "34092"
blockReward
block reward
example: "5003251945421042780"
timeStamp
timestamp
example: "1480072029"
uncleInclusionReward
null
uncles
null

}

200
error

Contract ?module=contract

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: contract
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: getabi
address * required
string (query)
A 160-bit code used for identifying contracts.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
abi
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

200
error

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: contract
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: getsourcecode
address * required
string (query)
A 160-bit code used for identifying contracts.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
array
[Contract]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

Contract {

ABI
ABI
example: "[{ \"type\":\"event\", \"inputs\": [{\"name\":\"a\",\"type\":\"uint256\",\"indexed\":true},{\"name\":\"b\",\"type\":\"bytes32\",\"indexed\":false}], \"name\":\"Event\" }, { \"type\":\"event\", \"inputs\": [{\"name\":\"a\",\"type\":\"uint256\",\"indexed\":true},{\"name\":\"b\",\"type\":\"bytes32\",\"indexed\":false}], \"name\":\"Event2\" }, { \"type\":\"function\", \"inputs\": [{\"name\":\"a\",\"type\":\"uint256\"}], \"name\":\"foo\", \"outputs\": [] }]"
ContractName
string
example: "Some name"
OptimizationUsed
optimization used
enum: ["0", "1"]
enum
interpretation
"0"
false
"1"
true
SourceCode
contract source code
example: "pragma solidity >0.4.24; contract Test { constructor() public { b = hex"12345678901234567890123456789012"; } event Event(uint indexed a, bytes32 b); event Event2(uint indexed a, bytes32 b); function foo(uint a) public { emit Event(a, b); } bytes32 b; }"

}

200
error

Transaction ?module=transaction

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: transaction
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: gettxinfo
txhash * required
string (query)
Transaction hash. Hash of contents of the transaction.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
TransactionInfo
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

TransactionInfo {

blockNumber
block number
example: "34092"
confirmations
confirmations
example: "6005998"
from
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
gasLimit
wei
example: "663046792267785498951364"
gasUsed
gas
example: "122261"
hash
transaction hash
example: "0x9c81f44c29ff0226f835cd0a8a2f2a7eca6db52a711f8211b566fd15d3e0e8d4"
input
input
example: "0x797af627d02e23b68e085092cd0d47d6cfb54be025f37b5989c0264398f534c08af7dea9"
logs
array
[Log Detail]
success
boolean
example: true
timeStamp
timestamp
example: "1439232889"
to
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
value
wei
example: "663046792267785498951364"

}

200
error

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: transaction
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: gettxreceiptstatus
txhash * required
string (query)
Transaction hash. Hash of contents of the transaction.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
TransactionReceiptStatus
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

TransactionReceiptStatus {

status
status
enum: ["0", "1"]
enum
interpretation
"0"
fail
"1"
pass

}

200
error

Parameters

Name
Description
Module * required
string (query)
A string with the name of the module to be invoked. Must be set to: transaction
Action * required
string(query)
A string with the name of the action to be invoked. Must be set to: getstatus
txhash * required
string (query)
Transaction hash. Hash of contents of the transaction.
Curl

Request URL

Server Response
Code
Details
Response Body


Responses

Code
Description
200
successful operation

Result {

message
string
example: "OK"
result
TransactionStatus
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

TransactionStatus {

errDescription
string
example: "Out of gas"
isError
isError
enum: ["0", "1"]
enum
interpretation
"0"
pass
"1"
error

}

200
error