API Documentation

[ Base URL: https://explorer.celo.org/baklava/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: 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
200
successful operation

            

Result {

id
string
example: "1"
jsonrpc
string
example: "2.0"
result
string
example: "767969"

}

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

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"
stale
boolean
example: true

}

200

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
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

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
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

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

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"
tokenID
integer
example: "0"
tokenName
string
example: "Some Token Name"
tokenSymbol
string
example: "SYMBOL"
transactionIndex
transaction index
example: "0"
value
integer
example: "663046792267785498951364"

}

200

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

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"
blockNumber
block number
example: "34092"
contractAddress
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
decimals
integer
example: "18"
name
string
example: "Some Token Name"
symbol
string
example: "SYMBOL"

}

200

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: getpendingwithdrawals

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
[PendingWithdrawals]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

PendingWithdrawals {

available_for_withdrawal
wei
example: "663046792267785498951364"
pending_withdrawals
array
[PendingWithdrawal]
total
wei
example: "663046792267785498951364"

}

200

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"
timeStamp
timestamp
example: "1480072029"

}

200

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: listaccounts

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
[Account]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

Account {

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

}

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"
feeCurrency
address hash
example: "0x88f24de331525cf6cfd7455eb96a9e4d49b7f292"
gasPrice
wei
example: "0xba43b7400"
gasUsed
gas
example: "0x10682"
gatewayFee
wei
example: "0x0"
gatewayFeeRecipient
address hash
example: "0xbbae99f0e1ee565404465638d40827b54d343638"
logIndex
hexadecimal
example: "0x"
timeStamp
timestamp
example: "0x561d688c"
topics
topics
example: ["0xf63780e752c6a54a94fc52715dbc5518a3b4c3c2833d301a204226548a2a8545"]
transactionHash
transaction hash
example: "0x9c81f44c29ff0226f835cd0a8a2f2a7eca6db52a711f8211b566fd15d3e0e8d4"
transactionIndex
hexadecimal
example: "0x"

}

200

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

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: getTokenHolders

contractaddress *required

string (query)

A 160-bit code used for identifying contracts.

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
[Token holder Detail]
status
status
enum: ["0", "1"]
enum
interpretation
"0"
error
"1"
ok

}

Token holder Detail {

address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
value
value
example: "1000000000000000000"

}

200

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: tokentx

contractaddress *required

string (query)

A 160-bit code used for identifying contracts.

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.

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

Token Transfer Transaction {

address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
amount
wei
example: "663046792267785498951364"
blockNumber
block number
example: "34092"
data
data
example: "0x"
feeCurrency
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
fromAddressHash
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
gasPrice
wei
example: "663046792267785498951364"
gasUsed
gas
example: "122261"
gatewayFee
wei
example: "663046792267785498951364"
gatewayFeeRecipient
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
logIndex
hexadecimal
example: "0x"
timeStamp
timestamp
example: "1439232889"
toAddressHash
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
topics
topics
example: ["0xf63780e752c6a54a94fc52715dbc5518a3b4c3c2833d301a204226548a2a8545"]
transactionHash
transaction hash
example: "0x9c81f44c29ff0226f835cd0a8a2f2a7eca6db52a711f8211b566fd15d3e0e8d4"
transactionIndex
transaction index
example: "0"

}

200

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

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: ethsupplyexchange

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: 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 in Wei from DB.
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: celounlocked

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

PendingWithdrawals {

available_for_withdrawal
wei
example: "663046792267785498951364"
total
wei
example: "663046792267785498951364"

}

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: coinsupply

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

result
integer
example: 101959776.3115
description: The total supply from DB minus burnt number in coin dimension.

}

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: totaltransactions

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

message
string
example: "OK"
result
integer
example: "2387845"
description: The estimated total number of transactions
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: coinprice

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

CoinPrice {

coin_btc
coin_btc
example: "0.03161"
coin_btc_timestamp
timestamp
example: "1537234460"
coin_usd
coin_usd
example: "197.57"
coin_usd_timestamp
timestamp
example: "1537234460"

}

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: totalfees

date *required

string (query)

day in ISO 8601 format (yyyy-mm-dd)

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

TotalFees {

total_fees
total_fees
example: "75411956011480008034"

}

200

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: getblocknobytime

timestamp *required

integer (query)

A nonnegative integer that represents the block timestamp (Unix timestamp in seconds).

closest *required

string (query)

Direction to find the closest block number to given timestamp. Available values: before/after.

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

BlockNo {

blockNumber
block number
example: "34092"

}

200

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: eth_block_number

id

integer (query)

A nonnegative integer that represents the json rpc request id.

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful request

            

Result {

id
string
example: "1"
jsonrpc
string
example: "2.0"
result
string
example: "767969"

}

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: listcontracts

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.

filter

string (query)

verified|decompiled|unverified|not_decompiled|empty, or 1|2|3|4|5 respectively. This requests only contracts with that status.

not_decompiled_with_version

string (query)

Ensures that none of the returned contracts were decompiled with the provided version. Ignored unless filtering for decompiled 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\": [] }]"
Address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
ContractName
string
example: "Some name"
OptimizationUsed
optimization used
enum: ["0", "1"]
enum
interpretation
"0"
false
"1"
true

}

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

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.

ignoreProxy

integer (query)

Indicates if we want to ignore if the contract is a proxy (0 false, 1 true. Default false).

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\": [] }]"
Address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
ContractName
string
example: "Some name"
DecompiledSourceCode
contract decompiled source code
example: const name() = 'CryptoKitties' const GEN0_STARTING_PRICE() = 10^16 const GEN0_AUCTION_DURATION() = 86400 const GEN0_CREATION_LIMIT() = 45000 const symbol() = 'CK' const PROMO_CREATION_LIMIT() = 5000 def storage: ceoAddress is addr # mask(160, 0) at storage #0 cfoAddress is addr # mask(160, 0) at storage #1 stor1.768 is uint16 => uint256 # mask(256, 768) at storage #1 cooAddress is addr # mask(160, 0) at storage #2 stor2.0 is uint256 => uint256 # mask(256, 0) at storage #2 paused is uint8 # mask(8, 160) at storage #2 stor2.256 is uint256 => uint256 # mask(256, 256) at storage #2 stor3 is uint32 # ...<continues>
DecompilerVersion
decompiler version
example: decompiler.version
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

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: verify

addressHash *required

string (query)

The address of the contract.

name *required

string (query)

The name of the contract.

compilerVersion *required

string (query)

The compiler version for the contract.

optimization *required

boolean (query)

Whether or not compiler optimizations were enabled.

contractSourceCode *required

string (query)

The source code of the contract.

constructorArguments

string (query)

The constructor argument data provided.

autodetectConstructorArguments

boolean (query)

Whether or not automatically detect constructor argument.

evmVersion

string (query)

The EVM version for the contract.

optimizationRuns

integer (query)

The number of optimization runs used during compilation

proxyAddress

string (query)

If the contract is behind a proxy, the address of that proxy contract

library1Name

string (query)

The name of the first library used.

library1Address

string (query)

The address of the first library used.

library2Name

string (query)

The name of the second library used.

library2Address

string (query)

The address of the second library used.

library3Name

string (query)

The name of the third library used.

library3Address

string (query)

The address of the third library used.

library4Name

string (query)

The name of the fourth library used.

library4Address

string (query)

The address of the fourth library used.

library5Name

string (query)

The name of the fourth library used.

library5Address

string (query)

The address of the fourth library used.

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

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\": [] }]"
Address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
ContractName
string
example: "Some name"
OptimizationUsed
optimization used
enum: ["0", "1"]
enum
interpretation
"0"
false
"1"
true

}

200

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: verify_via_sourcify

addressHash *required

string (query)

The address of the contract.

files

file[] (query)

Array with sources and metadata files

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

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\": [] }]"
Address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
ContractName
string
example: "Some name"
OptimizationUsed
optimization used
enum: ["0", "1"]
enum
interpretation
"0"
false
"1"
true

}

200

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: verify_vyper_contract

addressHash *required

string (query)

The address of the contract.

name *required

string (query)

The name of the contract.

compilerVersion *required

string (query)

The compiler version for the contract.

contractSourceCode *required

string (query)

The source code of the contract.

constructorArguments

string (query)

The constructor argument data provided.

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

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\": [] }]"
Address
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
ContractName
string
example: "Some name"
OptimizationUsed
optimization used
enum: ["0", "1"]
enum
interpretation
"0"
false
"1"
true

}

200

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: verifysourcecode

codeformat *required

string (query)

Format of sourceCode(supported only "solidity-standard-json-input")

contractaddress *required

string (query)

The address of the contract.

contractname *required

string (query)

The name of the contract. It could be empty string(""), just contract name("ContractName"), or filename and contract name("contracts/contract_1.sol:ContractName")

compilerversion *required

string (query)

The compiler version for the contract.

sourceCode *required

string (query)

Standard input json

constructorArguements

string (query)

The constructor argument data provided.

autodetectConstructorArguments

boolean (query)

Whether or not automatically detect constructor argument.

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

UID {

UID
string
example: b080b96bd06ad1c9341c2afb7e3730311388544961acde94

}

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: checkverifystatus

guid *required

string (query)

A string used for identifying verification attempt

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Status {

status
string
example: `Pending in queue` | `Pass - Verified` | `Fail - Unable to verify` | `Unknown UID`

}

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.

index

integer (query)

A nonnegative integer that represents the log index to be used for pagination.

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"
gasPrice
wei
example: "663046792267785498951364"
gasUsed
gas
example: "122261"
hash
transaction hash
example: "0x9c81f44c29ff0226f835cd0a8a2f2a7eca6db52a711f8211b566fd15d3e0e8d4"
input
input
example: "0x797af627d02e23b68e085092cd0d47d6cfb54be025f37b5989c0264398f534c08af7dea9"
logs
array
[Log Detail]
revertReason
revert_reason
example: "No credit of that type"
success
boolean
example: true
timeStamp
timestamp
example: "1439232889"
to
address hash
example: "0x95426f2bc716022fcf1def006dbc4bb81f5b5164"
value
wei
example: "663046792267785498951364"

}

200

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

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

Epoch ?module=epoch

Parameters

Name

Description

Module *required

string (query)

A string with the name of the module to be invoked.

Must be set to: epoch

Action *required

string (query)

A string with the name of the action to be invoked.

Must be set to: getvoterrewards

voterAddress *required

string (query)

Voter address or addresses (comma-separated) for which rewards were minted.

groupAddress

string (query)

Group address or addresses (comma-separated) that voter(s) voted for.

dateFrom

string (query)

Date (in ISO 8601 format) for which to filter from.

dateTo

string (query)

Date (in ISO 8601 format) for which to filter to.

blockNumberFrom

string (query)

Block number for which to filter from.

blockNumberTo

string (query)

Block number for which to filter to.

pageNumber

integer (query)

A nonnegative integer that represents the page number to be used for pagination. Default: 1

pageSize

integer (query)

A nonnegative integer that represents the maximum number of records (per page) to return when paginating. Default: 100

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

Epoch rewards {

rewards
array
[Epoch Reward]
totalRewardAmounts
Amounts per currency
totalRewardCount
string

}

200

Parameters

Name

Description

Module *required

string (query)

A string with the name of the module to be invoked.

Must be set to: epoch

Action *required

string (query)

A string with the name of the action to be invoked.

Must be set to: getvalidatorrewards

validatorAddress *required

string (query)

Validator address or addresses (comma-separated) for which rewards were minted.

groupAddress

string (query)

Group address or addresses (comma-separated) that validators(s) belong to.

dateFrom

string (query)

Date (in ISO 8601 format) for which to filter from.

dateTo

string (query)

Date (in ISO 8601 format) for which to filter to.

blockNumberFrom

string (query)

Block number for which to filter from.

blockNumberTo

string (query)

Block number for which to filter to.

pageNumber

integer (query)

A nonnegative integer that represents the page number to be used for pagination. Default: 1

pageSize

integer (query)

A nonnegative integer that represents the maximum number of records (per page) to return when paginating. Default: 100

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

Epoch validator rewards {

rewards
array
[Epoch Reward]
totalRewardAmounts
Amounts per currency
totalRewardCount
string

}

200

Parameters

Name

Description

Module *required

string (query)

A string with the name of the module to be invoked.

Must be set to: epoch

Action *required

string (query)

A string with the name of the action to be invoked.

Must be set to: getgrouprewards

groupAddress *required

string (query)

Group address or addresses (comma-separated) for which rewards were minted.

validatorAddress

string (query)

Validator address or addresses (comma-separated) that paid commission to the group(s).

dateFrom

string (query)

Date (in ISO 8601 format) for which to filter from.

dateTo

string (query)

Date (in ISO 8601 format) for which to filter to.

blockNumberFrom

string (query)

Block number for which to filter from.

blockNumberTo

string (query)

Block number for which to filter to.

pageNumber

integer (query)

A nonnegative integer that represents the page number to be used for pagination. Default: 1

pageSize

integer (query)

A nonnegative integer that represents the maximum number of records (per page) to return when paginating. Default: 100

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

Epoch group rewards {

rewards
array
[Epoch Reward]
totalRewardAmounts
Amounts per currency
totalRewardCount
string

}

200

Parameters

Name

Description

Module *required

string (query)

A string with the name of the module to be invoked.

Must be set to: epoch

Action *required

string (query)

A string with the name of the action to be invoked.

Must be set to: getepoch

epochNumber *required

string (query)

Epoch number you want to fetch the data for.

Curl

          
Request URL

          
Server Response

Code

Details

Response Body


            

Responses

Code

Description
200
successful operation

            

Result {

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

}

Epoch data {

blockHash
block hash
example: "0xd3cabad6adab0b52eb632c386ea194036805713682c62cb589b5abcd76de2159"
blockNumber
block number
example: "34092"
carbonOffsettingTargetEpochRewards
string
communityTargetEpochRewards
string
electableValidatorsMax
string
goldTotalSupply
string
reserveBolster
string
reserveGoldBalance
string
rewardsMultiplier
string
rewardsMultiplierMax
string
rewardsMultiplierOver
string
rewardsMultiplierUnder
string
stableUsdTotalSupply
string
targetTotalSupply
string
targetVotingFraction
string
targetVotingYield
string
targetVotingYieldAdjustmentFactor
string
targetVotingYieldMax
string
totalLockedGold
string
totalNonVoting
string
totalVotes
string
validatorTargetEpochRewards
string
voterTargetEpochRewards
string
votingFraction
string

}

200