Skip to content

API Reference: v2

Tip

For more details and live testing, check out our WAX swagger

/v2/history/get_abi_snapshot

GET

Summary

Fetch contract ABI

Description

Fetch contract ABI at a specific block if specified.

Parameters
Name Located in Description Required Schema
contract query Contract account Yes string
block query Target block No integer
fetch query Fetch the ABI No boolean
Responses
Code Description
200 Default Response
Examples
/v2/history/get_abi_snapshot?contract=eosio.token&fetch=true


/v2/history/get_actions

GET

Summary

Get actions

Description

Get past actions based on notified account.

Parameters
Name Located in Description Required Schema
account query Notified account No string
filter query Filter by code:name No string
track query Total results to track (count) No string
skip query Skip [n] actions (pagination) No integer
limit query Limit of [n] actions per page No integer
sort query Sort direction ('desc', 'asc', '1' or '-1') No string
after query Filter actions after specified date (ISO8601) No string
before query Filter actions before specified date (ISO8601) No string
simple query Simplified output mode No boolean
noBinary query exclude large binary data No boolean
checkLib query perform reversibility check No boolean

Note

Besides the parameters listed above, this endpoint also accepts generic parameters based on indexed fields (e.g. act.authorization.actor=eosio or act.name=delegatebw).

If included they will be combined with an AND operator.

Tip

You can check action mappings on index-templates.ts file for the list of all possible parameters.

Responses
Code Description
200 Default Response
Examples
/v2/history/get_actions?account=eosio&act.name=delegatebw

noBinary - Will suppress large hex payloads to reduce the transmission latency

/v2/history/get_actions?noBinary=true

checkLib - Performs lib test. The default is false, meaning the query will be faster since it won't wait for the get_info to happen. If you wish to see the lib value on the results you must request explicitly.

/v2/history/get_actions?checkLib=true

The simple mode will add the irreversible field (true/false) on each action

/v2/history/get_actions?checkLib=true&simple=true


/v2/history/get_created_accounts

GET

Summary

Get created accounts

Description

Get all accounts created by one creator.

Parameters
Name Located in Description Required Schema
account query Account creator Yes string
Responses
Code Description
200 Default Response
Examples
/v2/history/get_created_accounts?account=eosio


/v2/history/get_creator

GET

Summary

Get account creator

Description

Get the creator of a specific account.

Parameters
Name Located in Description Required Schema
account query Created account Yes string
Responses
Code Description
200 Default Response
Examples
/v2/history/get_creator?account=eosriobrazil


/v2/history/get_deltas

GET

Summary

Get state deltas

Description

Get state deltas of any table.

Parameters
Name Located in Description Required Schema
code query Contract account No string
scope query Table scope No string
table query Table name No string
payer query Payer account No string

Note

Besides the parameters listed above, this endpoint also accepts generic parameters based on indexed fields (e.g. block_num=10000000).

If included they will be combined with an AND operator.

Tip

You can check delta mappings on index-templates.ts file for the list of all possible parameters.

Responses
Code Description
200 Default Response
Examples

Get all deltas from eosio.token contract on a specific block

/v2/history/get_deltas?code=eosio.token&block_num=100000

Get all deltas from the table accounts of the eosio.token contract

/v2/history/get_deltas?code=eosio.token&table=accounts


/v2/history/get_transacted_accounts

GET

Summary

Get account interactions based on transfers

Description

Get all accounts that interacted with the source account provided. Interactions can be from or to (direction) source account.

Parameters
Name Located in Description Required Schema
account query Source account Yes string
direction query Interaction direction ('in', 'out' or 'both') Yes string
symbol query Token symbol No string
contract query Token contract No string
min query Transfer minimum value No number
max query Transfer maximum value No number
limit query Limit of [n] interactions No number
after query Filter actions after specified date (ISO8601) or block number No string
before query Filter actions before specified date (ISO8601) or block number No string
Responses
Code Description
200 Default Response
Examples
/v2/history/get_transacted_accounts?account=eosriobrazil&direction=out


/v2/history/get_transaction

GET

Summary

Get transaction by id

Description

Get a transaction with all its actions.

Parameters
Name Located in Description Required Schema
id query Transaction ID Yes string
Responses
Code Description
200 Default Response
Examples
v2/history/get_transaction?id=eec44c2ab2c2330e88fdacd3cd4c63838adb60da679ff12f299a4341fd036658


/v2/history/get_transfers

GET

Summary

Get token transfers

Description

Get token transfers from contracts using the eosio.token standard.

Parameters
Name Located in Description Required Schema
from query Source account No string
to query Destination account No string
symbol query Token symbol No string
contract query Token contract No string
skip query Skip [n] actions (pagination) No integer
limit query Limit of [n] actions per page No integer
after query Filter actions after specified date (ISO8601) No string
before query Filter actions before specified date (ISO8601) No string
Responses
Code Description
200 Default Response
Examples

Get all transfers from eosriobrazil account

/v2/history/get_transfers?from=eosriobrazil

Get all transfers from eosriobrazil account to eosio.ramfee account

/v2/history/get_transfers?from=eosriobrazil&to=eosio.ramfee"

Get all transfers from eosriobrazil account to eosio.ramfee account after November 2019

/v2/history/get_transfers?from=eosriobrazil&to=eosio.ramfee&after=2019-11-01T00:00:00.000Z


/v2/state/get_account

GET

Summary

Get account summary

Description

Get all data related to an account.

Parameters
Name Located in Description Required Schema
account query Account name No string
Responses
Code Description
200 Default Response
Examples
/v2/state/get_account?account=eosio


/v2/state/get_key_accounts

GET

Summary

Get accounts by public key

Description

Get all accounts with specified public key.

Parameters
Name Located in Description Required Schema
public_key query Public key Yes string
Responses
Code Description
200 Default Response
Examples
/v2/state/get_key_accounts?public_key=EOS8fDDZm7ommT5XBf9MPYkRioXX6GeCUeSNkTpimdwKon5bNAVm7"


/v2/state/get_key_accounts

POST

Summary

Get accounts by public key

Description

Get all accounts with specified public key.

Parameters
Name Located in Description Required Schema
public_key body Public key Yes string
Responses
Code Description
200 Default Response
Examples
/v2/state/get_key_accounts - body: {"public_key":"EOS8fDDZm7ommT5XBf9MPYkRioXX6GeCUeSNkTpimdwKon5bNAVm7"}


GET

Summary

Get permission links

Description

Get permission links from an account.

Parameters
Name Located in Description Required Schema
account name (query) Account name Yes string
code (query) Contract name No string
action (query) Method name No string
permission (query) Permission name No string
Responses
Code Description
200 Default Response
Examples
/v2/state/get_links?account=eosriobrazil


/v2/state/get_proposals

GET

Summary

Get proposals

Description

Get all available proposals.

Parameters
Name Located in Description Required Schema
proposer query Filter by proposer No string
proposal query Filter by proposal name No string
account query Filter by either requested or provided account No string
requested query Filter by requested account No string
provided query Filter by provided account No string
executed query Filter by execution status No boolean
track query Total results to track (count) No string
skip query Skip [n] actions (pagination) No integer
limit query Limit of [n] actions per page No integer
Responses
Code Description
200 Default Response
Examples
/v2/state/get_proposals?proposer=eosriobrazil


/v2/state/get_tokens

GET

Summary

Get tokens from account

Description

Retrieve all tokens holded by an account.

Parameters
Name Located in Description Required Schema
account query Account name Yes string
Responses
Code Description
200 Default Response
Examples
/v2/state/get_tokens?account=eosriobrazil


/v2/state/get_voters

GET

Summary

Get voters

Description

Get all voting accounts.

Parameters
Name Located in Description Required Schema
producer query Filter by voted producer (comma separated) No string
skip query Skip [n] actions (pagination) No integer
limit query Limit of [n] actions per page No integer
Responses
Code Description
200 Default Response
Examples

Get all eosriobrazil voters

/v2/state/get_voters?producer=eosriobrazil

Get only the first 3 responses

/v2/state/get_voters?producer=eosriobrazil&limit=3


/v2/health

GET

Summary:

API Service Health Report

Responses
Code Description
200 Default Response