Chain API
v1.0.0https://eos.nownodes.io/v1/chainhttps://eos.nownodes.io/v1OAS 3.0 Nodeos Chain API Specification
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
Chain
Chain
Returns an object containing various details about a specific account on the blockchain.
Body
JSON Object with single member "account_name"
account_namestring | string | string | stringrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing various details about a specific block on the blockchain.
Body
block_num_or_idstringrequiredProvide a block number or a block id
Response
OK
Authorization
api-keyAuthapiKey in headerSimilar to get_block but returns a fixed-size smaller subset of the block data.
Body
block_numintegerrequiredProvide a block number
Response
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing various details about the blockchain.
Response
OK
This method expects a transaction in JSON format and will attempt to apply it to the blockchain.
Body
signaturesArray<items>array of signatures required to authorize transaction
compressionbooleanCompression used, usually false
packed_context_free_datastringjson to hex
packed_trxstringTransaction object json to hex
Response
OK
Authorization
api-keyAuthapiKey in headerThis method expects a transaction in JSON format and will attempt to apply it to the blockchain.
Body
signaturesArray<items>array of signatures required to authorize transaction
compressionbooleanCompression used, usually false
packed_context_free_datastringjson to hex
packed_trxstringTransaction object json to hex
Response
OK
Authorization
api-keyAuthapiKey in headerThis method expects a transaction in JSON format and will attempt to apply it to the blockchain.
Body
Response
OK
Authorization
api-keyAuthapiKey in headerRetrieves the glock header state
Body
block_num_or_idstringrequiredProvide a block_number or a block_id
Response
OK
Authorization
api-keyAuthapiKey in headerRetrieves the ABI for a contract based on its account name
Body
account_namestring | string | string | stringrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerRetrieves the current balance
Body
codestring | string | string | stringrequiredaccountstring | string | string | stringrequiredsymbolitemsrequiredA 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
OK
Authorization
api-keyAuthapiKey in headerRetrieves currency stats
Body
codestring | string | string | stringsymbolitemsA 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
OK
Authorization
api-keyAuthapiKey in headerReturns the required keys needed to sign a transaction.
Body
transactionitemsrequiredavailable_keysArray<items>requiredProvide the available keys
Response
OK
Authorization
api-keyAuthapiKey in headerRetrieves producers list
Body
limitstringrequiredtotal number of producers to retrieve
lower_boundstringrequiredIn conjunction with limit can be used to paginate through the results. For example, limit=10 and lower_bound=10 would be page 2
jsonbooleanreturn result in JSON format
Response
OK
Authorization
api-keyAuthapiKey in headerRetrieves raw code and ABI for a contract based on account name
Body
account_namestring | string | string | stringrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerRetrieves the scheduled transaction
Body
lower_boundlower_boundDate/time string in the format YYYY-MM-DDTHH:MM:SS.sss
limitintegerThe maximum number of transactions to return
jsonbooleantrue/false whether the packed transaction is converted to json
Response
OK
Authorization
api-keyAuthapiKey in headerRetrieves table scope
Body
codestringrequiredname of the contract to return table data for
tablestringFilter results by table
lower_boundstringFilters results to return the first element that is not less than provided value in set
upper_boundstringFilters results to return the first element that is greater than provided value in set
limitinteger<int32>10Limit number of results returned.
reversebooleanfalseReverse the order of returned results
show_payerbooleanfalseShow RAM payer
Response
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing rows from the specified table.
Body
codestringrequiredThe name of the smart contract that controls the provided table
tablestringrequiredThe name of the table to query
scopestringrequiredThe account to which this data belongs
index_positionstringPosition of the index used, accepted parameters primary, secondary, tertiary, fourth, fifth, sixth, seventh, eighth, ninth , tenth
key_typestringType of key specified by index_position (for example - uint64_t or name)
encode_typestringlower_boundstringFilters results to return the first element that is not less than provided value in set
upper_boundstringFilters results to return the first element that is greater than provided value in set
limitinteger<int32>10Limit number of results returned.
reversebooleanfalseReverse the order of returned results
show_payerbooleanfalseShow RAM payer
Response
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing rows from the specified kv table.
Body
codestringrequiredThe name of the smart contract that controls the provided kv table
tablestringrequiredThe name of the kv table to query
index_namestringrequiredThe name of primary or secondary index
encode_typestringEncoding 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_valuestringIndex value used for point query encoded as 'encode_type'. Cannot be used with either lower_bound or upper_bound.
lower_boundstringLower 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_boundstringUpper 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
reversebooleanReverse the order of returned results
show_payerbooleanProvide the ram payer for each row
Response
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing the serialized action data.
Body
codestring | string | string | stringactionstring | string | string | stringargsobjectjson object of the action parameters that will be serialized.
Response
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing the deserialized action data.
Body
codestring | string | string | stringrequiredactionstring | string | string | stringrequiredbinargsbinargsrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing the smart contract WASM code.
Body
account_namestring | string | string | stringrequiredcode_as_wasminteger1requiredThis must be 1 (true)
Response
OK
Authorization
api-keyAuthapiKey in headerReturns an object containing the smart contract abi.
Body
account_namestring | string | string | stringrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerRetreives the activated protocol features for producer node
Body
lower_boundintegerLower bound
upper_boundintegerUpper bound
limitintegerThe limit, default is 10
search_by_block_numbooleanFlag to indicate it is has to search by block number
reversebooleanFlag to indicate it has to search in reverse
Response
OK
Authorization
api-keyAuthapiKey in headerDb_Size
Db size
get
Retrieves database stats
Body
Response
OK
Authorization
api-keyAuthapiKey in headerNet
Net
connections
Returns an array of all peer connection statuses.
Body
Response
OK
Authorization
api-keyAuthapiKey in headerconnect
Initiate a connection to a specified peer.
Body
endpointstringrequiredthe endpoint to connect to expressed as either IP address or URL
Response
OK
Authorization
api-keyAuthapiKey in headerdisconnect
Initiate disconnection from a specified peer.
Body
endpointstringrequiredthe endpoint to disconnect from, expressed as either IP address or URL
Response
OK
Authorization
api-keyAuthapiKey in headerstatus
Retrieves the connection status for a specified peer.
Body
endpointstringrequiredthe endpoint to get the status for, to expressed as either IP address or URL
Response
OK
Authorization
api-keyAuthapiKey in headerProducer
Producer
pause
Pause producer node
Body
Response
OK
Authorization
api-keyAuthapiKey in headerresume
Resume producer node
Body
Resumes activity for producer
Response
OK
Authorization
api-keyAuthapiKey in headerpaused
Retreives paused status for producer node
Body
Response
OK
Authorization
api-keyAuthapiKey in headerget_runtime_options
Retreives run time options for producer node
Body
Response
OK
Authorization
api-keyAuthapiKey in headerupdate_runtime_options
Update run time options for producer node
Body
optionsobjectrequiredDefines the run time options to set for the producer
Response
OK
Authorization
api-keyAuthapiKey in headerget_greylist
Retreives the greylist for producer node
Body
Response
OK
Authorization
api-keyAuthapiKey in headeradd_greylist_accounts
Adds accounts to grey list for producer node
Body
paramsobjectrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerremove_greylist_accounts
Removes accounts from greylist for producer node
Body
paramsobjectrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerget_whitelist_blacklist
Retreives the white list and black list for producer node
Body
Response
OK
Authorization
api-keyAuthapiKey in headerset_whitelist_blacklist
Sets the white list and black list for producer node
Body
paramsobjectrequiredDefines the actor whitelist and blacklist, the contract whitelist and blacklist, the action blacklist and key blacklist
Response
OK
Authorization
api-keyAuthapiKey in headercreate_snapshot
Creates a snapshot for producer node
Body
nextobjectrequiredDefines the snapshot to be created
Response
OK
Authorization
api-keyAuthapiKey in headerget_integrity_hash
Retreives the integrity hash for producer node
Body
Response
OK
Authorization
api-keyAuthapiKey in headerschedule_protocol_feature_activations
Schedule protocol feature activation for producer node
Body
scheduleobjectrequiredResponse
OK
Authorization
api-keyAuthapiKey in headerget_supported_protocol_features
Retreives supported protocol features for producer node
Body
paramsobjectrequiredDefines filters based on which to return the supported protocol features
Response
OK
Authorization
api-keyAuthapiKey in headerTrace Api
Trace api
Returns a block trace object containing retired actions and related metadata.
Body
block_numintegerrequiredProvide a block number
Response
OK - valid response payload
Error - requested block number is invalid (not a number, larger than max int)
Error - requested data not present on node
Error - exceptional condition while processing get_block; e.g. corrupt files
Authorization
api-keyAuthapiKey in header