API docs by Redocly

Oasis Nexus API V1 (0.1.0)

Download OpenAPI specification:Download

An API for accessing indexed data from the Oasis Network.

Endpoints

Returns the status of indexing.

Responses

Response samples

Content type
application/json
{
  • "latest_block": 8048956,
  • "latest_node_block": 8049555,
  • "latest_block_time": "2019-04-01T00:00:00Z",
  • "latest_update_age_ms": 352
}

Returns the total supply of the consensus layer token.

Responses

Response samples

Content type
text/plain
42

Returns the circulating supply of the consensus layer token.

Responses

Response samples

Content type
text/plain
42

Returns a list of consensus blocks, sorted from most to least recent.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

from
integer <int64>
Example: from=8048956

A filter on minimum block height, inclusive.

to
integer <int64>
Example: to=8049555

A filter on maximum block height, inclusive.

after
string <date-time>
Example: after=2022-03-01T00:00:00Z

A filter on minimum block time, inclusive.

before
string <date-time>
Example: before=2019-04-01T00:00:00Z

A filter on maximum block time, exclusive.

hash
string
Example: hash=0a29ac21fa69bb9e43e5cb25d10826ff3946f1ce977e82f99a2614206a50765c

A filter on the block hash.

proposed_by
string^oasis1[a-z0-9]{40}$
Example: proposed_by=oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

A filter on the proposer of the block.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "blocks": [
    ]
}

Returns a consensus block.

path Parameters
height
required
integer <int64>
Example: 8048956

The block height of the block to return.

Responses

Response samples

Content type
application/json
{
  • "height": 8048956,
  • "hash": "0a29ac21fa69bb9e43e5cb25d10826ff3946f1ce977e82f99a2614206a50765c",
  • "timestamp": "2022-03-01T00:00:00Z",
  • "num_transactions": 17,
  • "gas_limit": "1234567890123456789012",
  • "size_limit": "1234567890123456789012",
  • "epoch": 13402,
  • "state_root": "8e39bf193f8a954ab8f8d7cb6388c591fd0785ea060bbd8e3752e266b54499d3",
  • "proposer": {
    },
  • "signers": [
    ]
}

Returns a list of consensus transactions.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

block
integer <int64>
Example: block=8048956

A filter on block height.

method
Array of strings
Items Enum: "beacon.PVSSCommit" "beacon.PVSSReveal" "beacon.VRFProve" "consensus.Meta" "governance.CastVote" "governance.SubmitProposal" "keymanager.PublishEphemeralSecret" "keymanager.PublishMasterSecret" "keymanager.UpdatePolicy" "registry.DeregisterEntity" "registry.ProveFreshness" "registry.RegisterEntity" "registry.RegisterNode" "registry.RegisterRuntime" "registry.UnfreezeNode" "roothash.Evidence" "roothash.ExecutorCommit" "roothash.ExecutorProposerTimeout" "roothash.SubmitMsg" "staking.AddEscrow" "staking.Allow" "staking.AmendCommissionSchedule" "staking.Burn" "staking.ReclaimEscrow" "staking.Transfer" "staking.Withdraw" "keymanager/churp.Apply" "keymanager/churp.Confirm" "keymanager/churp.Create" "keymanager/churp.Update" "vault.AuthorizeAction" "vault.CancelAction" "vault.Create"
Example: method=staking.Transfer

A filter on transaction method.

sender
string^oasis1[a-z0-9]{40}$
Example: sender=oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

A filter on transaction sender.

rel
string
Example: rel=oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

A filter on related accounts.

after
string <date-time>
Example: after=2022-03-01T00:00:00Z

A filter on minimum transaction time, inclusive.

before
string <date-time>
Example: before=2019-04-01T00:00:00Z

A filter on maximum transaction time, exclusive.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "transactions": [
    ]
}

Returns consensus transactions with the given transaction hash.

path Parameters
tx_hash
required
string
Example: 0d0531d6b8a468c07440182b1cdda517f5a076d69fb2199126a83082ecfc0f41

The transaction hash of the transaction(s) to return. This endpoint can return multiple transactions in cases, where an already processed transaction is re-sent. In such cases only a single transaction will be successfully processed, others will have a failed status (e.g. 'Invalid nonce').

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "transactions": [
    ]
}

Returns a list of consensus events.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

block
integer <int64>
Example: block=8048956

A filter on block height.

tx_index
integer <int32>
Example: tx_index=3

A filter on transaction index. The returned events all need to originate from a transaction that appeared in tx_index-th position in the block. It is invalid to specify this filter without also specifying a block. Specifying tx_index and block is an alternative to specifying tx_hash; either works to fetch events from a specific transaction.

tx_hash
string
Example: tx_hash=0d0531d6b8a468c07440182b1cdda517f5a076d69fb2199126a83082ecfc0f41

A filter on the hash of the transaction that originated the events. Specifying tx_index and block is an alternative to specifying tx_hash; either works to fetch events from a specific transaction.

rel
string^oasis1[a-z0-9]{40}$
Example: rel=oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

A filter on related accounts. Every returned event will refer to this account. For example, for a Transfer event, this will be the the sender or the recipient of tokens.

type
string
Enum: "governance.proposal_executed" "governance.proposal_finalized" "governance.proposal_submitted" "governance.vote" "registry.entity" "registry.node_unfrozen" "registry.node" "registry.runtime" "registry.runtime_suspended" "roothash.execution_discrepancy" "roothash.executor_committed" "roothash.finalized" "roothash.message" "roothash.in_msg_processed" "staking.allowance_change" "staking.burn" "staking.escrow.add" "staking.escrow.debonding_start" "staking.escrow.reclaim" "staking.escrow.take" "staking.transfer"
Example: type=staking.escrow.take

A filter on the event type.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "events": [
    ]
}

/consensus/roothash_messages

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"
round
integer <int64>
type
string
Enum: "staking.transfer" "staking.withdraw" "staking.add_escrow" "staking.reclaim_escrow" "registry.update_runtime" "governance.cast_vote" "governance.submit_proposal"
Example: type=staking.transfer
rel
string^oasis1[a-z0-9]{40}$
Example: rel=oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

An Oasis-style (bech32) address.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "roothash_messages": [
    ]
}

Returns a list of entities registered at the consensus layer.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "entities": [
    ]
}

Returns an entity registered at the consensus layer.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The address of the entity to return.

Responses

Response samples

Content type
application/json
{
  • "id": "gb8SHLeDc69Elk7OTfqhtVgE2sqxrBCDQI84xKR+Bjg=",
  • "address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
  • "nodes": [
    ]
}

Returns a list of nodes registered at the consensus layer.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The address of the controlling entity of the nodes to return.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "entity_id": "string",
  • "nodes": [
    ]
}

Returns a node registered at the consensus layer.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The entity ID of the entity controlling the node to return.

node_id
required
string <byte>
Example: lbxs4hlud9XNloIOdhJPaCahd7HtiY8QATCgGnFfCM0=

The node ID of the node to return.

Responses

Response samples

Content type
application/json
{
  • "id": "lbxs4hlud9XNloIOdhJPaCahd7HtiY8QATCgGnFfCM0=",
  • "entity_id": "gb8SHLeDc69Elk7OTfqhtVgE2sqxrBCDQI84xKR+Bjg=",
  • "expiration": 0,
  • "tls_pubkey": "string",
  • "tls_next_pubkey": "string",
  • "p2p_pubkey": "string",
  • "consensus_pubkey": "string",
  • "roles": "string"
}

Returns a list of validators registered at the consensus layer (the list includes all registered entities, even those without a currently active validator node).

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

name
string

A filter on the validator name. Every returned validator will have a name that is a superstring of the input param.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "validators": [
    ],
  • "stats": {
    }
}

Returns a validator registered at the consensus layer.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The address of the entity to return.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "validators": [
    ],
  • "stats": {
    }
}

Returns historical information for a single validator.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The address of the entity to return.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

from
integer <int64>
Example: from=13402

A filter on minimum epoch number, inclusive.

to
integer <int64>
Example: to=13403

A filter on maximum epoch number, inclusive.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
  • "history": [
    ]
}

Returns a list of consensus layer accounts. Note that for performance reasons, the info returned by this endpoint may be slightly stale (<2 minutes). For the most up-to-date account state, query the single-account endpoint.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "accounts": [
    ]
}

Returns a consensus layer account.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The staking address of the account to return.

Responses

Response samples

Content type
application/json
{
  • "address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
  • "nonce": 0,
  • "available": "1234567890123456789012",
  • "escrow": "1234567890123456789012",
  • "debonding": "1234567890123456789012",
  • "delegations_balance": 10000000000,
  • "debonding_delegations_balance": 10000000000,
  • "first_activity": "2022-03-01T00:00:00Z",
  • "allowances": [
    ],
  • "stats": {
    }
}

Returns an account's delegations.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The staking address of the account that delegated.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "delegations": [
    ]
}

Returns a list of delegations to an account.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The staking address of the account that is being delegated to.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "delegations": [
    ]
}

Returns an account's debonding delegations.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The staking address of the account that delegated.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "debonding_delegations": [
    ]
}

Returns a list of debonding delegations to an account.

path Parameters
address
required
string^oasis1[a-z0-9]{40}$
Example: oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

The staking address of the that is being delegated to.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "debonding_delegations": [
    ]
}

Returns a list of consensus epochs.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "epochs": [
    ]
}

Returns a consensus epoch.

path Parameters
epoch
required
integer <int64>
Example: 13402

The epoch number of the epoch to return.

Responses

Response samples

Content type
application/json
{
  • "id": 13402,
  • "start_height": 8048956,
  • "end_height": 8049555
}

Returns a list of governance proposals.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

submitter
string^oasis1[a-z0-9]{40}$
Example: submitter=oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p

Filter on the submitter of the proposal.

state
string
Enum: "active" "passed" "failed" "rejected"
Example: state=active

Filter on the state of the proposal.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "proposals": [
    ]
}

Returns a governance proposal.

path Parameters
proposal_id
required
integer <uint64>
Example: 1

The unique identifier of the proposal to return.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "submitter": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
  • "state": "active",
  • "deposit": "1234567890123456789012",
  • "title": "string",
  • "description": "string",
  • "handler": "string",
  • "target": {
    },
  • "epoch": 13402,
  • "cancels": 0,
  • "parameters_change_module": "string",
  • "parameters_change": "{\"min_validators\":null,\"max_validators\":\"120\",\"voting_power_distribution\":null}",
  • "created_at": 13402,
  • "closes_at": 13403,
  • "invalid_votes": "1234567890123456789012"
}

Returns a list of votes for a governance proposal.

path Parameters
proposal_id
required
integer <uint64>
Example: 1

The unique identifier of the proposal for which votes are returned.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "proposal_id": 0,
  • "votes": [
    ]
}

Returns a list of Runtime blocks.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

from
integer <int64>
Example: from=8048956

A filter on minimum block height, inclusive.

to
integer <int64>
Example: to=8049555

A filter on maximum block height, inclusive.

after
string <date-time>
Example: after=2022-03-01T00:00:00Z

A filter on minimum block time, inclusive.

before
string <date-time>
Example: before=2019-04-01T00:00:00Z

A filter on maximum block time, exclusive.

hash
string
Example: hash=0a29ac21fa69bb9e43e5cb25d10826ff3946f1ce977e82f99a2614206a50765c

A filter on the block hash.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "blocks": [
    ]
}

Returns a list of Runtime transactions.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

block
integer <int64>
Example: block=3283246

A filter on block round.

after
string <date-time>
Example: after=2022-03-01T00:00:00Z

A filter on minimum transaction time, inclusive.

before
string <date-time>
Example: before=2019-04-01T00:00:00Z

A filter on maximum transaction time, exclusive.

rel
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • rel=0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • rel=oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

A filter on related accounts. Every returned transaction will refer to this account in a way. For example, for an accounts.Transfer tx, this will be the sender or the recipient of tokens. Nexus detects related accounts inside EVM transactions and events on a best-effort basis. For example, it inspects ERC20 methods inside evm.Call txs.

method
Array of strings
Example: method=accounts.Transfer

A filter on the runtime transaction method.

In addition to the existing method names, the following special values are supported:

  • 'native_transfers': Returns transactions "likely to be native transfers".

    • These include accounts.Transfer transactions and evm.Calls with an empty 'body' field.

  • 'evm.Call_no_native': Returns EVM calls that are "not likely to be native transfers".

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "transactions": [
    ]
}

Returns runtime transactions with the given transaction hash.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

tx_hash
required
string
Example: 0d0531d6b8a468c07440182b1cdda517f5a076d69fb2199126a83082ecfc0f41

The transaction hash of the transaction(s) to return. This can be an Ethereum transaction hash; the query will compare against both a transaction's regular tx_hash and eth_tx_hash (if it exists). This endpoint can return multiple transactions in extremely rare cases, e.g. when a hash matches multiple Oasis runtime transactions or both an Oasis runtime transaction and the eth_tx_hash of an evm-transaction.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "transactions": [
    ]
}

Returns a list of runtime events.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

block
integer <int64>
Example: block=3283246

A filter on block round.

tx_index
integer <int32>
Example: tx_index=3

A filter on transaction index. The returned events all need to originate from a transaction that appeared in tx_index-th position in the block. It is invalid to specify this filter without also specifying a block. Specifying tx_index and round is an alternative to specifying tx_hash; either works to fetch events from a specific transaction.

tx_hash
string
Example: tx_hash=0d0531d6b8a468c07440182b1cdda517f5a076d69fb2199126a83082ecfc0f41

A filter on the hash of the transaction that originated the events. Specifying tx_index and round is an alternative to specifying tx_hash; either works to fetch events from a specific transaction. This can be an Ethereum transaction hash; the query will compare against both a transaction's regular tx_hash and eth_tx_hash (if it exists).

type
string
Enum: "accounts.transfer" "accounts.burn" "accounts.mint" "consensus_accounts.deposit" "consensus_accounts.withdraw" "consensus_accounts.delegate" "consensus_accounts.undelegate_start" "consensus_accounts.undelegate_done" "core.gas_used" "evm.log" "rofl.app_created" "rofl.app_updated" "rofl.app_removed" "rofl.instance_registered" "roflmarket.provider_created" "roflmarket.provider_updated" "roflmarket.provider_removed" "roflmarket.instance_created" "roflmarket.instance_updated" "roflmarket.instance_accepted" "roflmarket.instance_cancelled" "roflmarket.instance_removed" "roflmarket.instance_command_queued"
Example: type=consensus_accounts.deposit

A filter on the event type.

rel
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • rel=0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • rel=oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

A filter on related accounts. Every returned event will refer to this account. For example, for a accounts.Transfer event, this will be the sender or the recipient of tokens.

evm_log_signature
string
Example: evm_log_signature=0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef

A filter on the evm log signatures. Note: The filter will only match on parsed (verified) EVM events.

contract_address
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • contract_address=0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • contract_address=oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

A filter on a smart contract. Every returned event will have been emitted by the contract at this address.

nft_id
string
Example: nft_id=999

A filter on NFT events. Every returned event will be specifically about this NFT instance ID. You must specify the contract_address filter with this filter. Currently this only supports ERC-721 Transfer events. This may expand to support other event types in the future. If you want only ERC-721 Transfer events, specify evm_log_signature=ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef to avoid inadvertently getting other event types if they are supported later. Using an evm_log_signature filter with this set to any other value will match no events.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "events": [
    ]
}

Returns a list of EVM (ERC-20, ...) tokens on the runtime.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

name
string

A filter on the name, the name or symbol must contain this value as a substring.

sort_by
string
Enum: "total_holders" "market_cap"

The field to sort the tokens by. If unset, the tokens will be sorted by number of holders.

type
string
Enum: "ERC20" "ERC721"

The type of tokens to return.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "evm_tokens": [
    ]
}

Returns info on an EVM (ERC-20, ...) token on the runtime.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

address
required
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • 0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

The staking address of the token contract.

Responses

Response samples

Content type
application/json
{
  • "contract_addr": "oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys",
  • "eth_contract_addr": 1.2367698861069356e+48,
  • "name": "Uniswap",
  • "symbol": "USDT",
  • "decimals": 18,
  • "type": "ERC20",
  • "total_supply": "1234567890123456789012",
  • "num_transfers": 0,
  • "num_holders": 123,
  • "ref_swap": {
    },
  • "ref_token": {
    },
  • "relative_token_address": "string",
  • "relative_price": 0,
  • "relative_total_value": 0,
  • "is_verified": false,
  • "verification_level": "partial"
}

Returns the list of holders of an EVM (ERC-20, ...) token. This endpoint does not verify that `address` is actually an EVM token; if it is not, it will simply return an empty list.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

address
required
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • 0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

The staking address of the token contract for which to return the holders.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "holders": [
    ]
}

Returns the list of non-fungible token (NFT) instances of an EVM (ERC-721, ...) token. This endpoint does not verify that `address` is actually an EVM token; if it is not, it will simply return an empty list.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

address
required
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • 0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

The staking address of the token contract for which to return the NFT instances.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "evm_nfts": [
    ]
}

Returns the non-fungible token (NFT) instance of an EVM (ERC-721, ...) token.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

address
required
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • 0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

The staking address of the token contract of the NFT instance.

id
required
string <bigint> ^-?[0-9]+$
Example: 1234567890123456789012

The ID of the NFT instance.

Responses

Response samples

Content type
application/json
{
  • "token": {
    },
  • "id": "1234567890123456789012",
  • "owner": "oasis1qpclnnm0wu44pn43mt6vv3me59kl8zk9ty7qyj03",
  • "owner_eth": "0xDEF1009df2d6872C214cd9148c6883893B7c4D91",
  • "num_transfers": 0,
  • "metadata_uri": "string",
  • "metadata_accessed": "string",
  • "metadata": null,
  • "name": "string",
  • "description": "string",
  • "image": "string"
}

Returns a runtime account.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

address
required
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$

The staking address of the account to return.

Responses

Response samples

Content type
application/json
{
  • "address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
  • "address_preimage": {
    },
  • "balances": [
    ],
  • "evm_contract": {
    },
  • "evm_balances": [
    ],
  • "stats": {
    }
}

Returns the list of non-fungible token (NFT) instances owned by an account.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

address
required
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • 0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

The staking address of the owner of the NFT instances.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

token_address
string^oasis1[a-z0-9]{40}$|^(0x)?[0-9a-fA-F]{40}$
Examples:
  • token_address=0xDEF1009df2d6872C214cd9148c6883893B7c4D91 - An Ethereum-compatible address, hex-encoded. Capitalization does not matter.
  • token_address=oasis1qp2hssandc7dekjdr6ygmtzt783k3gn38uupdeys - A native Oasis address, bech32-encoded.

Only return NFT instances from the token contract at the given staking address.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "evm_nfts": [
    ]
}

Returns the runtime status.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

Responses

Response samples

Content type
application/json
{
  • "active_nodes": 42,
  • "latest_block": 8048956,
  • "latest_block_time": "2019-04-01T00:00:00Z",
  • "latest_update_age_ms": 352
}

Returns a list of ROFL apps on the runtime.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "rofl_apps": [
    ]
}

Returns a specific ROFL app.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

id
required
string

The ID of the ROFL app to return.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "admin": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
  • "admin_eth": 1.2367698861069356e+48,
  • "stake": "1234567890123456789012",
  • "policy": { },
  • "sek": "string",
  • "metadata": { },
  • "secrets": { },
  • "removed": true,
  • "date_created": "2022-03-01T00:00:00Z",
  • "last_activity": "2022-03-01T00:00:00Z",
  • "last_activity_tx": {
    },
  • "num_active_instances": 0,
  • "active_instances": [
    ]
}

Returns a list of "managing" transactions of the ROFL app. This does not return transaction submitted by ROFL app instances, for that see the `/rofl_apps/{id}/instance_transactions` endpoint.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

id
required
string

The ID of the ROFL app to return transactions for.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

method
Array of strings
Example: method=accounts.Transfer

A filter on the runtime transaction method.

In addition to the existing method names, the following special values are supported:

  • 'native_transfers': Returns transactions "likely to be native transfers".

    • These include accounts.Transfer transactions and evm.Calls with an empty 'body' field.

  • 'evm.Call_no_native': Returns EVM calls that are "not likely to be native transfers".

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "transactions": [
    ]
}

Returns a list of transactions submitted by instances of the ROFL app.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

id
required
string

The ID of the ROFL app to return transactions for.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

method
Array of strings
Example: method=accounts.Transfer

A filter on the runtime transaction method.

In addition to the existing method names, the following special values are supported:

  • 'native_transfers': Returns transactions "likely to be native transfers".

    • These include accounts.Transfer transactions and evm.Calls with an empty 'body' field.

  • 'evm.Call_no_native': Returns EVM calls that are "not likely to be native transfers".

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "transactions": [
    ]
}

Returns a list of instances of the given ROFL app.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

id
required
string

The ID of the ROFL app to return instances for.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "instances": [
    ]
}

Returns a list of transactions submitted by the given ROFL instance.

path Parameters
runtime
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher"

The runtime which to query.

id
required
string

The ID of the ROFL app to return transactions for.

rak
required
string

The RAK of the ROFL instance to return transactions for.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

method
Array of strings
Example: method=accounts.Transfer

A filter on the runtime transaction method.

In addition to the existing method names, the following special values are supported:

  • 'native_transfers': Returns transactions "likely to be native transfers".

    • These include accounts.Transfer transactions and evm.Calls with an empty 'body' field.

  • 'evm.Call_no_native': Returns EVM calls that are "not likely to be native transfers".

Responses

Response samples

Content type
application/json
{
  • "total_count": 412,
  • "is_total_count_clipped": true,
  • "transactions": [
    ]
}

Returns a timeline of the transaction volume at the chosen granularity, for either consensus or one of the paratimes.

path Parameters
layer
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher" "consensus"

The layer for which to return the transaction volume timeline.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

window_size_seconds
integer <uint32>
Default: 86400

The size of windows into which the statistic is grouped, in seconds. The backend supports a limited number of window sizes: 300 (5 minutes) and 86400 (1 day). Requests with other values may be rejected.

window_step_seconds
integer <uint32>
Default: 86400

The size of the step between returned statistic windows, in seconds. The backend supports a limited number of step sizes: 300 (5 minutes) and 86400 (1 day). Requests with other values may be rejected.

Responses

Response samples

Content type
application/json
{
  • "window_size_seconds": 0,
  • "windows": [
    ]
}

Returns a (sliding) timeline of the recorded daily unique active accounts for either consensus or one of the paratimes.

path Parameters
layer
required
string
Enum: "emerald" "sapphire" "pontusxtest" "pontusxdev" "cipher" "consensus"

The layer for which to return the active accounts timeline.

query Parameters
limit
integer <uint64> [ 1 .. 1000 ]
Default: 100

The maximum numbers of items to return.

offset
integer <uint64>
Default: 0

The number of items to skip before starting to collect the result set.

window_step_seconds
integer <uint32>
Default: 86400

The size of the step between returned statistic windows, in seconds. The backend supports a limited number of step sizes: 300 (5 minutes) and 86400 (1 day). Requests with other values may be rejected.

Responses

Response samples

Content type
application/json
{
  • "window_size_seconds": 0,
  • "windows": [
    ]
}