TzKT API
v1.13.3https://xtz-index.nownodes.iohttps://xtz.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
Indexer
Accounts
Get accounts
Returns a list of accounts.
Parameters
idInt32Parameter | nullqueryFilters by internal id.
addressAddressParameter | nullqueryFilters by address.
typeAccountTypeParameter | nullqueryFilters accounts by type (user, delegate, contract, rollup, smart_rollup, ghost).
kindContractKindParameter | nullqueryFilters accounts by contract kind (delegator_contract or smart_contract)
delegateAccountParameter | nullqueryFilters accounts by delegate. Allowed fields for .eqx mode: none.
balanceInt64Parameter | nullqueryFilters accounts by balance
stakedBoolParameter | nullqueryFilters accounts by participation in staking
lastActivityInt32Parameter | nullqueryFilters accounts by last activity level (where the account was updated)
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), balance, rollupBonds, firstActivity, lastActivity, numTransactions, numContracts.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet accounts count
Returns a number of accounts.
Parameters
typeAccountTypeParameter | nullqueryFilters accounts by type (user, delegate, contract, rollup, smart_rollup, ghost).
kindContractKindParameter | nullqueryFilters accounts by contract kind (delegator_contract or smart_contract)
balanceInt64Parameter | nullqueryFilters accounts by balance
stakedBoolParameter | nullqueryFilters accounts by participation in staking
firstActivityInt32Parameter | nullqueryFilters accounts by first activity level (where the account was created)
Response
Authorization
api-keyAuthapiKey in headerGet account by address
Returns an account with the specified address.
Parameters
addressstringrequiredpathAccount address
legacybooleantruequeryIf true (by default), the metadata field will contain tzkt profile info, or TZIP-16 metadata otherwise. This is a part of a deprecation mechanism, allowing smooth migration.
Response
Authorization
api-keyAuthapiKey in headerGet account contracts
Returns a list of contracts created by (or related to) the specified account.
Parameters
addressstringrequiredpathAccount address (starting with tz or KT)
sortSortParameter | nullquerySorts contracts by specified field. Supported fields: id (default, desc), balance, creationLevel.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet account delegators
Returns a list of accounts delegated to the specified account.
Parameters
addressstringrequiredpathAccount address (starting with tz)
typeAccountTypeParameter | nullqueryFilters delegators by type (user, delegate, contract, rollup, smart_rollup, ghost).
balanceInt64Parameter | nullqueryFilters delegators by balance.
delegationLevelInt32Parameter | nullqueryNumber of items to skip
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: delegationLevel (default, desc), balance.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet account operations
Returns a list of operations related to the specified account.
Note: for better flexibility this endpoint accumulates query parameters (filters) of each /operations/{type} endpoint,
so a particular filter may affect several operation types containing this filter.
For example, if you specify an initiator it will affect all transactions, delegations and originations,
because all these types have an initiator field.
NOTE: if you know in advance what operation type you want to get (e.g. transactions), prefer using /v1/operations/{type}
(e.g. /v1/operations/transactions) instead, because it's much more efficient and way more flexible.
Parameters
addressstringrequiredpathAccount address
typestring | nullqueryComma separated list of operation types to return (endorsement, preendorsement, ballot, proposal, activation, double_baking,
double_endorsing, double_preendorsing, nonce_revelation, vdf_revelation, delegation, origination, transaction, reveal, register_constant,
set_deposits_limit, increase_paid_storage, tx_rollup_origination, tx_rollup_submit_batch, tx_rollup_commit, tx_rollup_return_bond,
tx_rollup_finalize_commitment, tx_rollup_remove_commitment, tx_rollup_rejection, tx_rollup_dispatch_tickets, transfer_ticket, migration,
update_consensus_key, drain_delegate, sr_add_messages, sr_cement, sr_execute, sr_originate, sr_publish, sr_recover_bond, sr_refute,
revelation_penalty, baking, endorsing_reward). If not specified then the default set will be returned.
initiatorAccountParameter | nullqueryFilters transactions, delegations and originations by initiator. Allowed fields for .eqx mode: none.
senderAccountParameter | nullqueryFilters transactions, delegations, originations, reveals and seed nonce revelations by sender. Allowed fields for .eqx mode: none.
targetAccountParameter | nullqueryFilters transactions by target. Allowed fields for .eqx mode: none.
prevDelegateAccountParameter | nullqueryFilters delegations by prev delegate. Allowed fields for .eqx mode: none.
newDelegateAccountParameter | nullqueryFilters delegations by new delegate. Allowed fields for .eqx mode: none.
contractManagerAccountParameter | nullqueryFilters origination operations by manager. Allowed fields for .eqx mode: none.
contractDelegateAccountParameter | nullqueryFilters origination operations by delegate. Allowed fields for .eqx mode: none.
originatedContractAccountParameter | nullqueryFilters origination operations by originated contract. Allowed fields for .eqx mode: none.
accuserAccountParameter | nullqueryFilters double baking and double endorsing by accuser. Allowed fields for .eqx mode: none.
offenderAccountParameter | nullqueryFilters double baking and double endorsing by offender. Allowed fields for .eqx mode: none.
bakerAccountParameter | nullqueryFilters seed nonce revelation operations by baker. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters operations by level.
timestampDateTimeParameter | nullqueryFilters operations by timestamp.
entrypointStringParameter | nullqueryFilters transactions by entrypoint called on the target contract.
parameterJsonParameter | nullqueryFilters transactions by parameter value. Note, this query parameter supports the following format: ?parameter{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?parameter.token_id=... or ?parameter.sigs.0.ne=....
hasInternalsBoolParameter | nullqueryFilters transactions by presence of internal operations.
statusOperationStatusParameter | nullqueryFilters transactions, delegations, originations and reveals by operation status (applied, failed, backtracked, skipped).
sortSortModeDescendingquerySort mode (0 - ascending, 1 - descending), operations of different types can only be sorted by ID.
lastIdinteger<int64> | nullqueryId of the last operation received, which is used as an offset for pagination
limitinteger<int32>[0, 1000]100queryNumber of items to return
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet counter
Returns account counter
Parameters
addressstringrequiredpathAccount address (starting with tz or KT)
Response
Authorization
api-keyAuthapiKey in headerGet balance
Returns account balance
Parameters
addressstringrequiredpathAccount address (starting with tz or KT)
Response
Authorization
api-keyAuthapiKey in headerGet balance at level
Returns account balance at the specified block
Parameters
addressstringrequiredpathAccount address (starting with tz or KT)
levelinteger<int32>requiredpathBlock height at which you want to know account balance
Response
Authorization
api-keyAuthapiKey in headerGet balance at date
Returns account balance at the specified datetime
Parameters
addressstringrequiredpathAccount address (starting with tz or KT)
datetimestring<date-time>requiredpathDatetime at which you want to know account balance (e.g. 2020-01-01, or 2019-12-30T23:42:59Z)
Response
Authorization
api-keyAuthapiKey in headerGet balance history
Returns time series with historical balances (only changes, without duplicates).
Parameters
addressstringrequiredpathAccount address (starting with tz or KT)
stepinteger<int32> | nullqueryStep of the time series, for example if step = 1000 you will get balances at blocks 1000, 2000, 3000, ....
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts historical balances by specified field. Supported fields: level.
offsetinteger<int32>0querySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet account report
Exports account balance report in .csv format
Parameters
addressstringrequiredpathAccount address (starting with tz or KT)
fromstring<date-time> | nullqueryStart of the datetime range to filter by (ISO 8601, e.g. 2019-11-31)
tostring<date-time> | nullqueryEnd of the datetime range to filter by (ISO 8601, e.g. 2019-12-31)
currencystring | nullqueryCurrency to convert amounts to (btc, eur, usd, cny, jpy, krw, eth, gbp)
historicalbooleanfalsequerytrue if you want to use historical prices, false to use current price
delimiterstring | nullcommaqueryColumn delimiter (comma, semicolon)
separatorstring | nullpointqueryDecimal separator (comma, point)
Response
Authorization
api-keyAuthapiKey in headerBigMaps
Get bigmaps count
Returns the total number of bigmaps.
Response
Authorization
api-keyAuthapiKey in headerGet bigmaps
Returns a list of bigmaps.
Parameters
contractAccountParameter | nullqueryFilters bigmaps by smart contract address.
pathStringParameter | nullqueryFilters bigmaps by path in the contract storage.
tagsBigMapTagsParameter | nullqueryFilters bigmaps by tags: metadata, token_metadata, ledger.
activeboolean | nullqueryFilters bigmaps by status: true - active, false - removed.
lastLevelInt32Parameter | nullqueryFilters bigmaps by the last update level.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts bigmaps by specified field. Supported fields: id (default), ptr, firstLevel, lastLevel, totalKeys, activeKeys, updates.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the bigmap key and value type: 0 - JSON, 2 - Micheline
Response
Authorization
api-keyAuthapiKey in headerGet bigmap keys
Returns a list of all bigmap keys.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
bigmapInt32Parameter | nullqueryFilter by bigmap ptr.
Click on the parameter to expand more details.
activeboolean | nullqueryFilters by status: true - active, false - removed.
hashExpressionParameter | nullqueryFilter by key hash.
Click on the parameter to expand more details.
keyJsonParameter | nullqueryFilter by key.
Note, this parameter supports the following format: key{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?key.foo.in=bar,baz).
Click on the parameter to expand more details.
valueJsonParameter | nullqueryFilter by value.
Note, this parameter supports the following format: value{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?value.foo.in=bar,baz).
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the key was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the key was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the key was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the key was last seen.
Click on the parameter to expand more details.
updatesInt32Parameter | nullqueryFilter by number of actions with the bigmap key.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
michelineMichelineFormatJsonqueryFormat of the key and value fields: 0 - JSON, 2 - Micheline
Response
Authorization
api-keyAuthapiKey in headerGet bigmap updates count
Returns a total number of bigmap updates.
Parameters
bigmapInt32Parameter | nullqueryFilters by bigmap ptr
pathStringParameter | nullqueryFilters by bigmap path
contractAccountParameter | nullqueryFilters by bigmap contract
tagsBigMapTagsParameter | nullqueryFilters by bigmap tags: metadata, token_metadata, ledger
actionBigMapActionParameter | nullqueryFilters by action
valueJsonParameter | nullqueryFilters by JSON value. Note, this query parameter supports the following format: ?value{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?value.balance.gt=....
levelInt32Parameter | nullqueryFilters by level
timestampTimestampParameter | nullqueryFilters by timestamp
Response
Authorization
api-keyAuthapiKey in headerGet bigmap updates
Returns a list of all bigmap updates.
Parameters
bigmapInt32Parameter | nullqueryFilters by bigmap ptr
pathStringParameter | nullqueryFilters by bigmap path
contractAccountParameter | nullqueryFilters by bigmap contract
tagsBigMapTagsParameter | nullqueryFilters by bigmap tags: metadata, token_metadata, ledger
actionBigMapActionParameter | nullqueryFilters by action
valueJsonParameter | nullqueryFilters by JSON value. Note, this query parameter supports the following format: ?value{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?value.balance.gt=....
levelInt32Parameter | nullqueryFilters by level
timestampTimestampParameter | nullqueryFilters by timestamp
sortSortParameter | nullquerySorts bigmaps by specified field. Supported fields: id (default), ptr, firstLevel, lastLevel, totalKeys, activeKeys, updates.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the bigmap key and value type: 0 - JSON, 2 - Micheline
Response
Authorization
api-keyAuthapiKey in headerGet bigmap by Id
Returns a bigmap with the specified Id.
Parameters
idinteger<int32>requiredpathBigmap Id
michelineMichelineFormatJsonqueryFormat of the bigmap key and value type: 0 - JSON, 2 - Micheline
Response
Authorization
api-keyAuthapiKey in headerGet bigmap type
Returns a type of the bigmap with the specified Id in Micheline format (with annotations).
Parameters
idinteger<int32>requiredpathBigmap Id
Response
Authorization
api-keyAuthapiKey in headerGet bigmap keys
Returns a list of bigmap keys.
Parameters
idinteger<int32>requiredpathBigmap Id
activeboolean | nullqueryFilters keys by status: true - active, false - removed.
keyJsonParameter | nullqueryFilters keys by JSON key. Note, this query parameter supports the following format: ?key{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?key.token_id=....
valueJsonParameter | nullqueryFilters keys by JSON value. Note, this query parameter supports the following format: ?value{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?value.balance.gt=....
lastLevelInt32Parameter | nullqueryFilters bigmap keys by the last update level.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts bigmap keys by specified field. Supported fields: id (default), firstLevel, lastLevel, updates.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet bigmap key
Returns the specified bigmap key.
Parameters
idinteger<int32>requiredpathBigmap Id
keystringrequiredpathEither a key hash (expr123...) or a plain value (foo...).
Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet bigmap key updates
Returns updates history for the specified bigmap key.
Parameters
idinteger<int32>requiredpathBigmap Id
keystringrequiredpathEither a key hash (expr123...) or a plain value (foo...).
Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.
sortSortParameter | nullquerySorts bigmap updates by specified field. Supported fields: id (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the key value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet historical keys
Returns a list of bigmap keys at the specific block.
Parameters
idinteger<int32>requiredpathBigmap Id
levelinteger<int32>requiredpathLevel of the block at which you want to get bigmap keys
activeboolean | nullqueryFilters keys by status: true - active, false - removed.
keyJsonParameter | nullqueryFilters keys by JSON key. Note, this query parameter supports the following format: ?key{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?key.token_id=....
valueJsonParameter | nullqueryFilters keys by JSON value. Note, this query parameter supports the following format: ?value{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?value.balance.gt=....
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts bigmap keys by specified field. Supported fields: id (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet historical key
Returns the specified bigmap key at the specific block.
Parameters
idinteger<int32>requiredpathBigmap Id
levelinteger<int32>requiredpathLevel of the block at which you want to get bigmap key
keystringrequiredpathEither a key hash (expr123...) or a plain value (foo...).
Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerBlocks
Get blocks count
Returns the total number of blocks.
Response
Authorization
api-keyAuthapiKey in headerGet blocks
Returns a list of blocks.
Parameters
bakerAccountParameter | nullquery[DEPRECATED]
anyofAnyOfParameter | nullqueryFilters by any of the specified fields. Example: anyof.proposer.producer=tz1....
proposerAccountParameter | nullqueryFilters blocks by block proposer. Allowed fields for .eqx mode: none.
producerAccountParameter | nullqueryFilters blocks by block producer. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters blocks by level.
timestampDateTimeParameter | nullqueryFilters blocks by timestamp.
priorityInt32Parameter | nullquery[DEPRECATED]
blockRoundInt32Parameter | nullqueryFilters blocks by block round.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts blocks by specified field. Supported fields: id (default), level, payloadRound, blockRound, validations, reward, bonus, fees.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet block by hash
Returns a block with the specified hash.
Parameters
hashstringrequiredpathBlock hash
operationsbooleanfalsequeryFlag indicating whether to include block operations into returned object or not
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet block by level
Returns a block at the specified level.
Parameters
levelinteger<int32>requiredpathBlock level
operationsbooleanfalsequeryFlag indicating whether to include block operations into returned object or not
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet timestamp by level
Returns a timestamp of the block at the specified level.
Parameters
levelinteger<int32>requiredpathBlock level
Response
Authorization
api-keyAuthapiKey in headerGet block by timestamp
Returns a block closest to the specified timestamp.
Parameters
timestampstring<date-time>requiredpathTimestamp, e.g. 2020-01-01T00:00:00Z
operationsbooleanfalsequeryFlag indicating whether to include block operations into returned object or not
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet level by timestamp
Returns a level of the block closest to the specified timestamp.
Parameters
timestampstring<date-time>requiredpathTimestamp, e.g. 2020-01-01T00:00:00Z
Response
Authorization
api-keyAuthapiKey in headerCommitments
Get commitment by blinded address
Returns a commitment with the specified blinded address.
Parameters
addressstringrequiredpathBlinded address (starting with btz)
Response
Authorization
api-keyAuthapiKey in headerGet commitments
Returns a list of commitments.
Parameters
activatedboolean | nullqueryFilters commitments by activation status
activationLevelInt32NullParameter | nullqueryFilters commitments by activation level
balanceInt64Parameter | nullqueryFilters commitments by activated balance
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), balance, activationLevel.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet commitments count
Returns a number of commitments.
Parameters
activatedboolean | nullqueryFilters commitments by activation status
balanceInt64Parameter | nullqueryFilters commitments by activated balance
Response
Authorization
api-keyAuthapiKey in headerConstants
Get global constants
Returns a list of global constants.
Parameters
addressExpressionParameter | nullqueryFilters constants by global address (starts with expr..).
creationLevelInt32Parameter | nullqueryFilters constants by creation level.
creationTimeTimestampParameter | nullqueryFilters constants by creation time.
creatorAccountParameter | nullqueryFilters constants by creator.
refsInt32Parameter | nullqueryFilters constants by number of refs.
sizeInt32Parameter | nullqueryFilters constants by size in bytes.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), creationLevel, size, refs.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
formatinteger<int32>[0, 2]0queryConstant value format (0 - micheline, 1 - michelson, 2 - bytes (base64))
Response
Authorization
api-keyAuthapiKey in headerGet global constant by address
Returns global constant with specified address (expression hash).
Parameters
addressstringrequiredpathGlobal address (starts with expr..)
formatinteger<int32>[0, 2]0queryConstant value format (0 - micheline, 1 - michelson, 2 - bytes (base64))
Response
Authorization
api-keyAuthapiKey in headerGet global constants count
Returns a number of global constants.
Parameters
refsInt32Parameter | nullqueryFilters constants by number of refs.
Response
Authorization
api-keyAuthapiKey in headerContracts
Get contracts
Returns a list of contract accounts.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
addressAddressParameter | nullqueryFilter by address.
Click on the parameter to expand more details.
kindContractKindParameter | nullqueryFilter by kind (delegator_contract, smart_contract, or asset).
Click on the parameter to expand more details.
tzipsContractTagsParameter | nullqueryFilter by tzips (fa1, fa12, or fa2).
Click on the parameter to expand more details.
balanceInt64Parameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
creatorAccountParameter | nullqueryFilter by creator.
Click on the parameter to expand more details.
managerAccountParameter | nullqueryFilter by manager.
Click on the parameter to expand more details.
delegateAccountParameter | nullqueryFilter by delegate.
Click on the parameter to expand more details.
firstActivityInt32Parameter | nullqueryFilter by level of the block where the contract was first seen.
Click on the parameter to expand more details.
firstActivityTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the contract was first seen.
Click on the parameter to expand more details.
lastActivityInt32Parameter | nullqueryFilter by level of the block where the contract was last seen.
Click on the parameter to expand more details.
lastActivityTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the contract was last seen.
Click on the parameter to expand more details.
typeHashInt32Parameter | nullqueryFilter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts).
Click on the parameter to expand more details.
codeHashInt32Parameter | nullqueryFilter by 32-bit hash of contract code (helpful for searching same contracts).
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
includeStoragebooleanfalsequerySpecifies whether to include contract storage into response.
Response
Authorization
api-keyAuthapiKey in headerGet contracts count
Returns a number of contract accounts.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
addressAddressParameter | nullqueryFilter by address.
Click on the parameter to expand more details.
kindContractKindParameter | nullqueryFilter by kind (delegator_contract, smart_contract, or asset).
Click on the parameter to expand more details.
tzipsContractTagsParameter | nullqueryFilter by tzips (fa1, fa12, or fa2).
Click on the parameter to expand more details.
balanceInt64Parameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
creatorAccountParameter | nullqueryFilter by creator.
Click on the parameter to expand more details.
managerAccountParameter | nullqueryFilter by manager.
Click on the parameter to expand more details.
delegateAccountParameter | nullqueryFilter by delegate.
Click on the parameter to expand more details.
firstActivityInt32Parameter | nullqueryFilter by level of the block where the contract was first seen.
Click on the parameter to expand more details.
firstActivityTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the contract was first seen.
Click on the parameter to expand more details.
lastActivityInt32Parameter | nullqueryFilter by level of the block where the contract was last seen.
Click on the parameter to expand more details.
lastActivityTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the contract was last seen.
Click on the parameter to expand more details.
typeHashInt32Parameter | nullqueryFilter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts).
Click on the parameter to expand more details.
codeHashInt32Parameter | nullqueryFilter by 32-bit hash of contract code (helpful for searching same contracts).
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet contract by address
Returns a contract account with the specified address.
Parameters
addressstringrequiredpathContract address (starting with KT)
legacybooleantruequeryIf true (by default), the metadata field will contain tzkt profile info, or TZIP-16 metadata otherwise. This is a part of a deprecation mechanism, allowing to switch to new functionality smoothly.
Response
Authorization
api-keyAuthapiKey in headerGet same contracts
Returns contracts which have the same script as the specified one. Note, contract scripts are compared by 32-bit hash, so in very rare cases there may be collisions.
Parameters
addressstringrequiredpathContract address (starting with KT)
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
includeStoragebooleanfalsequerySpecifies whether to include contract storage value in response.
Response
Authorization
api-keyAuthapiKey in headerGet similar contracts
Returns contracts which have the same interface (parameter and storage types) as the specified one. Note, contract parameter and storage types are compared by 32-bit hash, so in very rare cases there may be collisions.
Parameters
addressstringrequiredpathContract address (starting with KT)
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
includeStoragebooleanfalsequerySpecifies whether to include contract storage value in response.
Response
Authorization
api-keyAuthapiKey in headerGet contract code
Returns a code of the specified contract.
Parameters
addressstringrequiredpathContract address (starting with KT)
levelinteger<int32>0queryLevel at which contract code should be taken. If 0 or not specified, the current value will be returned.
formatinteger<int32>[0, 2]0queryCode format (0 - micheline, 1 - michelson, 2 - bytes (base64))
Response
Authorization
api-keyAuthapiKey in headerGet JSON Schema [2020-12] interface for the contract
Returns standard JSON Schema for contract storage, entrypoints, and Big_map entries.
Parameters
addressstringrequiredpathContract address
Response
Authorization
api-keyAuthapiKey in headerGet contract entrypoints
Returns entrypoints of the specified contract.
Parameters
addressstringrequiredpathContract address (starting with KT)
allbooleanfalsequeryIf true, returns all entrypoints, including unused ones.
Unused means that the entrypoint can be normalized to a more specific one.
For example here (or %entry1 (unit %entry2) (nat %entry3)) the %entry1 is unused entrypoint
because it can be normalized to %entry2 or %entry3
jsonbooleantruequeryInclude parameters schema in human-readable JSON format
michelinebooleanfalsequeryInclude parameters schema in micheline format
michelsonbooleanfalsequeryInclude parameters schema in michelson format
Response
Authorization
api-keyAuthapiKey in headerGet entrypoint by name
Returns contract's entrypoint with specified name.
Parameters
addressstringrequiredpathContract address (starting with KT)
namestringrequiredpathEntrypoint name
jsonbooleantruequeryInclude parameters schema in human-readable JSON format
michelinebooleanfalsequeryInclude parameters schema in micheline format
michelsonbooleanfalsequeryInclude parameters schema in michelson format
Response
Authorization
api-keyAuthapiKey in headerGet contract views
Returns all views of the specified contract.
Parameters
addressstringrequiredpathContract address (starting with KT)
jsonbooleantruequeryInclude parameter and return types in human-readable JSON format
michelinebooleanfalsequeryInclude parameter and return types in micheline format
michelsonbooleanfalsequeryInclude parameter and return types in michelson format
Response
Authorization
api-keyAuthapiKey in headerGet view by name
Returns contract view with specified name.
Parameters
addressstringrequiredpathContract address (starting with KT)
namestringrequiredpathView name
jsonbooleantruequeryInclude parameter and return types in human-readable JSON format
michelinebooleanfalsequeryInclude parameter and return types in micheline format
michelsonbooleanfalsequeryInclude parameter and return types in michelson format
Response
Authorization
api-keyAuthapiKey in headerBuild entrypoint parameters
Returns micheline parameters converted from its JSON representation.
Parameters
addressstringrequiredpathContract address
namestringrequiredpathEntrypoint name
valuestring | nullqueryJson parameters
Response
Authorization
api-keyAuthapiKey in headerBuild entrypoint parameters
Returns micheline parameters converted from its JSON representation.
Body
Json parameters
Parameters
addressstringrequiredpathContract address
namestringrequiredpathEntrypoint name
Response
Authorization
api-keyAuthapiKey in headerGet contract storage
Returns contract storage value in JSON format.
Parameters
addressstringrequiredpathContract address
levelinteger<int32>0queryLevel at which storage value should be taken. If 0 or not specified, the current value will be returned.
pathstring | nullqueryPath in the JSON value (point-separated list of field names, e.g. path=settings.refund_time to return
Response
Authorization
api-keyAuthapiKey in headerGet contract storage schema
Returns JSON schema of the contract storage.
Parameters
addressstringrequiredpathContract address
levelinteger<int32>0queryLevel at which storage schema should be taken. If 0 or not specified, the current schema will be returned.
Response
Authorization
api-keyAuthapiKey in headerGet contract storage history
Returns contract storage historical values.
Parameters
addressstringrequiredpathContract address
lastIdinteger<int32>0queryId of the last item received (for pagination)
limitinteger<int32>[0, 1000]10queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet raw contract storage
Returns raw contract storage value in micheline format.
Parameters
addressstringrequiredpathContract address
levelinteger<int32>0queryLevel at which storage value should be taken. If 0 or not specified, the current value will be returned.
Response
Authorization
api-keyAuthapiKey in headerGet raw contract storage schema
Returns micheline schema (type) of the contract storage.
Parameters
addressstringrequiredpathContract address
levelinteger<int32>0queryLevel at which storage schema should be taken. If 0 or not specified, the current schema will be returned.
Response
Authorization
api-keyAuthapiKey in headerGet raw contract storage history
Returns raw contract storage historical values.
Parameters
addressstringrequiredpathContract address
lastIdinteger<int32>0queryId of the last item received (for pagination)
limitinteger<int32>[0, 1000]10queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet contract bigmaps
Returns all active bigmaps allocated in the contract storage.
Parameters
addressstringrequiredpathContract address
tagsBigMapTagsParameter | nullqueryFilters bigmaps tags (metadata, token_metadata, ledger).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object.
If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts bigmaps by specified field. Supported fields: id (default), firstLevel, lastLevel, totalKeys, activeKeys, updates.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet bigmap by name
Returns contract bigmap with the specified name or storage path.
Parameters
addressstringrequiredpathContract address
namestringrequiredpathBigmap name is the last piece of the bigmap storage path.
For example, if the storage path is ledger or assets.ledger, then the name is ledger.
If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet bigmap keys
Returns keys of a contract bigmap with the specified name.
Parameters
addressstringrequiredpathContract address
namestringrequiredpathBigmap name is the last piece of the bigmap storage path.
For example, if the storage path is ledger or assets.ledger, then the name is ledger.
If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.
activeboolean | nullqueryFilters keys by status: true - active, false - removed.
keyJsonParameter | nullqueryFilters keys by JSON key. Note, this query parameter supports the following format: ?key{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?key.token_id=....
valueJsonParameter | nullqueryFilters keys by JSON value. Note, this query parameter supports the following format: ?value{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?value.balance.gt=....
lastLevelInt32Parameter | nullqueryFilters bigmap keys by the last update level.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts bigmap keys by specified field. Supported fields: id (default), firstLevel, lastLevel, updates.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet bigmap key
Returns the specified bigmap key.
Parameters
addressstringrequiredpathContract address
namestringrequiredpathBigmap name is the last piece of the bigmap storage path.
For example, if the storage path is ledger or assets.ledger, then the name is ledger.
If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.
keystringrequiredpathEither a key hash (expr123...) or a plain value (foo...).
Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet bigmap key updates
Returns updates history for the specified bigmap key.
Parameters
addressstringrequiredpathContract address
namestringrequiredpathBigmap name is the last piece of the bigmap storage path.
For example, if the storage path is ledger or assets.ledger, then the name is ledger.
If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.
keystringrequiredpathEither a key hash (expr123...) or a plain value (foo...).
Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.
sortSortParameter | nullquerySorts bigmap updates by specified field. Supported fields: id (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the key value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet historical keys
Returns a list of bigmap keys at the specific block.
Parameters
addressstringrequiredpathContract address
namestringrequiredpathBigmap name is the last piece of the bigmap storage path.
For example, if the storage path is ledger or assets.ledger, then the name is ledger.
If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.
levelinteger<int32>requiredpathLevel of the block at which you want to get bigmap keys
activeboolean | nullqueryFilters keys by status: true - active, false - removed.
keyJsonParameter | nullqueryFilters keys by JSON key. Note, this query parameter supports the following format: ?key{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?key.token_id=....
valueJsonParameter | nullqueryFilters keys by JSON value. Note, this query parameter supports the following format: ?value{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?value.balance.gt=....
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts bigmap keys by specified field. Supported fields: id (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerGet historical key
Returns the specified bigmap key at the specific block.
Parameters
addressstringrequiredpathContract address
namestringrequiredpathBigmap name is the last piece of the bigmap storage path.
For example, if the storage path is ledger or assets.ledger, then the name is ledger.
If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.
levelinteger<int32>requiredpathLevel of the block at which you want to get bigmap key
keystringrequiredpathEither a key hash (expr123...) or a plain value (foo...).
Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.
michelineMichelineFormatJsonqueryFormat of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string
Response
Authorization
api-keyAuthapiKey in headerCycles
Get cycles count
Returns the total number of cycles, including future cycles.
Response
Authorization
api-keyAuthapiKey in headerGet cycles
Returns a list of cycles, including future cycles.
Parameters
snapshotIndexInt32Parameter | nullqueryFilters cycles by snapshot index (0..15)
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts cycles by specified field. Supported fields: index (default, desc).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet cycle by index
Returns a cycle at the specified index.
Parameters
indexinteger<int32>requiredpathCycle index starting from zero
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerDelegates
Get delegates
Returns a list of delegate accounts.
Parameters
activeBoolParameter | nullqueryDelegate status to filter by (true - only active, false - only deactivated, undefined - all delegates)
lastActivityInt32Parameter | nullqueryFilters delegates by last activity level (where the delegate was updated)
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), activationLevel, deactivationLevel, stakingBalance, balance, numDelegators.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet delegates count
Returns a number of delegate accounts.
Parameters
activeBoolParameter | nullqueryDelegate status to filter by (true - only active, false - only deactivated, undefined - all delegates)
Response
Authorization
api-keyAuthapiKey in headerGet delegate by address
Returns a delegate with the specified address.
Parameters
addressstringrequiredpathDelegate address (starting with tz)
Response
Authorization
api-keyAuthapiKey in headerDomains
Get domains count
Returns the total number of domains.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
nameStringParameter | nullqueryFilter by the domain name.
Click on the parameter to expand more details.
ownerAddressNullParameter | nullqueryFilter by the domain owner.
Click on the parameter to expand more details.
addressAddressNullParameter | nullqueryFilter by the address the domain points to.
Click on the parameter to expand more details.
reverseBoolParameter | nullqueryFilter by the 'reverse' flag.
Click on the parameter to expand more details.
expirationDateTimeParameter | nullqueryFilter by the domain expiration.
Click on the parameter to expand more details.
dataJsonParameter | nullqueryFilter by the domain data.
Note, this parameter supports the following format: data{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?data.foo=bar).
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the domain was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the domain was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the domain was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the domain was last seen.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet domains
Returns a list of domains.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
nameStringParameter | nullqueryFilter by the domain name.
Click on the parameter to expand more details.
ownerAddressNullParameter | nullqueryFilter by the domain owner.
Click on the parameter to expand more details.
addressAddressNullParameter | nullqueryFilter by the address the domain points to.
Click on the parameter to expand more details.
reverseBoolParameter | nullqueryFilter by the 'reverse' flag.
Click on the parameter to expand more details.
expirationDateTimeParameter | nullqueryFilter by the domain expiration.
Click on the parameter to expand more details.
dataJsonParameter | nullqueryFilter by the domain data.
Note, this parameter supports the following format: data{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?data.foo=bar).
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the domain was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the domain was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the domain was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the domain was last seen.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet domain by name
Returns the domain with the specified name.
Parameters
namestringrequiredpathDomain name
Response
Authorization
api-keyAuthapiKey in headerEvents
Get contract events count
Returns a total number of contract events.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the event was emitted.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the event was emitted.
Click on the parameter to expand more details.
contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
codeHashInt32Parameter | nullqueryFilter by hash of the code of the contract emitted the event.
Click on the parameter to expand more details.
tagStringParameter | nullqueryFilter by event tag.
Click on the parameter to expand more details.
payloadJsonParameter | nullqueryFilter by payload.
Note, this parameter supports the following format: payload{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?payload.foo.bar.in=1,2,3).
Click on the parameter to expand more details.
transactionIdInt64Parameter | nullqueryFilter by id of the transaction, in which the event was emitted.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet contract events
Returns a list of contract events.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the event was emitted.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the event was emitted.
Click on the parameter to expand more details.
contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
codeHashInt32Parameter | nullqueryFilter by hash of the code of the contract emitted the event.
Click on the parameter to expand more details.
tagStringParameter | nullqueryFilter by event tag.
Click on the parameter to expand more details.
payloadJsonParameter | nullqueryFilter by payload.
Note, this parameter supports the following format: payload{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?payload.foo.bar.in=1,2,3).
Click on the parameter to expand more details.
transactionIdInt64Parameter | nullqueryFilter by id of the transaction, in which the event was emitted.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerHead
Get indexer head
Returns indexer head and synchronization status.
Response
Authorization
api-keyAuthapiKey in headerHelpers
Inject operation
Injects signed operation to the blockchain and returns the operation hash.
Body
Forged operation bytes + signature in hex format.
Parameters
asyncbooleantruequeryIf true, the function returns immediately. Otherwise, the operation will be validated before the result is returned.
Response
Authorization
api-keyAuthapiKey in headerRun script view
Simulate a call to a michelson view
Body
Input to be passed to the contract view (in human-readable format, see "Json schema" on tzkt.io)
Parameters
contractstringrequiredpathContract address
namestringrequiredpathView name
Response
Authorization
api-keyAuthapiKey in headerOperations
Get operations by hash
Returns a list of operations with the specified hash.
NOTE: if you know in advance what operation type you want to get (e.g. transactions), prefer using /v1/operations/{type}/{hash}
(e.g. /v1/operations/transactions/{hash}) instead, because it's much more efficient.
Parameters
hashstringrequiredpathOperation hash
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet operations by hash and counter
Returns a list of operations with the specified hash and counter.
NOTE: if you know in advance what operation type you want to get (e.g. transactions), prefer using /v1/operations/{type}/{hash}/{counter}
(e.g. /v1/operations/transactions/{hash}/{counter}) instead, because it's much more efficient.
Parameters
hashstringrequiredpathOperation hash
counterinteger<int32>requiredpathOperation counter
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet operations by hash, counter and nonce
Returns an internal operations with the specified hash, counter and nonce.
NOTE: if you know in advance what operation type you want to get (e.g. transactions), prefer using /v1/operations/{type}/{hash}/{counter}/{nonce}
(e.g. /v1/operations/transactions/{hash}/{counter}/{nonce}) instead, because it's much more efficient.
Parameters
hashstringrequiredpathOperation hash
counterinteger<int32>requiredpathOperation counter
nonceinteger<int32>requiredpathOperation nonce (internal)
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet operation status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
NOTE: if you know in advance what operation type you want to check (e.g. transactions), prefer using /v1/operations/{type}/{hash}/status
(e.g. /v1/operations/transactions/{hash}/status) instead, because it's much more efficient.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet endorsements
Returns a list of endorsement operations.
Parameters
delegateAccountParameter | nullqueryFilters endorsements by delegate. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters endorsements by level.
timestampDateTimeParameter | nullqueryFilters endorsements by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts endorsements by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet endorsement by hash
Returns an endorsement operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet endorsements count
Returns the total number of endorsement operations.
Parameters
levelInt32Parameter | nullqueryFilters endorsements by level.
timestampDateTimeParameter | nullqueryFilters endorsements by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet preendorsements
Returns a list of preendorsement operations.
Parameters
delegateAccountParameter | nullqueryFilters by delegate. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet preendorsement by hash
Returns an preendorsement operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet preendorsements count
Returns the total number of preendorsement operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet ballots
Returns a list of ballot operations.
Parameters
delegateAccountParameter | nullqueryFilters ballots by delegate. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters ballots by level.
timestampDateTimeParameter | nullqueryFilters ballots by timestamp.
epochInt32Parameter | nullqueryFilters ballots by voting epoch.
periodInt32Parameter | nullqueryFilters ballots by voting period.
proposalProtocolParameter | nullqueryFilters ballots by proposal hash.
voteVoteParameter | nullqueryFilters ballots by vote (yay, nay, pass).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts ballots by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet ballot by hash
Returns a ballot operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet ballots count
Returns the total number of ballot operations.
Parameters
levelInt32Parameter | nullqueryFilters ballot operations by level.
timestampDateTimeParameter | nullqueryFilters ballot operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet proposals
Returns a list of proposal operations.
Parameters
delegateAccountParameter | nullqueryFilters proposal operations by delegate. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters proposal operations by level.
timestampDateTimeParameter | nullqueryFilters proposal operations by timestamp.
epochInt32Parameter | nullqueryFilters proposal operations by voting epoch.
periodInt32Parameter | nullqueryFilters proposal operations by voting period.
proposalProtocolParameter | nullqueryFilters proposal operations by proposal hash.
duplicatedBoolParameter | nullquerySpecify whether to include or exclude duplicates, which didn't actually upvote a proposal.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts proposal operations by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet proposal by hash
Returns a proposal operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet proposals count
Returns the total number of proposal operations.
Parameters
levelInt32Parameter | nullqueryFilters proposal operations by level.
timestampDateTimeParameter | nullqueryFilters proposal operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet activations
Returns a list of activation operations.
Parameters
accountAccountParameter | nullqueryFilters activations by account. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters activations by level.
timestampDateTimeParameter | nullqueryFilters activations by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts activations by specified field. Supported fields: id (default), level, balance.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet activation by hash
Returns an activation operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet activations count
Returns the total number of activation operations.
Parameters
levelInt32Parameter | nullqueryFilters activations by level.
timestampDateTimeParameter | nullqueryFilters activations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet double baking
Returns a list of double baking operations.
Parameters
anyofAnyOfParameter | nullqueryFilters double baking operations by any of the specified fields. Example: anyof.accuser.offender=tz1... will return operations where accuser OR offender is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.
accuserAccountParameter | nullqueryFilters double baking operations by accuser. Allowed fields for .eqx mode: offender.
offenderAccountParameter | nullqueryFilters double baking operations by offender. Allowed fields for .eqx mode: accuser.
levelInt32Parameter | nullqueryFilters double baking operations by level.
timestampDateTimeParameter | nullqueryFilters double baking operations by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts double baking operations by specified field. Supported fields: id (default), level, accusedLevel, accuserRewards, offenderLostDeposits, offenderLostRewards, offenderLostFees.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet double baking by hash
Returns a double baking operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet double baking count
Returns the total number of double baking operations.
Parameters
levelInt32Parameter | nullqueryFilters double baking operations by level.
timestampDateTimeParameter | nullqueryFilters double baking operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet double endorsing
Returns a list of double endorsing operations.
Parameters
anyofAnyOfParameter | nullqueryFilters double endorsing operations by any of the specified fields. Example: anyof.accuser.offender=tz1... will return operations where accuser OR offender is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.
accuserAccountParameter | nullqueryFilters double endorsing operations by accuser. Allowed fields for .eqx mode: offender.
offenderAccountParameter | nullqueryFilters double endorsing operations by offender. Allowed fields for .eqx mode: accuser.
levelInt32Parameter | nullqueryFilters double endorsing operations by level.
timestampDateTimeParameter | nullqueryFilters double endorsing operations by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts double endorsing operations by specified field. Supported fields: id (default), level, accusedLevel, accuserRewards, offenderLostDeposits, offenderLostRewards, offenderLostFees.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet double endorsing by hash
Returns a double endorsing operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet double endorsing count
Returns the total number of double endorsing operations.
Parameters
levelInt32Parameter | nullqueryFilters double endorsing operations by level.
timestampDateTimeParameter | nullqueryFilters double endorsing operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet double preendorsing
Returns a list of double preendorsing operations.
Parameters
anyofAnyOfParameter | nullqueryFilters by any of the specified fields. Example: anyof.accuser.offender=tz1... will return operations where accuser OR offender is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.
accuserAccountParameter | nullqueryFilters by accuser. Allowed fields for .eqx mode: offender.
offenderAccountParameter | nullqueryFilters by offender. Allowed fields for .eqx mode: accuser.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, accusedLevel, accuserRewards, offenderLostDeposits, offenderLostRewards, offenderLostFees.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet double preendorsing by hash
Returns a double preendorsing operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet double preendorsing count
Returns the total number of double preendorsing operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet nonce revelations
Returns a list of seed nonce revelation operations.
Parameters
anyofAnyOfParameter | nullqueryFilters nonce revelation operations by any of the specified fields. Example: anyof.baker.sender=tz1... will return operations where baker OR sender is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.
bakerAccountParameter | nullqueryFilters nonce revelation operations by baker. Allowed fields for .eqx mode: sender.
senderAccountParameter | nullqueryFilters nonce revelation operations by sender. Allowed fields for .eqx mode: baker.
levelInt32Parameter | nullqueryFilters nonce revelation operations by level.
revealedCycleInt32Parameter | nullqueryFilters by cycle for which the nonce was revealed.
timestampDateTimeParameter | nullqueryFilters nonce revelation operations by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts nonce revelation operations by specified field. Supported fields: id (default), level, revealedLevel.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet nonce revelation by hash
Returns a seed nonce revelation operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet nonce revelations count
Returns the total number of seed nonce revelation operations.
Parameters
levelInt32Parameter | nullqueryFilters seed nonce revelation operations by level.
timestampDateTimeParameter | nullqueryFilters seed nonce revelation operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet vdf revelations
Returns a list of vdf revelation operations.
Parameters
bakerAccountParameter | nullqueryFilters by baker. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
cycleInt32Parameter | nullqueryFilters by cycle in which the operation was included.
timestampDateTimeParameter | nullqueryFilters by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet vdf revelation by hash
Returns a vdf revelation operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet vdf revelations count
Returns the total number of vdf revelation operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet drain delegate
Returns a list of drain delegate operations.
Parameters
anyofAnyOfParameter | nullqueryFilters by any of the specified fields. Example: anyof.delegate.target=tz1... will return operations where delegate OR target is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.
delegateAccountParameter | nullqueryFilters by drained baker. Allowed fields for .eqx mode: none.
targetAccountParameter | nullqueryFilters by target. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet drain delegate by hash
Returns a drain delegate operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet drain delegate count
Returns the total number of drain delegate operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet delegations
Returns a list of delegation operations.
Parameters
anyofAnyOfParameter | nullqueryFilters delegations by any of the specified fields. Example: anyof.prevDelegate.newDelegate=tz1... will return operations where prevDelegate OR newDelegate is equal to the specified value. This parameter is useful when you need to retrieve all delegations associated with a specified account.
initiatorAccountParameter | nullqueryFilters delegations by initiator. Allowed fields for .eqx mode: prevDelegate, newDelegate.
senderAccountParameter | nullqueryFilters delegations by sender. Allowed fields for .eqx mode: prevDelegate, newDelegate.
prevDelegateAccountParameter | nullqueryFilters delegations by prev delegate. Allowed fields for .eqx mode: initiator, sender, newDelegate.
newDelegateAccountParameter | nullqueryFilters delegations by new delegate. Allowed fields for .eqx mode: initiator, sender, prevDelegate.
levelInt32Parameter | nullqueryFilters delegations by level.
timestampDateTimeParameter | nullqueryFilters delegations by timestamp.
senderCodeHashInt32Parameter | nullqueryFilters by senderCodeHash.
statusOperationStatusParameter | nullqueryFilters delegations by operation status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegations by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet delegation by hash
Returns a delegation operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet delegation status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet delegations count
Returns the total number of delegation operations.
Parameters
levelInt32Parameter | nullqueryFilters delegations by level.
timestampDateTimeParameter | nullqueryFilters delegations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet originations
Returns a list of origination operations.
Parameters
anyofAnyOfParameter | nullqueryFilters originations by any of the specified fields. Example: anyof.sender.initiator=tz1... will return operations where sender OR initiator is equal to the specified value. This parameter is useful when you need to retrieve all originations associated with a specified account.
initiatorAccountParameter | nullqueryFilters origination operations by initiator. Allowed fields for .eqx mode: contractManager, contractDelegate.
senderAccountParameter | nullqueryFilters origination operations by sender. Allowed fields for .eqx mode: contractManager, contractDelegate.
contractManagerAccountParameter | nullqueryFilters origination operations by manager. Allowed fields for .eqx mode: initiator, sender, contractDelegate.
contractDelegateAccountParameter | nullqueryFilters origination operations by delegate. Allowed fields for .eqx mode: initiator, sender, contractManager.
originatedContractAccountParameter | nullqueryFilters origination operations by originated contract. Allowed fields for .eqx mode: none.
idInt64Parameter | nullqueryFilters origination operations by internal TzKT id
typeHashInt32Parameter | nullqueryFilters origination operations by 32-bit hash of originated contract parameter and storage types (helpful for searching originations of similar contracts)
codeHashInt32Parameter | nullqueryFilters origination operations by 32-bit hash of originated contract code (helpful for searching originations of same contracts)
levelInt32Parameter | nullqueryFilters origination operations by level.
timestampTimestampParameter | nullqueryFilters origination operations by timestamp.
senderCodeHashInt32Parameter | nullqueryFilters by senderCodeHash.
anyCodeHashInt32Parameter | nullqueryFilters by either senderCodeHash or codeHash.
statusOperationStatusParameter | nullqueryFilters origination operations by operation status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts originations by specified field. Supported fields: id (default), level, gasUsed, storageUsed, bakerFee, storageFee, allocationFee, contractBalance.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet origination by hash
Returns origination operations with specified hash.
Parameters
hashstringrequiredpathOperation hash
michelineMichelineFormatJsonJsonStringRawRawStringqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet origination status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet originations count
Returns the total number of origination operations.
Parameters
levelInt32Parameter | nullqueryFilters originations by level.
timestampTimestampParameter | nullqueryFilters originations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet transactions
Returns a list of transaction operations.
Parameters
anyofAnyOfParameter | nullqueryFilters transactions by any of the specified fields. Example: anyof.sender.target=tz1... will return operations where sender OR target is equal to the specified value. This parameter is useful when you need to retrieve all transactions associated with a specified account.
initiatorAccountParameter | nullqueryFilters transactions by initiator. Allowed fields for .eqx mode: target.
senderAccountParameter | nullqueryFilters transactions by sender. Allowed fields for .eqx mode: target.
targetAccountParameter | nullqueryFilters transactions by target. Allowed fields for .eqx mode: sender, initiator.
amountInt64Parameter | nullqueryFilters transactions by amount (micro tez).
idInt64Parameter | nullqueryFilters transactions by id.
levelInt32Parameter | nullqueryFilters transactions by level.
timestampTimestampParameter | nullqueryFilters transactions by timestamp.
senderCodeHashInt32Parameter | nullqueryFilters by senderCodeHash.
targetCodeHashInt32Parameter | nullqueryFilters by targetCodeHash.
codeHashInt32Parameter | nullqueryFilters by either senderCodeHash or targetCodeHash.
entrypointStringParameter | nullqueryFilters transactions by entrypoint called on the target contract.
parameterJsonParameter | nullqueryFilters transactions by parameter value. Note, this query parameter supports the following format: ?parameter{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?parameter.token_id=... or ?parameter.sigs.0.ne=....
Also, note that .value part must be omitted in the path, so, for example, filtering by parameter.value.foo must be specified as ?parameter.foo=....
hasInternalsBoolParameter | nullqueryFilters transactions by presence of internal operations.
statusOperationStatusParameter | nullqueryFilters transactions by operation status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts transactions by specified field. Supported fields: id (default), level, gasUsed, storageUsed, bakerFee, storageFee, allocationFee, amount.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet transaction by hash
Returns transaction operations with specified hash.
Parameters
hashstringrequiredpathOperation hash
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet transaction by hash and counter
Returns transaction operations with specified hash and counter.
Parameters
hashstringrequiredpathOperation hash
counterinteger<int32>requiredpathOperation counter
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet transaction by hash, counter and nonce
Returns an internal transaction operation with specified hash, counter and nonce.
Parameters
hashstringrequiredpathOperation hash
counterinteger<int32>requiredpathOperation counter
nonceinteger<int32>requiredpathOperation nonce (internal)
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet transaction status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet transactions count
Returns the total number of transaction operations.
Parameters
anyofAnyOfParameter | nullqueryFilters transactions by any of the specified fields. Example: anyof.sender.target=tz1... will return operations where sender OR target is equal to the specified value. This parameter is useful when you need to retrieve all transactions associated with a specified account.
initiatorAccountParameter | nullqueryFilters transactions by initiator. Allowed fields for .eqx mode: target.
senderAccountParameter | nullqueryFilters transactions by sender. Allowed fields for .eqx mode: target.
targetAccountParameter | nullqueryFilters transactions by target. Allowed fields for .eqx mode: sender, initiator.
amountInt64Parameter | nullqueryFilters transactions by amount (micro tez).
levelInt32Parameter | nullqueryFilters transactions by level.
timestampTimestampParameter | nullqueryFilters transactions by timestamp.
entrypointStringParameter | nullqueryFilters transactions by entrypoint called on the target contract.
parameterJsonParameter | nullqueryFilters transactions by parameter value. Note, this query parameter supports the following format: ?parameter{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?parameter.token_id=... or ?parameter.sigs.0.ne=....
Also, note that .value part must be omitted in the path, so, for example, filtering by parameter.value.foo must be specified as ?parameter.foo=....
statusOperationStatusParameter | nullqueryFilters transactions by operation status (applied, failed, backtracked, skipped).
Response
Authorization
api-keyAuthapiKey in headerGet reveals
Returns a list of reveal operations.
Parameters
senderAccountParameter | nullqueryFilters reveal operations by sender. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters reveal operations by level.
timestampDateTimeParameter | nullqueryFilters reveal operations by timestamp.
statusOperationStatusParameter | nullqueryFilters reveal operations by operation status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts reveals by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet reveal by hash
Returns reveal operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet reveal status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet reveals count
Returns the total number of reveal operations.
Parameters
levelInt32Parameter | nullqueryFilters reveals by level.
timestampDateTimeParameter | nullqueryFilters reveals by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet register constants
Returns a list of register global constant operations.
Parameters
senderAccountParameter | nullqueryFilters operations by sender. Allowed fields for .eqx mode: none.
addressExpressionParameter | nullqueryFilters operations by global address of the created constant (starts with expr..).
levelInt32Parameter | nullqueryFilters operations by level.
timestampDateTimeParameter | nullqueryFilters operations by timestamp.
statusOperationStatusParameter | nullqueryFilters operations by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts operations by specified field. Supported fields: id (default), level, gasUsed, storageUsed, bakerFee, storageFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the constant value: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet register constant by hash
Returns register global constant operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
michelineMichelineFormatJsonqueryFormat of the constant value: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet register constant status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet register constants count
Returns the total number of register global constant operations.
Parameters
levelInt32Parameter | nullqueryFilters operations by level.
timestampDateTimeParameter | nullqueryFilters operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet set deposits limits
Returns a list of set deposits limit operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet set deposits limit by hash
Returns set deposits limit operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet set deposits limit status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet set deposits limits count
Returns the total number of set deposits limit operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet transfer ticket
Returns a list of transfer ticket operations.
Parameters
anyofAnyOfParameter | nullqueryFilters by any of the specified fields. Example: anyof.sender.target=tz1... will return operations where sender OR target is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
targetAccountParameter | nullqueryFilters by target. Allowed fields for .eqx mode: none.
idInt64Parameter | nullqueryFilters by id.
ticketerAccountParameter | nullqueryFilters by ticketer. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the content value: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet transfer ticket by hash
Returns transfer ticket operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
michelineMichelineFormatJsonqueryFormat of the content value: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet transfer ticket status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet transfer ticket count
Returns the total number of transfer ticket operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup commit
Returns a list of tx rollup commit operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup commit by hash
Returns tx rollup commit operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup commit status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup commit count
Returns the total number of tx rollup commit operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup dispatch tickets
Returns a list of tx rollup dispatch tickets operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup dispatch tickets by hash
Returns tx rollup dispatch tickets operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup dispatch tickets status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup dispatch tickets count
Returns the total number of tx rollup dispatch tickets operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup finalize commitment
Returns a list of tx rollup finalize commitment operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup finalize commitment by hash
Returns tx rollup finalize commitment operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup finalize commitment status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup finalize commitment count
Returns the total number of tx rollup finalize commitment operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup origination
Returns a list of tx rollup origination operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup origination by hash
Returns tx rollup origination operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup origination status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup origination count
Returns the total number of tx rollup origination operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup rejection
Returns a list of tx rollup rejection operations.
Parameters
anyofAnyOfParameter | nullqueryFilters by any of the specified fields. Example: anyof.sender.committer=tz1... will return operations where sender OR committer is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
committerAccountParameter | nullqueryFilters by committer. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup rejection by hash
Returns tx rollup rejection operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup rejection status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup rejection count
Returns the total number of tx rollup rejection operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup remove commitment
Returns a list of tx rollup remove commitment operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup remove commitment by hash
Returns tx rollup remove commitment operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup remove commitment status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup remove commitment count
Returns the total number of tx rollup remove commitment operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup return bond
Returns a list of tx rollup return bond operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup return bond by hash
Returns tx rollup return bond operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup return bond status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup return bond count
Returns the total number of tx rollup return bond operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup submit batch
Returns a list of tx rollup submit batch operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
rollupAccountParameter | nullqueryFilters by rollup. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level, gasUsed, bakerFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup submit batch by hash
Returns tx rollup submit batch operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup submit batch status
Returns operation status: true if applied, false if failed, null (or HTTP 204) if doesn't exist.
Parameters
hashstringrequiredpathOperation hash
Response
Authorization
api-keyAuthapiKey in headerGet tx rollup submit batch count
Returns the total number of tx rollup submit batch operations.
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet increase paid storage
Returns a list of increase paid storage operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
contractAccountParameter | nullqueryFilters by contract. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts operations by specified field. Supported fields: id (default), level, gasUsed, storageUsed, bakerFee, storageFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet increase paid storage by hash
Returns increase paid storage operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet increase paid storage count
Returns the total number of increase paid storage operations.
Parameters
levelInt32Parameter | nullqueryFilters operations by level.
timestampDateTimeParameter | nullqueryFilters operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet update consensus key
Returns a list of update consensus key operations.
Parameters
senderAccountParameter | nullqueryFilters by sender. Allowed fields for .eqx mode: none.
activationCycleInt32Parameter | nullqueryFilters by activation cycle. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
statusOperationStatusParameter | nullqueryFilters by status (applied, failed, backtracked, skipped).
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts operations by specified field. Supported fields: id (default), level, gasUsed, storageUsed, bakerFee, storageFee.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet update consensus key by hash
Returns update consensus key operation with specified hash.
Parameters
hashstringrequiredpathOperation hash
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet update consensus key count
Returns the total number of update consensus key operations.
Parameters
levelInt32Parameter | nullqueryFilters operations by level.
timestampDateTimeParameter | nullqueryFilters operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup add messages
Returns a list of smart rollup add messages operations.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup add messages count
Returns a total number of smart rollup add messages operations.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup cement
Returns a list of smart rollup cement operations.
Parameters
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup cement count
Returns a total number of smart rollup cement operations.
Parameters
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup execute
Returns a list of smart rollup execute operations.
Parameters
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup execute count
Returns a total number of smart rollup execute operations.
Parameters
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup originate
Returns a list of smart rollup originate operations.
Parameters
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
michelineMichelineFormatJsonqueryFormat of the parameter type value: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup originate count
Returns a total number of smart rollup originate operations.
Parameters
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup publish
Returns a list of smart rollup publish operations.
Parameters
commitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
commitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup publish count
Returns a total number of smart rollup publish operations.
Parameters
commitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
commitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup recover bond
Returns a list of smart rollup recover bond operations.
Parameters
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (sender or staker).
Example: anyof.sender.staker=tz1... will return operations where sender OR staker is equal to the specified value.
This parameter is useful when you need to get all operations somehow related to the account in a single request.
Click on the parameter to expand more details.
stakerAccountParameter | nullqueryFilter by staker address.
Click on the parameter to expand more details.
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup recover bond count
Returns a total number of smart rollup recover bond operations.
Parameters
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (sender or staker).
Example: anyof.sender.staker=tz1... will return operations where sender OR staker is equal to the specified value.
This parameter is useful when you need to get all operations somehow related to the account in a single request.
Click on the parameter to expand more details.
stakerAccountParameter | nullqueryFilter by staker address.
Click on the parameter to expand more details.
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup refute
Returns a list of smart rollup refute operations.
Parameters
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (sender, initiator, or opponent).
Example: anyof.initiator.opponent=tz1... will return operations where initiator OR opponent is equal to the specified value.
This parameter is useful when you need to get all operations somehow related to the account in a single request.
Click on the parameter to expand more details.
game.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
game.initiatorAccountParameter | nullqueryFilter by initiator (who found a wrong commitment and started the refutation game).
Click on the parameter to expand more details.
game.initiatorCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
game.initiatorCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
game.opponentAccountParameter | nullqueryFilter by opponent (who was accused in publishing a wrong commitment).
Click on the parameter to expand more details.
game.opponentCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
game.opponentCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
moveRefutationMoveParameter | nullqueryFilter by refutation game move (start, dissection, proof, or timeout).
Click on the parameter to expand more details.
gameStatusRefutationGameStatusParameter | nullqueryFilter by refutation game status (none, ongoing, loser, or draw).
Click on the parameter to expand more details.
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup refute count
Returns a total number of smart rollup refute operations.
Parameters
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (sender, initiator, or opponent).
Example: anyof.initiator.opponent=tz1... will return operations where initiator OR opponent is equal to the specified value.
This parameter is useful when you need to get all operations somehow related to the account in a single request.
Click on the parameter to expand more details.
game.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
game.initiatorAccountParameter | nullqueryFilter by initiator (who found a wrong commitment and started the refutation game).
Click on the parameter to expand more details.
game.initiatorCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
game.initiatorCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
game.opponentAccountParameter | nullqueryFilter by opponent (who was accused in publishing a wrong commitment).
Click on the parameter to expand more details.
game.opponentCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
game.opponentCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
moveRefutationMoveParameter | nullqueryFilter by refutation game move (start, dissection, proof, or timeout).
Click on the parameter to expand more details.
gameStatusRefutationGameStatusParameter | nullqueryFilter by refutation game status (none, ongoing, loser, or draw).
Click on the parameter to expand more details.
rollupSmartRollupParameter | nullqueryFilter by rollup address.
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet staking ops
Returns a list of staking operations.
Parameters
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (sender, or baker).
Example: anyof.sender.baker=tz1... will return operations where sender OR baker is equal to the specified value.
This parameter is useful when you need to get all operations somehow related to the account in a single request.
Click on the parameter to expand more details.
bakerAccountParameter | nullqueryFilter by baker address.
Click on the parameter to expand more details.
kindStakingOperationKindParameter | nullqueryFilter by operation kind (stake, unstake, finalize, or set_parameters).
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet staking ops count
Returns a total number of staking operations.
Parameters
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (sender, or baker).
Example: anyof.sender.baker=tz1... will return operations where sender OR baker is equal to the specified value.
This parameter is useful when you need to get all operations somehow related to the account in a single request.
Click on the parameter to expand more details.
bakerAccountParameter | nullqueryFilter by baker address.
Click on the parameter to expand more details.
kindStakingOperationKindParameter | nullqueryFilter by operation kind (stake, unstake, finalize, or set_parameters).
Click on the parameter to expand more details.
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
hashOpHashParameter | nullqueryFilter by operation hash.
Click on the parameter to expand more details.
counterInt32Parameter | nullqueryFilter by operation counter.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by the domain level.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the operation.
Click on the parameter to expand more details.
statusOperationStatusParameter | nullqueryFilter by operation status (applied, failed, backtracked, skipped).
Click on the parameter to expand more details.
senderAccountParameter | nullqueryFilter by operation sender address.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet migrations
Returns a list of migration operations (synthetic type).
Parameters
accountAccountParameter | nullqueryFilters migration operations by account. Allowed fields for .eqx mode: none.
kindMigrationKindParameter | nullqueryFilters migration operations by kind (bootstrap, activate_delegate, airdrop, proposal_invoice, origination, subsidy, remove_bigmap_key).
balanceChangeInt64Parameter | nullqueryFilters migration operations by amount.
idInt64Parameter | nullqueryFilters migration operations by internal TzKT id.
levelInt32Parameter | nullqueryFilters migration operations by level.
timestampDateTimeParameter | nullqueryFilters migration operations by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts migrations by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet migration by id
Returns migration operation with specified id.
Parameters
idinteger<int64>requiredpathOperation id
michelineMichelineFormatJsonqueryFormat of the parameters, storage and diffs: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet migrations count
Returns the total number of migration operations (synthetic type).
Parameters
levelInt32Parameter | nullqueryFilters migrations by level.
timestampDateTimeParameter | nullqueryFilters migrations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet revelation penalties
Returns a list of revelation penalty operations (synthetic type).
Parameters
idInt64Parameter | nullqueryFilters operations by internal TzKT id.
bakerAccountParameter | nullqueryFilters revelation penalty operations by baker. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters revelation penalty operations by level.
timestampDateTimeParameter | nullqueryFilters revelation penalty operations by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts revelation penalty operations by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet revelation penalty by id
Returns revelation penalty operation with specified id.
Parameters
idinteger<int64>requiredpathOperation id
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet revelation penalties count
Returns the total number of revelation penalty operations (synthetic type).
Parameters
levelInt32Parameter | nullqueryFilters revelation penalty operations by level.
timestampDateTimeParameter | nullqueryFilters revelation penalty operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet baking
Returns a list of baking operations (synthetic type).
Parameters
bakerAccountParameter | nullquery[DEPRECATED]
anyofAnyOfParameter | nullqueryFilters by any of the specified fields. Example: anyof.proposer.producer=tz1....
proposerAccountParameter | nullqueryFilters by block proposer. Allowed fields for .eqx mode: none.
producerAccountParameter | nullqueryFilters by block producer. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters baking operations by level.
timestampDateTimeParameter | nullqueryFilters baking operations by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts baking operations by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet baking by id
Returns baking operation with specified id.
Parameters
idinteger<int64>requiredpathOperation id
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet baking count
Returns the total number of baking operations (synthetic type).
Parameters
levelInt32Parameter | nullqueryFilters baking operations by level.
timestampDateTimeParameter | nullqueryFilters baking operations by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet endorsing rewards
Returns a list of endorsing reward operations (synthetic type).
Parameters
idInt64Parameter | nullqueryFilters operations by internal TzKT id.
bakerAccountParameter | nullqueryFilters by baker. Allowed fields for .eqx mode: none.
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts by specified field. Supported fields: id (default), level.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet endorsing reward by id
Returns endorsing reward operation with specified id.
Parameters
idinteger<int64>requiredpathOperation id
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet endorsing rewards count
Returns the total number of endorsing reward operations (synthetic type).
Parameters
levelInt32Parameter | nullqueryFilters by level.
timestampDateTimeParameter | nullqueryFilters by timestamp.
Response
Authorization
api-keyAuthapiKey in headerGet autostaking ops
Returns a list of autostaking operations.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the operation happened.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the operation happened.
Click on the parameter to expand more details.
bakerAccountParameter | nullqueryFilter by baker.
Click on the parameter to expand more details.
actionAutostakingActionParameter | nullqueryFilter by autostaking action.
Click on the parameter to expand more details.
cycleInt32Parameter | nullqueryFilter by cycle.
Click on the parameter to expand more details.
amountInt64Parameter | nullqueryFilter by amount.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet autostaking ops count
Returns a total number of autostaking operations.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the operation happened.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the operation happened.
Click on the parameter to expand more details.
bakerAccountParameter | nullqueryFilter by baker.
Click on the parameter to expand more details.
actionAutostakingActionParameter | nullqueryFilter by autostaking action.
Click on the parameter to expand more details.
cycleInt32Parameter | nullqueryFilter by cycle.
Click on the parameter to expand more details.
amountInt64Parameter | nullqueryFilter by amount.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerProtocols
Get protocols count
Returns the total number of protocols.
Response
Authorization
api-keyAuthapiKey in headerGet protocols
Returns a list of protocols.
Parameters
sortSortParameter | nullquerySorts protocols by specified field. Supported fields: code (default), firstLevel, lastLevel.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet current protocol
Returns current protocol.
Response
Authorization
api-keyAuthapiKey in headerGet protocol by code
Returns a protocol with the specified proto code.
Parameters
codeinteger<int32>requiredpathProtocol code (e.g. 4 for Athens, 5 for Babylon, etc)
Response
Authorization
api-keyAuthapiKey in headerGet protocol by hash
Returns a protocol with the specified hash.
Parameters
hashstringrequiredpathProtocol hash
Response
Authorization
api-keyAuthapiKey in headerGet protocol by cycle
Returns a protocol at the specified cycle.
Parameters
cycleinteger<int32>requiredpathCycle index
Response
Authorization
api-keyAuthapiKey in headerQuotes
Get quotes count
Returns the total number of quotes aligned with blocks.
Response
Authorization
api-keyAuthapiKey in headerGet last quote
Returns last known quote.
Response
Authorization
api-keyAuthapiKey in headerGet quotes
Returns a list of quotes aligned with blocks.
Parameters
levelInt32Parameter | nullqueryFilters quotes by level.
timestampDateTimeParameter | nullqueryFilters quotes by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts quotes by specified field. Supported fields: level (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerRewards
Get baker cycle rewards count
Returns total number of cycles where the baker was active
Parameters
addressstringrequiredpathBaker address
Response
Authorization
api-keyAuthapiKey in headerGet baker cycle rewards
Returns a list of baker rewards for every cycle, including future cycles.
Parameters
addressstringrequiredpathBaker address.
cycleInt32Parameter | nullqueryFilters rewards by cycle.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts cycle rewards by specified field. Supported fields: cycle (default, desc).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet delegator cycle rewards count
Returns total number of cycles where the delegator was delegated to an active baker
Parameters
addressstringrequiredpathDelegator address
Response
Authorization
api-keyAuthapiKey in headerGet delegator cycle rewards
Returns a list of delegator rewards for every cycle, including future cycles.
Parameters
addressstringrequiredpathDelegator address.
cycleInt32Parameter | nullqueryFilters rewards by cycle.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts cycle rewards by specified field. Supported fields: cycle (default, desc).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet reward split
Returns baker rewards for the specified cycle with all delegator balances at that cycle to allow rewards distribution in proportion to shares.
Parameters
bakerstringrequiredpathBaker address
cycleinteger<int32>requiredpathRewards cycle
offsetinteger<int32>0querySpecifies how many delegators in the reward split should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of delegators to return
Response
Authorization
api-keyAuthapiKey in headerGet reward split delegator
Returns delegator from the reward split for the specified cycle.
Parameters
bakerstringrequiredpathBaker address
cycleinteger<int32>requiredpathReward split cycle
delegatorstringrequiredpathDelegator address
Response
Authorization
api-keyAuthapiKey in headerRights
Get rights count
Returns the total number of stored rights.
Parameters
typeBakingRightTypeParameter | nullqueryFilters rights by type (baking, endorsing)
bakerAccountParameter | nullqueryFilters rights by baker
cycleInt32Parameter | nullqueryFilters rights by cycle
levelInt32Parameter | nullqueryFilters rights by level
slotsInt32NullParameter | nullqueryFilters rights by slots
roundInt32NullParameter | nullqueryFilters rights by round
priorityInt32NullParameter | nullquery[DEPRECATED]
statusBakingRightStatusParameter | nullqueryFilters rights by status (future, realized, missed)
Response
Authorization
api-keyAuthapiKey in headerGet rights
Returns a list of rights.
Parameters
typeBakingRightTypeParameter | nullqueryFilters rights by type (baking, endorsing)
bakerAccountParameter | nullqueryFilters rights by baker
cycleInt32Parameter | nullqueryFilters rights by cycle
levelInt32Parameter | nullqueryFilters rights by level
slotsInt32NullParameter | nullqueryFilters rights by slots
roundInt32NullParameter | nullqueryFilters rights by round
priorityInt32NullParameter | nullquery[DEPRECATED]
statusBakingRightStatusParameter | nullqueryFilters rights by status (future, realized, missed)
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts rights by specified field. Supported fields: level (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerSmartRollups
Get smart rollups count
Returns a total number of smart rollups.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
addressAddressParameter | nullqueryFilter by smart rollup address.
Click on the parameter to expand more details.
creatorAccountParameter | nullqueryFilter by smart rollup creator.
Click on the parameter to expand more details.
firstActivityInt32Parameter | nullqueryFilter by level of the block, where the rollup was first seen.
Click on the parameter to expand more details.
firstActivityTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the rollup was first seen.
Click on the parameter to expand more details.
lastActivityInt32Parameter | nullqueryFilter by level of the block, where the rollup was last seen.
Click on the parameter to expand more details.
lastActivityTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the rollup was last seen.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollups
Returns a list of smart rollups.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
addressAddressParameter | nullqueryFilter by smart rollup address.
Click on the parameter to expand more details.
creatorAccountParameter | nullqueryFilter by smart rollup creator.
Click on the parameter to expand more details.
firstActivityInt32Parameter | nullqueryFilter by level of the block, where the rollup was first seen.
Click on the parameter to expand more details.
firstActivityTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the rollup was first seen.
Click on the parameter to expand more details.
lastActivityInt32Parameter | nullqueryFilter by level of the block, where the rollup was last seen.
Click on the parameter to expand more details.
lastActivityTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the rollup was last seen.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup by address
Returns a smart rollup with the specified address.
Parameters
addressstringrequiredpathSmart rollup address
Response
Authorization
api-keyAuthapiKey in headerGet JSON Schema [2020-12] interface for the smart rollup
Returns standard JSON Schema for smart rollup parameter.
Parameters
addressstringrequiredpathSmart rollup address
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup stakers
Returns a list of smart rollup stakers.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
addressAddressParameterrequiredpathFilter by smart rollup staker address.
Click on the parameter to expand more details.
bondStatusSrBondStatusParameter | nullqueryFilter by staker bond status (active, returned, or lost).
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup commitments count
Returns a total number of smart rollup commitments.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
initiatorAccountParameter | nullqueryFilter by initiator (an account published the commitment first).
Click on the parameter to expand more details.
rollupAccountParameter | nullqueryFilter by smart rollup.
Click on the parameter to expand more details.
inboxLevelInt32Parameter | nullqueryFilter by inbox level.
Click on the parameter to expand more details.
hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block, where the commitment was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the commitment was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block, where the commitment was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the commitment was last seen.
Click on the parameter to expand more details.
statusSrCommitmentStatusParameter | nullqueryFilter by commitment status (pending, cemented, executed, refuted, or orphan).
Click on the parameter to expand more details.
predecessor.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
predecessor.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup commitments
Returns a list of smart rollup commitments.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
initiatorAccountParameter | nullqueryFilter by initiator (an account published the commitment first).
Click on the parameter to expand more details.
rollupAccountParameter | nullqueryFilter by smart rollup.
Click on the parameter to expand more details.
inboxLevelInt32Parameter | nullqueryFilter by inbox level.
Click on the parameter to expand more details.
hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block, where the commitment was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the commitment was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block, where the commitment was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the commitment was last seen.
Click on the parameter to expand more details.
statusSrCommitmentStatusParameter | nullqueryFilter by commitment status (pending, cemented, executed, refuted, or orphan).
Click on the parameter to expand more details.
predecessor.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
predecessor.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup games count
Returns a total number of smart rollup refutation games.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
rollupAccountParameter | nullqueryFilter by smart rollup.
Click on the parameter to expand more details.
initiatorAccountParameter | nullqueryFilter by initiator (who found a wrong commitment and started the refutation game).
Click on the parameter to expand more details.
initiatorCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
initiatorCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
opponentAccountParameter | nullqueryFilter by opponent (who was accused in publishing a wrong commitment).
Click on the parameter to expand more details.
opponentCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
opponentCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block, where the refutation game was started.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the refutation game was started.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block, where the refutation game was last updated.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the refutation game was last updated.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet smart rollup games
Returns a list of smart rollup refutation games.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
rollupAccountParameter | nullqueryFilter by smart rollup.
Click on the parameter to expand more details.
initiatorAccountParameter | nullqueryFilter by initiator (who found a wrong commitment and started the refutation game).
Click on the parameter to expand more details.
initiatorCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
initiatorCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
opponentAccountParameter | nullqueryFilter by opponent (who was accused in publishing a wrong commitment).
Click on the parameter to expand more details.
opponentCommitment.idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
opponentCommitment.hashSrc1HashParameter | nullqueryFilter by commitment hash.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block, where the refutation game was started.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the refutation game was started.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block, where the refutation game was last updated.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp of the block, where the refutation game was last updated.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet inbox messages count
Returns a total number of smart rollup inbox messages.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block, where the message was pushed.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp of the block, where the message was pushed.
Click on the parameter to expand more details.
typeSrMessageTypeParameter | nullqueryFilter by inbox message type (level_start, level_info, level_end, transfer, external, migration).
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet inbox messages
Returns a list of smart rollup inbox messages.
Parameters
idInt32Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block, where the message was pushed.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp of the block, where the message was pushed.
Click on the parameter to expand more details.
typeSrMessageTypeParameter | nullqueryFilter by inbox message type (level_start, level_info, level_end, transfer, external, migration).
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
michelineMichelineFormatJsonqueryFormat of smart rollup call parameters: 0 - JSON, 1 - JSON string, 2 - raw micheline, 3 - raw micheline string
Response
Authorization
api-keyAuthapiKey in headerSoftware
Get baker software
Returns a list of baker software.
Parameters
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), firstLevel, lastLevel, blocksCount.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet software count
Returns a number of software.
Response
Authorization
api-keyAuthapiKey in headerStatistics
Get statistics
Returns a list of end-of-block statistics.
Parameters
levelInt32Parameter | nullqueryFilters statistics by level.
timestampTimestampParameter | nullqueryFilters statistics by timestamp.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), level, cycle, date.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet daily statistics
Returns a list of end-of-day statistics.
Parameters
dateDateTimeParameter | nullqueryFilters statistics by date.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), level, cycle, date.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet cyclic statistics
Returns a list of end-of-cycle statistics.
Parameters
cycleInt32Parameter | nullqueryFilters statistics by cycle.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts delegators by specified field. Supported fields: id (default), level, cycle, date.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerGet current statistics
Returns statistics at the end of a head block.
Parameters
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
quoteSymbolsNonequeryComma-separated list of ticker symbols to inject historical prices into response
Response
Authorization
api-keyAuthapiKey in headerTickets
Get tickets count
Returns a total number of tickets.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
ticketerAccountParameter | nullqueryFilter by ticketer address.
Click on the parameter to expand more details.
rawTypeMichelineParameter | nullqueryFilter by ticket content type in Micheline format.
Click on the parameter to expand more details.
rawContentMichelineParameter | nullqueryFilter by ticket content in Micheline format.
Click on the parameter to expand more details.
contentJsonParameter | nullqueryFilter by ticket content in JSON format.
Note, this parameter supports the following format: content{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?content.color.in=red,green).
Click on the parameter to expand more details.
typeHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content type.
Click on the parameter to expand more details.
contentHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content.
Click on the parameter to expand more details.
firstMinterAccountParameter | nullqueryFilter by address of the first minter.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the ticket was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the ticket was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the ticket was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the ticket was last seen.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet tickets
Returns a list of tickets.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
ticketerAccountParameter | nullqueryFilter by ticketer address.
Click on the parameter to expand more details.
rawTypeMichelineParameter | nullqueryFilter by ticket content type in Micheline format.
Click on the parameter to expand more details.
rawContentMichelineParameter | nullqueryFilter by ticket content in Micheline format.
Click on the parameter to expand more details.
contentJsonParameter | nullqueryFilter by ticket content in JSON format.
Note, this parameter supports the following format: content{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?content.color.in=red,green).
Click on the parameter to expand more details.
typeHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content type.
Click on the parameter to expand more details.
contentHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content.
Click on the parameter to expand more details.
firstMinterAccountParameter | nullqueryFilter by address of the first minter.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the ticket was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the ticket was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the ticket was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the ticket was last seen.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet ticket balances count
Returns a total number of ticket balances.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
ticket.idInt64Parameter | nullqueryFilter by internal TzKT id. Click on the parameter to expand more details.
ticket.ticketerAccountParameter | nullqueryFilter by ticketer address.
Click on the parameter to expand more details.
ticket.rawTypeMichelineParameter | nullqueryFilter by ticket content type in Micheline format.
Click on the parameter to expand more details.
ticket.rawContentMichelineParameter | nullqueryFilter by ticket content in Micheline format.
Click on the parameter to expand more details.
ticket.contentJsonParameter | nullqueryFilter by ticket content in JSON format.
Note, this parameter supports the following format: content{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?content.color.in=red,green).
Click on the parameter to expand more details.
ticket.typeHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content type.
Click on the parameter to expand more details.
ticket.contentHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content.
Click on the parameter to expand more details.
accountAccountParameter | nullqueryFilter by account address.
Click on the parameter to expand more details.
balanceNatParameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
transfersCountInt32Parameter | nullqueryFilter by number of transfers.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the balance was first changed.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was first changed.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the balance was last changed.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was last changed.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet ticket balances
Returns a list of ticket balances.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
ticket.idInt64Parameter | nullqueryFilter by internal TzKT id. Click on the parameter to expand more details.
ticket.ticketerAccountParameter | nullqueryFilter by ticketer address.
Click on the parameter to expand more details.
ticket.rawTypeMichelineParameter | nullqueryFilter by ticket content type in Micheline format.
Click on the parameter to expand more details.
ticket.rawContentMichelineParameter | nullqueryFilter by ticket content in Micheline format.
Click on the parameter to expand more details.
ticket.contentJsonParameter | nullqueryFilter by ticket content in JSON format.
Note, this parameter supports the following format: content{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?content.color.in=red,green).
Click on the parameter to expand more details.
ticket.typeHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content type.
Click on the parameter to expand more details.
ticket.contentHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content.
Click on the parameter to expand more details.
accountAccountParameter | nullqueryFilter by account address.
Click on the parameter to expand more details.
balanceNatParameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
transfersCountInt32Parameter | nullqueryFilter by number of transfers.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the balance was first changed.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was first changed.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the balance was last changed.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was last changed.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet ticket transfers count
Returns the total number of ticket transfers.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the transfer was made.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the transfer was made.
Click on the parameter to expand more details.
ticket.idInt64Parameter | nullqueryFilter by internal TzKT id. Click on the parameter to expand more details.
ticket.ticketerAccountParameter | nullqueryFilter by ticketer address.
Click on the parameter to expand more details.
ticket.rawTypeMichelineParameter | nullqueryFilter by ticket content type in Micheline format.
Click on the parameter to expand more details.
ticket.rawContentMichelineParameter | nullqueryFilter by ticket content in Micheline format.
Click on the parameter to expand more details.
ticket.contentJsonParameter | nullqueryFilter by ticket content in JSON format.
Note, this parameter supports the following format: content{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?content.color.in=red,green).
Click on the parameter to expand more details.
ticket.typeHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content type.
Click on the parameter to expand more details.
ticket.contentHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content.
Click on the parameter to expand more details.
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (from or to).
Example: anyof.from.to=tz1... will return transfers where from OR to is equal to the specified value.
This parameter is useful when you need to get both incoming and outgoing transfers of the account at once.
Click on the parameter to expand more details.
fromAccountParameter | nullqueryFilter by sender address.
Click on the parameter to expand more details.
toAccountParameter | nullqueryFilter by recepient address.
Click on the parameter to expand more details.
amountNatParameter | nullqueryFilter by amount.
Click on the parameter to expand more details.
transactionIdInt64NullParameter | nullqueryFilter by id of the transaction, caused the ticket transfer.
Click on the parameter to expand more details.
transferTicketIdInt64NullParameter | nullqueryFilter by id of the transfer_ticket operation, caused the ticket transfer.
Click on the parameter to expand more details.
smartRollupExecuteIdInt64NullParameter | nullqueryFilter by id of the smart_rollup_execute operation, caused the ticket transfer.
Click on the parameter to expand more details.
Response
Authorization
api-keyAuthapiKey in headerGet ticket transfers
Returns a list of ticket transfers.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the transfer was made.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the transfer was made.
Click on the parameter to expand more details.
ticket.idInt64Parameter | nullqueryFilter by internal TzKT id. Click on the parameter to expand more details.
ticket.ticketerAccountParameter | nullqueryFilter by ticketer address.
Click on the parameter to expand more details.
ticket.rawTypeMichelineParameter | nullqueryFilter by ticket content type in Micheline format.
Click on the parameter to expand more details.
ticket.rawContentMichelineParameter | nullqueryFilter by ticket content in Micheline format.
Click on the parameter to expand more details.
ticket.contentJsonParameter | nullqueryFilter by ticket content in JSON format.
Note, this parameter supports the following format: content{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?content.color.in=red,green).
Click on the parameter to expand more details.
ticket.typeHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content type.
Click on the parameter to expand more details.
ticket.contentHashInt32Parameter | nullqueryFilter by 32-bit hash of ticket content.
Click on the parameter to expand more details.
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (from or to).
Example: anyof.from.to=tz1... will return transfers where from OR to is equal to the specified value.
This parameter is useful when you need to get both incoming and outgoing transfers of the account at once.
Click on the parameter to expand more details.
fromAccountParameter | nullqueryFilter by sender address.
Click on the parameter to expand more details.
toAccountParameter | nullqueryFilter by recepient address.
Click on the parameter to expand more details.
amountNatParameter | nullqueryFilter by amount.
Click on the parameter to expand more details.
transactionIdInt64NullParameter | nullqueryFilter by id of the transaction, caused the ticket transfer.
Click on the parameter to expand more details.
transferTicketIdInt64NullParameter | nullqueryFilter by id of the transfer_ticket operation, caused the ticket transfer.
Click on the parameter to expand more details.
smartRollupExecuteIdInt64NullParameter | nullqueryFilter by id of the smart_rollup_execute operation, caused the ticket transfer.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet historical ticket balances
Returns a list of ticket balances at the end of the specified block.
Note, this endpoint is quite heavy, therefore at least one of the filters
(account, ticket.id, ticket.ticketer) must be specified.
Parameters
levelinteger<int32>requiredpathLevel of the block at the end of which historical balances must be calculated
idInt64Parameter | nullqueryFilter by internal TzKT id. Click on the parameter to expand more details.
ticket.idInt64Parameter | nullqueryFilter by internal TzKT id. Click on the parameter to expand more details.
ticket.ticketerAccountParameter | nullqueryFilter by ticketer address.
Click on the parameter to expand more details.
accountAccountParameter | nullqueryFilter by account address.
Click on the parameter to expand more details.
balanceNatParameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerTokens
Get tokens count
Returns a total number of tokens.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id. Note, this is not the same as tokenId nat value.
Click on the parameter to expand more details.
contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
tokenIdNatParameter | nullqueryFilter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.
standardTokenStandardParameter | nullqueryFilter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.
firstMinterAccountParameter | nullqueryFilter by address of the first minter.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the token was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the token was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the token was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the token was last seen.
Click on the parameter to expand more details.
metadataJsonParameter | nullqueryFilter by metadata.
Note, this parameter supports the following format: metadata{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?metadata.symbol.in=kUSD,uUSD).
Click on the parameter to expand more details.
indexedAtInt32NullParameter | nullqueryResponse
Authorization
api-keyAuthapiKey in headerGet tokens
Returns a list of tokens.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id. Note, this is not the same as tokenId nat value.
Click on the parameter to expand more details.
contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
tokenIdNatParameter | nullqueryFilter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.
standardTokenStandardParameter | nullqueryFilter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.
firstMinterAccountParameter | nullqueryFilter by address of the first minter.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the token was first seen.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the token was first seen.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the token was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the token was last seen.
Click on the parameter to expand more details.
metadataJsonParameter | nullqueryFilter by metadata.
Note, this parameter supports the following format: metadata{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by (for example, ?metadata.symbol.in=kUSD,uUSD).
Click on the parameter to expand more details.
indexedAtInt32NullParameter | nullquerysortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet token balances count
Returns a total number of token balances.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
accountAccountParameter | nullqueryFilter by account address.
Click on the parameter to expand more details.
token.idInt64Parameter | nullqueryFilter by internal TzKT id. Note, this is not the same as tokenId.
Click on the parameter to expand more details.
token.contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
token.tokenIdNatParameter | nullqueryFilter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.
token.standardTokenStandardParameter | nullqueryFilter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.
token.metadataJsonParameter | nullqueryFilter by metadata. Note, this parameter supports the following format: token.metadata{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?token.metadata.symbol.in=kUSD,uUSD.
Click on the parameter to expand more details.
balanceNatParameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the balance was first changed.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was first changed.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the balance was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was last changed.
Click on the parameter to expand more details.
indexedAtInt32NullParameter | nullqueryResponse
Authorization
api-keyAuthapiKey in headerGet token balances
Returns a list of token balances.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
accountAccountParameter | nullqueryFilter by account address.
Click on the parameter to expand more details.
token.idInt64Parameter | nullqueryFilter by internal TzKT id. Note, this is not the same as tokenId.
Click on the parameter to expand more details.
token.contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
token.tokenIdNatParameter | nullqueryFilter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.
token.standardTokenStandardParameter | nullqueryFilter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.
token.metadataJsonParameter | nullqueryFilter by metadata. Note, this parameter supports the following format: token.metadata{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?token.metadata.symbol.in=kUSD,uUSD.
Click on the parameter to expand more details.
balanceNatParameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
firstLevelInt32Parameter | nullqueryFilter by level of the block where the balance was first changed.
Click on the parameter to expand more details.
firstTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was first changed.
Click on the parameter to expand more details.
lastLevelInt32Parameter | nullqueryFilter by level of the block where the balance was last seen.
Click on the parameter to expand more details.
lastTimeTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the balance was last changed.
Click on the parameter to expand more details.
indexedAtInt32NullParameter | nullquerysortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet token transfers count
Returns the total number of token transfers.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the transfer was made.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the transfer was made.
Click on the parameter to expand more details.
token.idInt64Parameter | nullqueryFilter by internal TzKT id. Note, this is not the same as tokenId.
Click on the parameter to expand more details.
token.contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
token.tokenIdNatParameter | nullqueryFilter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.
token.standardTokenStandardParameter | nullqueryFilter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.
token.metadataJsonParameter | nullqueryFilter by metadata. Note, this parameter supports the following format: token.metadata{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?token.metadata.symbol.in=kUSD,uUSD.
Click on the parameter to expand more details.
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (from or to).
Example: anyof.from.to=tz1... will return transfers where from OR to is equal to the specified value.
This parameter is useful when you need to get both incoming and outgoing transfers of the account at once.
Click on the parameter to expand more details.
fromAccountParameter | nullqueryFilter by sender account address.
Click on the parameter to expand more details.
toAccountParameter | nullqueryFilter by target account address.
Click on the parameter to expand more details.
amountNatParameter | nullqueryFilter by amount.
Click on the parameter to expand more details.
transactionIdInt64NullParameter | nullqueryFilter by id of the transaction, caused the token transfer.
Click on the parameter to expand more details.
originationIdInt64NullParameter | nullqueryFilter by id of the origination, caused the token transfer.
Click on the parameter to expand more details.
migrationIdInt64NullParameter | nullqueryFilter by id of the migration, caused the token transfer.
Click on the parameter to expand more details.
indexedAtInt32NullParameter | nullqueryResponse
Authorization
api-keyAuthapiKey in headerGet token transfers
Returns a list of token transfers.
Parameters
idInt64Parameter | nullqueryFilter by internal TzKT id.
Click on the parameter to expand more details.
levelInt32Parameter | nullqueryFilter by level of the block where the transfer was made.
Click on the parameter to expand more details.
timestampTimestampParameter | nullqueryFilter by timestamp (ISO 8601) of the block where the transfer was made.
Click on the parameter to expand more details.
token.idInt64Parameter | nullqueryFilter by internal TzKT id. Note, this is not the same as tokenId.
Click on the parameter to expand more details.
token.contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
token.tokenIdNatParameter | nullqueryFilter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.
token.standardTokenStandardParameter | nullqueryFilter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.
token.metadataJsonParameter | nullqueryFilter by metadata. Note, this parameter supports the following format: token.metadata{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?token.metadata.symbol.in=kUSD,uUSD.
Click on the parameter to expand more details.
anyofAnyOfParameter | nullqueryFilter by any of the specified fields (from or to).
Example: anyof.from.to=tz1... will return transfers where from OR to is equal to the specified value.
This parameter is useful when you need to get both incoming and outgoing transfers of the account at once.
Click on the parameter to expand more details.
fromAccountParameter | nullqueryFilter by sender account address.
Click on the parameter to expand more details.
toAccountParameter | nullqueryFilter by target account address.
Click on the parameter to expand more details.
amountNatParameter | nullqueryFilter by amount.
Click on the parameter to expand more details.
transactionIdInt64NullParameter | nullqueryFilter by id of the transaction, caused the token transfer.
Click on the parameter to expand more details.
originationIdInt64NullParameter | nullqueryFilter by id of the origination, caused the token transfer.
Click on the parameter to expand more details.
migrationIdInt64NullParameter | nullqueryFilter by id of the migration, caused the token transfer.
Click on the parameter to expand more details.
indexedAtInt32NullParameter | nullquerysortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerGet historical token balances
Returns a list of token balances at the end of the specified block.
Note, this endpoint is quite heavy, therefore at least one of the filters
(account, token.id, token.contract with token.tokenId) must be specified.
Parameters
levelinteger<int32>requiredpathLevel of the block at the end of which historical balances must be calculated
accountAccountParameter | nullqueryFilter by account address.
Click on the parameter to expand more details.
token.idInt64Parameter | nullqueryFilter by internal TzKT id. Note, this is not the same as tokenId.
Click on the parameter to expand more details.
token.contractAccountParameter | nullqueryFilter by contract address.
Click on the parameter to expand more details.
token.tokenIdNatParameter | nullqueryFilter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.
token.standardTokenStandardParameter | nullqueryFilter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.
token.metadataJsonParameter | nullqueryFilter by metadata. Note, this parameter supports the following format: token.metadata{.path?}{.mode?}=...,
so you can specify a path to a particular field to filter by, for example: ?token.metadata.symbol.in=kUSD,uUSD.
Click on the parameter to expand more details.
balanceNatParameter | nullqueryFilter by balance.
Click on the parameter to expand more details.
sortSortParameter | nullquerySorts items (asc or desc) by the specified field.
You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped.
Click on the parameter to expand more details.
limitinteger<int32>[0, 10000]queryMaximum number of items to return.
selectSelectionParameter | nullquerySpecify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.
This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection
(for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.
Response
Authorization
api-keyAuthapiKey in headerVoting
Get proposals count
Returns the total number of protocol proposals.
Response
Authorization
api-keyAuthapiKey in headerGet proposals
Returns a list of protocol proposals.
Parameters
hashProtocolParameter | nullqueryFilters proposals by hash
epochInt32Parameter | nullqueryFilters proposals by voting epoch
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts proposals by specified field. Supported fields: id (default), upvotes, votingPower.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet proposal by hash
Returns the most recent protocol proposal with the specified hash.
Parameters
hashstringrequiredpathProposal hash
Response
Authorization
api-keyAuthapiKey in headerGet voting periods
Returns a list of voting periods.
Parameters
firstLevelInt32Parameter | nullqueryFilter by level of the first block of the period.
lastLevelInt32Parameter | nullqueryFilter by level of the last block of the period.
selectSelectParameter | nullquerySpecify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.
sortSortParameter | nullquerySorts voting periods by specified field. Supported fields: id (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet voting period by index
Returns a voting period at the specified index.
Parameters
indexinteger<int32>requiredpathVoting period index starting from zero
Response
Authorization
api-keyAuthapiKey in headerGet current voting period
Returns current voting period.
Response
Authorization
api-keyAuthapiKey in headerGet period voters
Returns voters from the voting period at the specified index.
Parameters
indexinteger<int32>requiredpathVoting period index starting from zero
statusVoterStatusParameter | nullqueryFilters voters by status (none, upvoted, voted_yay, voted_nay, voted_pass)
sortSortParameter | nullquerySorts voters by specified field. Supported fields: id (default), votingPower.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet period voter
Returns a voter with the specified address from the voting period at the specified index.
Parameters
indexinteger<int32>requiredpathVoting period index starting from zero
addressstringrequiredpathVoter address
Response
Authorization
api-keyAuthapiKey in headerGet current period voters
Returns voters from the current period.
Parameters
statusVoterStatusParameter | nullqueryFilters voters by status (none, upvoted, voted_yay, voted_nay, voted_pass)
sortSortParameter | nullquerySorts voters by specified field. Supported fields: id (default), votingPower.
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet current period voter
Returns a voter with the specified address from the current period.
Parameters
addressstringrequiredpathVoter address
Response
Authorization
api-keyAuthapiKey in headerGet voting epochs
Returns a list of voting epochs.
Parameters
sortSortParameter | nullquerySorts voting epochs by specified field. Supported fields: id (default).
offsetOffsetParameter | nullquerySpecifies which or how many items should be skipped
limitinteger<int32>[0, 10000]100queryMaximum number of items to return
Response
Authorization
api-keyAuthapiKey in headerGet voting epoch by index
Returns a voting epoch at the specified index.
Parameters
indexinteger<int32>requiredpathVoting epoch index starting from zero
Response
Authorization
api-keyAuthapiKey in headerGet current voting epoch
Returns the current voting epoch
Response
Authorization
api-keyAuthapiKey in headerGet latest voting
Returns the latest epoch with at least one proposal
Response
Authorization
api-keyAuthapiKey in headerNode
Protocols
(no description)
Response
Valid response
Authorization
api-keyAuthapiKey in header(no description)
Parameters
Protocol_hashstringrequiredpathProtocol_hash (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in header(no description)
Parameters
Protocol_hashstringrequiredpathProtocol_hash (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerChains
Lists block hashes from '', up to the last checkpoint, sorted with decreasing fitness. Without arguments it returns the head of the chain. Optional arguments allow to return the list of predecessors of a given block or of a set of blocks.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
lengthstringqueryThe requested number of predecessors to return (per request; see next argument).
headstringqueryblock_hash (Base58Check-encoded) An empty argument requests blocks starting with the current head. A non empty list allows to request one or more specific fragments of the chain.
min_datestringqueryA date in seconds from epoch When min_date is provided, blocks with a timestamp before min_date are filtered out. However, if the length parameter is also provided, then up to that number of predecessors will be returned regardless of their date.
Response
Valid response
Authorization
api-keyAuthapiKey in headerThe chain unique identifier.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: use ../levels/{checkpoint, savepoint, caboose, history_mode} instead. The current checkpoint for this chain.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerLists blocks that have been declared invalid along with the errors that led to them being declared invalid.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerThe errors that appears during the block (in)validation.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
block_hashstringrequiredpathblock_hash (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerThe bootstrap status of a chain
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerThe current caboose for this chain.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerThe current checkpoint for this chain.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerThe current savepoint for this chain.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerConfig
Return the runtime node configuration (this takes into account the command-line arguments and the on-disk configuration file)
Response
Valid response
Authorization
api-keyAuthapiKey in headerReturns the history mode of the node's underlying storage.
Response
Valid response
Authorization
api-keyAuthapiKey in headerConfiguration for the DAL
Response
Valid response
Authorization
api-keyAuthapiKey in headerList of protocols which replace other protocols
Response
Valid response
Authorization
api-keyAuthapiKey in headerList of protocols to switch to at given levels
Response
Valid response
Authorization
api-keyAuthapiKey in headerErrors
Schema for all the RPC errors from the shell
Response
Valid response
Authorization
api-keyAuthapiKey in headerFetch_protocol
Fetch a protocol from the network.
Parameters
Protocol_hashstringrequiredpathProtocol_hash (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerInjection
Inject a block in the node and broadcast it. The operations embedded in blockHeader might be pre-validated using a contextual RPCs from the latest block (e.g. '/blocks/head/context/preapply'). Returns the ID of the block. By default, the RPC will wait for the block to be validated before answering. If ?async is true, the function returns immediately. Otherwise, the block will be validated before the result is returned. If ?force is true, it will be injected even on non strictly increasing fitness. An optional ?chain parameter can be used to specify whether to inject on the test chain or the main chain.
Body
datastringrequiredoperationsArray<Array<operation>>requiredParameters
asyncstringqueryforcestringquerychainstringqueryA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerInject an operation in node and broadcast it. Returns the ID of the operation. The signedOperationContents should be constructed using contextual RPCs from the latest block and signed by the client. The injection of the operation will apply it on the current mempool context. This context may change at each operation injection or operation reception from peers. By default, the RPC will wait for the operation to be (pre-)validated before returning. However, if ?async is true, the function returns immediately. The optional ?chain parameter can be used to specify whether to inject on the test chain or the main chain.
Body
Parameters
asyncstringquerychainstringqueryA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerInject a protocol in node. Returns the ID of the protocol. If ?async is true, the function returns immediately. Otherwise, the protocol will be validated before the result is returned.
Body
The environment a protocol relies on and the components a protocol is made of.
expected_env_versionprotocol.environment_version[0, 65535]requiredcomponentsArray<object>requiredParameters
asyncstringqueryResponse
Valid response
Authorization
api-keyAuthapiKey in headerMonitor
Monitor every chain creation and destruction. Currently active chains will be given as first elements
Response
Valid response
Authorization
api-keyAuthapiKey in headerMonitor all blocks that are successfully applied and stored by the node, disregarding whether they were selected as the new head or not.
Parameters
protocolstringqueryProtocol_hash (Base58Check-encoded)
next_protocolstringqueryProtocol_hash (Base58Check-encoded)
chainstringqueryA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerWait for the node to have synchronized its chain with a few peers (configured by the node's administrator), streaming head updates that happen during the bootstrapping process, and closing the stream at the end. If the node was already bootstrapped, returns the current head immediately.
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: use version instead.
Response
Valid response
Authorization
api-keyAuthapiKey in headerMonitor all blocks that are successfully validated and applied by the node and selected as the new head of the given chain.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
protocolstringqueryProtocol_hash (Base58Check-encoded)
next_protocolstringqueryProtocol_hash (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerMonitor all economic protocols that are retrieved and successfully loaded and compiled by the node.
Response
Valid response
Authorization
api-keyAuthapiKey in headerMonitor all blocks that were successfully validated by the node but are not applied nor stored yet, disregarding whether they are going to be selected as the new head or not.
Parameters
protocolstringqueryProtocol_hash (Base58Check-encoded)
next_protocolstringqueryProtocol_hash (Base58Check-encoded)
chainstringqueryA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerNetwork
List the running P2P connection.
Response
Valid response
Authorization
api-keyAuthapiKey in headerDetails about the current P2P connection to the given peer.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Clear all greylists tables. This will unban all addresses and peers automatically greylisted by the system. Use DELETE /network/greylist instead
Response
Valid response
Authorization
api-keyAuthapiKey in headerReturns an object that contains a list of IP and the field "not_reliable_since". If the field "not_reliable_since" is None then the list contains the currently greylisted IP addresses. If the field "not_reliable_since" Contains a date, this means that the greylist has been overflowed and it is no more possible to obtain the exact list of greylisted IPs. Since the greylist of IP addresses has been design to work whatever his size, there is no security issue related to this overflow. Reinitialize the ACL structure by calling "delete /network/greylist" to get back this list reliable.
Response
Valid response
Authorization
api-keyAuthapiKey in headerList of the last greylisted peers.
Response
Valid response
Authorization
api-keyAuthapiKey in headerStream of all network events
Response
Valid response
Authorization
api-keyAuthapiKey in headerList the peers the node ever met.
Parameters
filterstringqueryResponse
Valid response
Authorization
api-keyAuthapiKey in headerDetails about a given peer.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Blacklist the given peer and remove it from the whitelist if present. Use PATCH network/peers/<peer_id> instead.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerCheck if a given peer is blacklisted or greylisted.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerMonitor network events related to a given peer.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
monitorstringqueryResponse
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Whitelist a given peer permanently and remove it from the blacklist if present. The peer cannot be blocked (but its host IP still can). Use PATCH network/peers/<peer_id> instead.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Remove the given peer from the blacklist. Use PATCH network/peers/<peer_id> instead.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Remove a given peer from the whitelist. Use PATCH network/peers/<peer_id> instead.
Parameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerList the pool of known IP:port used for establishing P2P connections.
Parameters
filterstringqueryResponse
Valid response
Authorization
api-keyAuthapiKey in headerDetails about a given IP:addr.
Parameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Blacklist the given address and remove it from the whitelist if present. Use PATCH /network/point/<point_id> instead.
Parameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
Response
Valid response
Authorization
api-keyAuthapiKey in headerCheck if a given address is blacklisted or greylisted. Port component is unused.
Parameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
Response
Valid response
Authorization
api-keyAuthapiKey in headerMonitor network events related to an IP:addr.
Parameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
monitorstringqueryResponse
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Trust a given address permanently and remove it from the blacklist if present. Connections from this address can still be closed on authentication if the peer is greylisted. Use PATCH/network/point/<point_id> instead.
Parameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Remove an address from the blacklist. Use PATCH /network/point/<point_id> instead.
Parameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: Remove an address from the whitelist. Use PATCH /network/point/<point_id> instead.
Parameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
Response
Valid response
Authorization
api-keyAuthapiKey in headerReturn the node's peer id
Response
Valid response
Authorization
api-keyAuthapiKey in headerGlobal network bandwidth statistics in B/s.
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: use version instead.
Response
Valid response
Authorization
api-keyAuthapiKey in headerDEPRECATED: use version instead.
Response
Valid response
Authorization
api-keyAuthapiKey in headerdefault
Change the permissions of a given peer. With {acl: ban}: blacklist the given peer and remove it from the whitelist if present. With {acl: open}: removes the peer from the blacklist and whitelist. With {acl: trust}: trust the given peer permanently and remove it from the blacklist if present. The peer cannot be blocked (but its host IP still can).
Body
aclstringopentrustbanParameters
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerChange the connectivity state of a given IP:addr. With {acl : ban}: blacklist the given address and remove it from the whitelist if present. With {acl: open}: removes an address from the blacklist and whitelist. With {acl: trust}: trust a given address permanently and remove it from the blacklist if present. With {peer_id: <id>} set the peerId of the point. Connections from this address can still be closed on authentication if the peer is greylisted.
Body
aclstringopentrustbanpeer_idstring | objectParameters
pointstringrequiredpathA network point (ipv4:port or [ipv6]:port).
Response
Valid response
Authorization
api-keyAuthapiKey in headerStats
Gets stats from the OCaml Garbage Collector
Response
Valid response
Authorization
api-keyAuthapiKey in headerGets memory usage stats
Response
Valid response
Authorization
api-keyAuthapiKey in headerVersion
Get information on the node version
Response
Valid response
Authorization
api-keyAuthapiKey in headerWorkers
Introspect the state of the block_validator worker.
Response
Valid response
Authorization
api-keyAuthapiKey in headerLists the chain validator workers and their status.
Response
Valid response
Authorization
api-keyAuthapiKey in headerIntrospect the state of a chain validator worker.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerIntrospect the state of the DDB attached to a chain validator worker.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerLists the peer validator workers and their status.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in headerIntrospect the state of a peer validator worker.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
peer_idstringrequiredpathA cryptographic node identity (Base58Check-encoded)
Response
Valid response
Authorization
api-keyAuthapiKey in headerLists the Prevalidator workers and their status.
Response
Valid response
Authorization
api-keyAuthapiKey in headerIntrospect the state of prevalidator workers.
Parameters
chain_idstringrequiredpathA chain identifier. This is either a chain hash in Base58Check notation or a one the predefined aliases: 'main', 'test'.
Response
Valid response
Authorization
api-keyAuthapiKey in header