Home

Chain API

v1.0.0
Base URLs
https://eos.nownodes.io/v1/chain
https://eos.nownodes.io/v1

OAS 3.0 Nodeos Chain API Specification

Authentication

api-keyAuthapiKey

API Key: api-key in header

Chain

Chain

POST
https://eos.nownodes.io/v1/chain/get_account

Returns an object containing various details about a specific account on the blockchain.

Body

application/json

JSON Object with single member "account_name"

account_namestring | string | string | stringrequired

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_block

Returns an object containing various details about a specific block on the blockchain.

Body

application/json
block_num_or_idstringrequired

Provide a block number or a block id

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_block_info

Similar to get_block but returns a fixed-size smaller subset of the block data.

Body

application/json
block_numintegerrequired

Provide a block number

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_info

Returns an object containing various details about the blockchain.

Response

200OK

OK

POST
https://eos.nownodes.io/v1/chain/push_transaction

This method expects a transaction in JSON format and will attempt to apply it to the blockchain.

Body

application/json
signaturesArray<items>

array of signatures required to authorize transaction

compressionboolean

Compression used, usually false

packed_context_free_datastring

json to hex

packed_trxstring

Transaction object json to hex

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/send_transaction

This method expects a transaction in JSON format and will attempt to apply it to the blockchain.

Body

application/json
signaturesArray<items>

array of signatures required to authorize transaction

compressionboolean

Compression used, usually false

packed_context_free_datastring

json to hex

packed_trxstring

Transaction object json to hex

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/push_transactions

This method expects a transaction in JSON format and will attempt to apply it to the blockchain.

Body

application/json
Array<items>
Show child attributes
expirationstringrequired

Time that transaction must be confirmed by.

ref_block_numintegerrequired
ref_block_prefixintegerrequired

32-bit portion of block ID

max_net_usage_wordsstring | integerrequired

A whole number

max_cpu_usage_msstring | integerrequired

A whole number

delay_secintegerrequired
context_free_actionsArray<items>required
Show child attributes
accountstring | string | string | stringrequired
namestring | string | string | stringrequired
authorizationArray<1>required
Show child attributes
actorstring | string | string | stringrequired
permissionstring | string | string | stringrequired
dataobjectrequired
hex_datastringrequired
actionsArray<items>required
Show child attributes
accountstring | string | string | stringrequired
namestring | string | string | stringrequired
authorizationArray<1>required
Show child attributes
actorstring | string | string | stringrequired
permissionstring | string | string | stringrequired
dataobjectrequired
hex_datastringrequired
transaction_extensionsArray<block_extensions>

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_block_header_state

Retrieves the glock header state

Body

application/json
block_num_or_idstringrequired

Provide a block_number or a block_id

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_abi

Retrieves the ABI for a contract based on its account name

Body

application/json
account_namestring | string | string | stringrequired

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_currency_balance

Retrieves the current balance

Body

application/json
codestring | string | string | stringrequired
accountstring | string | string | stringrequired
symbolitemsrequired

A string representation of an EOSIO symbol, composed of a float with a precision of 4, and a symbol composed of capital letters between 1-7 letters separated by a space, example 1.0000 ABC.

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_currency_stats

Retrieves currency stats

Body

application/json
codestring | string | string | string
symbolitems

A string representation of an EOSIO symbol, composed of a float with a precision of 4, and a symbol composed of capital letters between 1-7 letters separated by a space, example 1.0000 ABC.

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_required_keys

Returns the required keys needed to sign a transaction.

Body

application/json
transactionitemsrequired
Show child attributes
expirationstringrequired

Time that transaction must be confirmed by.

ref_block_numintegerrequired
ref_block_prefixintegerrequired

32-bit portion of block ID

max_net_usage_wordsstring | integerrequired

A whole number

max_cpu_usage_msstring | integerrequired

A whole number

delay_secintegerrequired
context_free_actionsArray<items>required
Show child attributes
accountstring | string | string | stringrequired
namestring | string | string | stringrequired
authorizationArray<1>required
Show child attributes
actorstring | string | string | stringrequired
permissionstring | string | string | stringrequired
dataobjectrequired
hex_datastringrequired
actionsArray<items>required
Show child attributes
accountstring | string | string | stringrequired
namestring | string | string | stringrequired
authorizationArray<1>required
Show child attributes
actorstring | string | string | stringrequired
permissionstring | string | string | stringrequired
dataobjectrequired
hex_datastringrequired
transaction_extensionsArray<block_extensions>
available_keysArray<items>required

Provide the available keys

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_producers

Retrieves producers list

Body

application/json
limitstringrequired

total number of producers to retrieve

lower_boundstringrequired

In conjunction with limit can be used to paginate through the results. For example, limit=10 and lower_bound=10 would be page 2

jsonboolean

return result in JSON format

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_raw_code_and_abi

Retrieves raw code and ABI for a contract based on account name

Body

application/json
account_namestring | string | string | stringrequired

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_scheduled_transaction

Retrieves the scheduled transaction

Body

application/json
lower_boundlower_bound

Date/time string in the format YYYY-MM-DDTHH:MM:SS.sss

limitinteger

The maximum number of transactions to return

jsonboolean

true/false whether the packed transaction is converted to json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_table_by_scope

Retrieves table scope

Body

application/json
codestringrequired

name of the contract to return table data for

tablestring

Filter results by table

lower_boundstring

Filters results to return the first element that is not less than provided value in set

upper_boundstring

Filters results to return the first element that is greater than provided value in set

limitinteger<int32>10

Limit number of results returned.

reversebooleanfalse

Reverse the order of returned results

show_payerbooleanfalse

Show RAM payer

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_table_rows

Returns an object containing rows from the specified table.

Body

application/json
codestringrequired

The name of the smart contract that controls the provided table

tablestringrequired

The name of the table to query

scopestringrequired

The account to which this data belongs

index_positionstring

Position of the index used, accepted parameters primary, secondary, tertiary, fourth, fifth, sixth, seventh, eighth, ninth , tenth

key_typestring

Type of key specified by index_position (for example - uint64_t or name)

encode_typestring
lower_boundstring

Filters results to return the first element that is not less than provided value in set

upper_boundstring

Filters results to return the first element that is greater than provided value in set

limitinteger<int32>10

Limit number of results returned.

reversebooleanfalse

Reverse the order of returned results

show_payerbooleanfalse

Show RAM payer

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_kv_table_rows

Returns an object containing rows from the specified kv table.

Body

application/json
codestringrequired

The name of the smart contract that controls the provided kv table

tablestringrequired

The name of the kv table to query

index_namestringrequired

The name of primary or secondary index

encode_typestring

Encoding type to use for index_value, lower_bound, and upper_bound. Valid values are "bytes", "string", "name", "dec", or "hex"'. If not provided, the appropriate value based on the index_name's abi indicated type, for integers "dec" is the default. "bytes" are encoded as hexidecimal strings and can be used for any type of field. Example values for each type "bytes" => "0000000000000e1a", "string" => "Some value!", "name" => "eosio", "dec" => "3610", and "hex" => "e1a".

index_valuestring

Index value used for point query encoded as 'encode_type'. Cannot be used with either lower_bound or upper_bound.

lower_boundstring

Lower bound index value for ranged query. Query result includes rows specified with lower_bound. Cannot be used with index_value. If index_value and lower_bound are not provided, then lower_bound is defaulted to be the lowest value in the table for that index_name.

upper_boundstring

Upper bound index value for ranged query. Query result includes rows specified with upper_bound. Cannot be used with index_value. If index_value and upper_bound are not provided, then upper_bound is defaulted to be the highest value in the table for that index_name.

limitinteger<int32>

Limit number of results returned

reverseboolean

Reverse the order of returned results

show_payerboolean

Provide the ram payer for each row

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/abi_json_to_bin

Returns an object containing the serialized action data.

Body

application/json
codestring | string | string | string
actionstring | string | string | string
argsobject

json object of the action parameters that will be serialized.

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/abi_bin_to_json

Returns an object containing the deserialized action data.

Body

application/json
codestring | string | string | stringrequired
actionstring | string | string | stringrequired
binargsbinargsrequired

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_code

Returns an object containing the smart contract WASM code.

Body

application/json
account_namestring | string | string | stringrequired
code_as_wasminteger1required

This must be 1 (true)

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_raw_abi

Returns an object containing the smart contract abi.

Body

application/json
account_namestring | string | string | stringrequired

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_activated_protocol_features

Retreives the activated protocol features for producer node

Body

application/json
lower_boundinteger

Lower bound

upper_boundinteger

Upper bound

limitinteger

The limit, default is 10

search_by_block_numboolean

Flag to indicate it is has to search by block number

reverseboolean

Flag to indicate it has to search in reverse

Response

200OK

OK

Authorization

api-keyAuthapiKey in header
POST
https://eos.nownodes.io/v1/chain/get_accounts_by_authorizers

Given a set of account names and public keys, find all account permission authorities that are, in part or whole, satisfiable

Body

application/json
accountsArray<string | string | string | string | 1>

List of authorizing accounts and/or actor/permissions

Show child attributes
Any of
Any of

String representation of privileged EOSIO name type

string

String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5

string

String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed

string

String representation of EOSIO name type

string
actorstring | string | string | stringrequired
permissionstring | string | string | stringrequired
keysArray<items>

List of authorizing keys

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

Db_Size

Db size

get

POST
https://eos.nownodes.io/v1/chain/db_size/get

Retrieves database stats

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

Net

Net

connections

POST
https://eos.nownodes.io/v1/chain/net/connections

Returns an array of all peer connection statuses.

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

connect

POST
https://eos.nownodes.io/v1/chain/net/connect

Initiate a connection to a specified peer.

Body

application/json
endpointstringrequired

the endpoint to connect to expressed as either IP address or URL

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

disconnect

POST
https://eos.nownodes.io/v1/chain/net/disconnect

Initiate disconnection from a specified peer.

Body

application/json
endpointstringrequired

the endpoint to disconnect from, expressed as either IP address or URL

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

status

POST
https://eos.nownodes.io/v1/chain/net/status

Retrieves the connection status for a specified peer.

Body

application/json
endpointstringrequired

the endpoint to get the status for, to expressed as either IP address or URL

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

Producer

Producer

pause

POST
https://eos.nownodes.io/v1/chain/producer/pause

Pause producer node

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

resume

POST
https://eos.nownodes.io/v1/chain/producer/resume

Resume producer node

Body

application/json

Resumes activity for producer

object

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

paused

POST
https://eos.nownodes.io/v1/chain/producer/paused

Retreives paused status for producer node

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

get_runtime_options

POST
https://eos.nownodes.io/v1/chain/producer/get_runtime_options

Retreives run time options for producer node

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

update_runtime_options

POST
https://eos.nownodes.io/v1/chain/producer/update_runtime_options

Update run time options for producer node

Body

application/json
optionsobjectrequired

Defines the run time options to set for the producer

Show child attributes
max_transaction_timeinteger

Max transaction time

max_irreversible_block_ageinteger

Max irreversible block age

produce_time_offset_usinteger

Time offset

last_block_time_offset_usinteger

Last block time offset

max_scheduled_transaction_time_per_block_msinteger

Max scheduled transaction time per block in ms

subjective_cpu_leeway_usinteger

Subjective CPU leeway

incoming_defer_ratiointeger

Incoming defer ration

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

get_greylist

POST
https://eos.nownodes.io/v1/chain/producer/get_greylist

Retreives the greylist for producer node

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

add_greylist_accounts

POST
https://eos.nownodes.io/v1/chain/producer/add_greylist_accounts

Adds accounts to grey list for producer node

Body

application/json
paramsobjectrequired
Show child attributes
accountsArray<items>

List of account names to add

Show child attributes
Any of

String representation of privileged EOSIO name type

string

String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5

string

String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed

string

String representation of EOSIO name type

string

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

remove_greylist_accounts

POST
https://eos.nownodes.io/v1/chain/producer/remove_greylist_accounts

Removes accounts from greylist for producer node

Body

application/json
paramsobjectrequired
Show child attributes
accountsArray<items>

List of account names to remove

Show child attributes
Any of

String representation of privileged EOSIO name type

string

String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5

string

String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed

string

String representation of EOSIO name type

string

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

get_whitelist_blacklist

POST
https://eos.nownodes.io/v1/chain/producer/get_whitelist_blacklist

Retreives the white list and black list for producer node

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

set_whitelist_blacklist

POST
https://eos.nownodes.io/v1/chain/producer/set_whitelist_blacklist

Sets the white list and black list for producer node

Body

application/json
paramsobjectrequired

Defines the actor whitelist and blacklist, the contract whitelist and blacklist, the action blacklist and key blacklist

Show child attributes
actor_whitelistArray<items>
Show child attributes
Any of

String representation of privileged EOSIO name type

string

String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5

string

String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed

string

String representation of EOSIO name type

string
actor_blacklistArray<items>
Show child attributes
Any of

String representation of privileged EOSIO name type

string

String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5

string

String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed

string

String representation of EOSIO name type

string
contract_whitelistArray<items>
Show child attributes
Any of

String representation of privileged EOSIO name type

string

String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5

string

String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed

string

String representation of EOSIO name type

string
contract_blacklistArray<items>
Show child attributes
Any of

String representation of privileged EOSIO name type

string

String representation of basic EOSIO name type, must be 12 characters and contain only a-z and 0-5

string

String representation of EOSIO bid name type, 1-12 characters and only a-z and 0-5 are allowed

string

String representation of EOSIO name type

string
action_blacklistArray<Array<string | string | string | string & 1>>
key_blacklistArray<items>uint64double

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

create_snapshot

POST
https://eos.nownodes.io/v1/chain/producer/create_snapshot

Creates a snapshot for producer node

Body

application/json
nextobjectrequired

Defines the snapshot to be created

Show child attributes
head_block_idhead_block_id
head_block_numinteger

Highest block number on the chain

head_block_timestring

Highest block unix timestamp

versioninteger

Version number

snapshot_namestring

The name of the snapshot

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

get_integrity_hash

POST
https://eos.nownodes.io/v1/chain/producer/get_integrity_hash

Retreives the integrity hash for producer node

Body

application/json

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

schedule_protocol_feature_activations

POST
https://eos.nownodes.io/v1/chain/producer/schedule_protocol_feature_activations

Schedule protocol feature activation for producer node

Body

application/json
scheduleobjectrequired
Show child attributes
protocol_features_to_activateArray<head_block_id>

List of protocol features to activate

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

get_supported_protocol_features

POST
https://eos.nownodes.io/v1/chain/producer/get_supported_protocol_features

Retreives supported protocol features for producer node

Body

application/json
paramsobjectrequired

Defines filters based on which to return the supported protocol features

Show child attributes
exclude_disabledboolean

Exclude disabled protocol features

exclude_unactivatableboolean

Exclude unactivatable protocol features

Response

200OK

OK

Authorization

api-keyAuthapiKey in header

Trace Api

Trace api

POST
https://eos.nownodes.io/v1/chain/trace_api/get_block

Returns a block trace object containing retired actions and related metadata.

Body

application/json
block_numintegerrequired

Provide a block number

Response

200OK

OK - valid response payload

400Bad Request

Error - requested block number is invalid (not a number, larger than max int)

404Not Found

Error - requested data not present on node

500Internal Server Error

Error - exceptional condition while processing get_block; e.g. corrupt files

Authorization

api-keyAuthapiKey in header