API docs by Redocly

tari_indexer (0.33.2)

Download OpenAPI specification:

License: BSD-3-Clause

The Tari indexer implementation

handlers::epoch_checkpoints

list_epoch_checkpoints

List epoch checkpoints from storage

query Parameters
from_epoch
integer <int64> >= 0

Epoch to start listing from (inclusive). Defaults to 0

limit
integer <int32> >= 0

Maximum number of checkpoints to return (default: 20, max: 100)

Responses

Response samples

Content type
application/json
{
  • "checkpoints": [
    ]
}

get_latest_epoch_checkpoint

Get the latest epoch checkpoint

Responses

Response samples

Content type
application/json
{
  • "checkpoint": { }
}

handlers::misc

get_epoch_manager_stats

Get epoch manager stats

Responses

Response samples

Content type
application/json
{
  • "current_block_hash": "string",
  • "current_block_height": 0,
  • "current_epoch": 0
}

get_identity

Get indexer network identity information

Responses

Response samples

Content type
application/json
{
  • "peer_id": "string",
  • "public_addresses": [
    ],
  • "public_key": "string"
}

wait_until_ready

Request will return an empty result when the indexer is ready to serve requests. This may take an indefinite amount of time after startup.

handlers::indexer_events

sse_events

SSE events

handlers::network

get

Get network info

get_connections

Get active peer connections

Responses

Response samples

Content type
application/json
{
  • "connections": [
    ]
}

get_network_sync_stats

Get network sync stats

Responses

Response samples

Content type
application/json
{
  • "network_desc": {
    },
  • "sync_progress": { },
  • "validators": [
    ]
}

handlers::nfts

get_non_fungibles

Get non-fungibles by resource address

Request Body schema: application/json
required
address
required
string
end_index
required
integer <int64> >= 0
start_index
required
integer <int64> >= 0

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "end_index": 0,
  • "start_index": 0
}

Response samples

Content type
application/json
{
  • "non_fungibles": [
    ]
}

handlers::resources

get_tari

Fetches the TARI resource

Responses

Response samples

Content type
application/json
{
  • "resource": { },
  • "total_supply": "string",
  • "version": 0
}

get_resource

Fetches a resource by ID

Responses

Response samples

Content type
application/json
{
  • "resource": { },
  • "total_supply": "string",
  • "version": 0
}

handlers::substates

fetch_substates

Fetches several substates by their IDs

Responses

Response samples

Content type
application/json
{
  • "substates": {
    }
}

get_substate

Fetches a substate by ID

path Parameters
substate_id
required
string

The substate ID to fetch

query Parameters
local_search_only
required
boolean

If true, only search local storage for the substate

version
integer <int32> >= 0

Minimum version of the substate to fetch

Responses

Response samples

Content type
application/json
{
  • "substate": { },
  • "version": 0
}

handlers::templates

list_cached_templates

List all template cached by this indexer

query Parameters
limit
integer <int32> >= 0

Limit the number of results returned

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

list_template_catalogue

List templates discovered on the network via the template catalogue

query Parameters
name_filter
string

Substring filter on template name

limit
integer <int64> >= 0

Maximum entries to return (default: 20, max: 100)

after
string

Cursor: return entries inserted after the row with this template address. Omit to start from the beginning

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

get_template_catalogue_entry

Get a single template catalogue entry by its address

Responses

Response samples

Content type
application/json
{
  • "at_epoch": 0,
  • "author_public_key": "string",
  • "binary_hash": "string",
  • "metadata_hash": "string",
  • "template_address": "string",
  • "template_name": "string"
}

get_template_definition

Fetch a template definition by its address

Responses

Response samples

Content type
application/json
{
  • "code_size": 0,
  • "definition": { },
  • "name": "string"
}

handlers::transaction_receipts

get_transaction_receipt

Get the transaction receipt by transaction ID

Responses

Response samples

Content type
application/json
{
  • "receipt": { }
}

list_transaction_receipts

List transaction receipts

Responses

Response samples

Content type
application/json
{
  • "receipts": [
    ]
}

handlers::transactions

submit_transaction

Submit a transaction to validators responsible for the involved shards

Responses

Response samples

Content type
application/json
{
  • "transaction_id": "string"
}

submit_transaction_dry_run

Submit a transaction as a dry-run

Responses

Response samples

Content type
application/json
{
  • "result": { },
  • "transaction_id": "string"
}

list_recent_transactions

List recent transactions

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

get_transaction

Get a transaction (including its instructions, fee instructions and signatures) by transaction ID.

NOTE: This only returns transactions that were submitted through this indexer; it reads from the indexer's local transaction store and is not synced from the network. A transaction submitted via a different indexer or wallet will return 404 here even after it has been finalized. This differs from transaction receipts (see the /transaction-receipts endpoints), which are synced from the network. For the execution result of any transaction regardless of where it was submitted, use /transactions/{transaction_id}/result.

Responses

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

get_transaction_result

Get the result of a submitted transaction (by transaction ID)

Responses

Response samples

Content type
application/json
{
  • "result": { }
}

handlers::transaction_events

sse_transaction_events

SSE stream of template-emitted transaction events. Supports catch-up via the after_id query parameter or Last-Event-ID header.

query Parameters
topic
string

Filter by event topic

substate_id
string

Filter by substate ID

template_address
string

Filter by template address

resource_address
string

Filter by resource address (derived from substate_id for std.resource.* events, or from the resource_address payload entry for std.vault.deposit / std.vault.withdraw)

after_id
integer <int64>

Resume from this event ID (exclusive)

handlers::utxos

list_utxos

List full UTXO data

Responses

Response samples

Content type
application/json
{
  • "utxos": [
    ]
}

fetch_utxos

Gets full UTXO data for a list of UTXO IDs

Request Body schema: application/json
required
resource_address
required
string
required
Array of items

Responses

Request samples

Content type
application/json
{
  • "resource_address": "string",
  • "tag_and_nonce_pairs": [
    ]
}

Response samples

Content type
application/json
{
  • "utxos": [
    ]
}

stream_utxo_updates

Streams UTXO updates

Request Body schema: application/json
required
from_epoch
integer <int64> >= 0
per_shard_limit
required
integer <int32> >= 0
resource_address
required
string
required
Array of items
unspent_only
boolean

Responses

Request samples

Content type
application/json
{
  • "from_epoch": 0,
  • "per_shard_limit": 0,
  • "resource_address": "string",
  • "shard_state_versions": [
    ],
  • "unspent_only": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}