sl.index

Callable: index.ftTransfers(params) ≡ index.ftTransfers.list(params).

Read one page of fungible-token transfers, plus the cursor for the next.

Filter by contractId, assetIdentifier, sender, recipient, and a height range. Filters are equality only: there is no amount filter. order: "desc" reads newest first. Pass next_cursor back as cursor to continue. fields returns only those columns and narrows the row type; cursor, block_height, and event_type always come back. reorgs on the envelope lists forks that overlap the page.

Iterate every fungible-token transfer, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip, or with order: "desc" when it reaches fromHeight (genesis by default). batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Callable: index.nftTransfers(params) ≡ index.nftTransfers.list(params).

Read one page of NFT transfers, plus the cursor for the next.

Filter by contractId, assetIdentifier, sender, recipient, and a height range. order: "desc" reads newest first. Pass next_cursor back as cursor to continue. fields returns only those columns and narrows the row type; cursor, block_height, and event_type always come back.

Iterate every NFT transfer, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip, or with order: "desc" when it reaches fromHeight (genesis by default). batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Generic decoded events by event_type (the full /v1/index/events surface). Callable: index.events(params) ≡ index.events.list(params).

Read one page of decoded events of one type.

eventType is required: a decoded type (ft_transfer, print, ...) or a VM type (nested_contract_call, map_set, ...), and a literal narrows the row type. Scope with contractId (one id or up to 20) or trait, never both, plus assetIdentifier, sender, recipient, functionName, caller, map, varName, txId, and a height range. order: "desc" reads newest first. txContext: true joins the submitting transaction onto each event. fields returns only those columns and narrows the row type; it saves wire bytes but does not change what you are billed, since rows are metered, not columns.

Iterate every decoded event of one type, paging for you.

Takes the same filters as list, including eventType. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip, or with order: "desc" when it reaches fromHeight (genesis by default). batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Run a checkpointed, reorg-aware indexer over decoded events.

Write your rows in onBatch and commit ctx.cursor in the same transaction; resume with fromCursor. Without fromCursor or fromHeight the API serves only its recent default window, so pass fromHeight: 0 for a full backfill. A reorg at or below your checkpoint calls onReorg, then the loop re-reads from the fork point. Delivery is at-least-once, so keep writes idempotent. With a sink, the checkpoint and rollback are handled for you. finalizedOnly holds delivery to finalized rows, so no reorg handling is needed. mode: "tail" (default) keeps polling at the tip; mode: "bounded" returns on the first empty page. Resolves to { cursor, pages, emptyPolls }.

Read one page of decoded contract calls.

Filter by contractId (one id or up to 20) or trait, never both, plus functionName, sender, and a height range. Each row has the function name, arguments, result, and status. Pass next_cursor back as cursor to continue.

Iterate every decoded contract call, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Run a checkpointed, reorg-aware indexer over contract calls.

Write your rows in onBatch and commit ctx.cursor in the same transaction; resume with fromCursor. Without fromCursor or fromHeight the API serves only its recent default window, so pass fromHeight: 0 for a full backfill. A reorg at or below your checkpoint calls onReorg, then the loop re-reads from the fork point. Delivery is at-least-once, so keep writes idempotent. With a sink, the checkpoint and rollback are handled for you. finalizedOnly holds delivery to finalized rows, so no reorg handling is needed. mode: "tail" (default) keeps polling at the tip; mode: "bounded" returns on the first empty page. Resolves to { cursor, pages, emptyPolls }. Calls already carry sender and function_name, so there is no txContext.

Read one page of the canonical block-hash map.

Each row is a block's hash, its parent hash, and its burn-chain anchor. Compare it with your own tables to confirm you follow the current chain.

Iterate every canonical block hash, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Read one page of the contract-state writes each block committed.

Rows are the exact key and value writes, in the node's write order (ordinal), so you can see which key a transaction changed when events alone do not show it. Filter by blockHeight (excludes fromHeight and toHeight) or contractId. txContext: true joins the writing transaction. Rows exist only from the height your node first subscribed to state writes.

Iterate every state write, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Read one page of canonical blocks.

Each block has its hash, parent hash, burn-chain anchor, and block_time. Filter by a height range.

Iterate every canonical block, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Get one block by height or hash, or null.

Resolves to null when no such block exists (404).

Read one page of full transaction documents.

Filter by type, sender, contractId, and a height range. Each document has the decoded post conditions and the payload for its tx_type; enrichment fields are null when the raw transaction cannot be decoded. fields returns only those columns and narrows the row type; cursor, block_height, and tx_id always come back.

Iterate every transaction document, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Get one transaction by id, or null.

Resolves to null when the transaction is not found (404).

Get a transaction's inclusion proof, or null.

The proof is the raw transaction, the Nakamoto block header, and the merkle path. Check it yourself with verifyTransactionProof; nothing in it needs to be trusted. Resolves to null on 404. A 503 (PROOF_TX_SET_INCOMPLETE or PROOF_NODE_UNAVAILABLE) throws an ApiError: the proof cannot be assembled on this deployment right now.

Read one page of decoded PoX-4 stacking actions.

One row per stacking contract call. Filter by functionName, stacker, caller, and a height range. The feed is empty, with a notes hint, when the instance's PoX-4 decoder is disabled. For the current PoX, use pox5.events and pox.cycles.

Iterate every PoX-4 stacking action, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Read one page of pending, unconfirmed transactions.

Filter by sender, type, contractId, and functionName. There is no height filter: rows carry received_at and a sequence cursor instead of a block position.

Iterate every pending transaction, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Get one pending transaction, or null.

Resolves to null once the transaction has confirmed or dropped.

Read one page of completed sBTC deposits.

Filter by sender, bitcoinTxid, and a height range. confirmed: true keeps only deposits past the finality boundary. fields returns only those columns and narrows the row type; cursor and block_height always come back.

Iterate every completed sBTC deposit, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Run a checkpointed, reorg-aware indexer over completed deposits.

Deposits are append-only, so they are safe to mirror. See IndexConsumeOptions.

Fetch a completed deposit by Bitcoin txid; 404 → null.

Read one page of sBTC withdrawals, each with its current status.

Filter by status (REQUESTED, ACCEPTED, REJECTED), sender, requestId, settlementConfirmed, and a height range. A row changes as the peg-out moves along, which is why withdrawals have no consume. fields returns only those columns and narrows the row type; cursor and request_id always come back.

Iterate every sBTC withdrawal, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.

Fetch a withdrawal's full lifecycle by request id; 404 → null.

Read one page of the raw sBTC peg event log.

Filter by topic, sender, requestId, bitcoinTxid, and a height range. confirmed: true keeps only events past the finality boundary.

Iterate every sBTC peg event, paging for you.

Takes the same filters as list. Not a live index: it does not checkpoint, ignores reorgs, and ends when it catches the tip. batchSize defaults to 200 (max 1000); page fetches retry on 429 and 5xx; aborting signal rejects the iterator.