Queries

Queries

Every chain read: one page per query, generated from the SDK.

View as Markdown

Reads are free, unsigned, and safe to call at any time. Each CLI command is btcli query <name> (add --json for machine-readable output); in Python use await client.read("<name>", ...). The machine-readable catalog is at /catalog/reads.json or via sub.reads.list_reads().

Accounts & keys

QuerySummary
balanceFree TAO balance of a coldkey address.
balancesFree TAO balance for several coldkey addresses in one batched request.
coldkey-swap-announcementA coldkey's pending swap announcement (execute block, new-key hash, disputed), or None.
existential-depositMinimum balance an account must keep to stay alive.
multisigA pending multisig operation (opening timepoint, approvals, depositor), or None.
proxiesProxy delegations of an account: who may sign on its behalf, and the reserved deposit.

Chain

QuerySummary
block-infoA block's hash, timestamp, and extrinsics (as module.function summaries).
block-timeSeconds per block, detected from the chain (12.0 mainnet, 0.25 fast-blocks).
is-fast-blocksWhether the chain runs fast blocks (0.25s slots, local/e2e testing mode).
mev-shield-next-keyThe MEV Shield ML-KEM-768 public key (0x-hex) used to encrypt shielded txs, or None.
timestampCurrent chain time (from the Timestamp pallet) and the block it was read at.
tx-rate-limitGlobal transaction rate limit in blocks.

Delegation

QuerySummary
childrenChild hotkeys of a parent on a subnet, as (proportion, child_ss58) pairs.
delegateDelegate info for one hotkey, or None if it is not a delegate.
delegate-takeA hotkey's delegate take (emission fraction it keeps) with the allowed min/max.
delegatedEvery nomination a coldkey holds: (delegate, netuid, stake) per position.
delegatesEvery delegate hotkey on the network, with take and registrations.
is-delegateWhether a hotkey is a delegate.
parentsParent hotkeys of a child on a subnet, as (proportion, parent_ss58) pairs.
pending-childrenProposed child hotkeys of a parent still in cooldown, and when they apply.

Epochs & timing

QuerySummary
blocks-since-last-stepBlocks since the subnet's last epoch step ran.
blocks-since-last-updateBlocks since a neuron last set or committed weights on a subnet
blocks-until-next-epochBlocks until the subnet's next epoch fires, or None if tempo is 0.
epoch-statusWhere a subnet is in its epoch cycle, in one block-pinned read.
next-epoch-start-blockBlock at which the subnet's next epoch is expected to fire, or None if tempo is 0.

Hyperparameters

QuerySummary
difficultyCurrent PoW registration difficulty for a subnet.
immunity-periodBlocks a newly registered neuron is immune from deregistration.
max-weight-limitNormalized-fraction cap on any single weight: after the chain normalizes the submitted vector, no weight may exceed max_weight_limit/65535 of the total. Not a raw u16 ceiling per weight.
min-allowed-weightsMinimum number of weights a validator must set on a subnet. A pure self-weight (a single entry pointing at the caller's own uid) bypasses the minimum, and the subnet owner bypasses validator-permit rules.
reveal-periodCommit-reveal reveal window, in epochs, for a subnet.
weights-rate-limitBlocks a hotkey must wait between weight sets on a subnet.

Identity & commitments

QuerySummary
commitmentThe commitment a hotkey has published on a subnet, or None.
commitmentsEvery commitment on a subnet, newest first: hotkey, uid, content, block, age, reveal state.
hotkey-identitiesOn-chain identities for hotkeys (via each hotkey's owner coldkey), keyed by hotkey.
identityThe on-chain identity of a coldkey (name, links, description), or None.
revealed-commitmentThe revealed (timelock-decrypted) commitment for a hotkey on a subnet, or None.

Leases & crowdloans

QuerySummary
crowdloanA crowdloan's state (creator, deposit, raised, cap, end, target/call), or None.
crowdloan-contributorsContributors and amounts for a crowdloan, with amounts in TAO.
crowdloansAll crowdloans on chain (id and summary fields).
leaseA subnet lease by id (beneficiary, emissions share, end block, netuid, cost), or None.
leasesEvery subnet lease on the network.

Locks & conviction

QuerySummary
coldkey-lockLock state for a coldkey on a subnet, or None if no lock exists.
hotkey-convictionConviction metrics for a hotkey on a subnet.
locks-for-coldkeyEvery lock a coldkey holds (one per subnet), rolled forward to now.
most-convicted-hotkeyHotkey with the highest conviction on a subnet, if any.
subnet-convictionsEvery hotkey with locked stake on a subnet, rolled forward to now.

Neurons & registration

QuerySummary
associated-evm-keyThe EVM address associated with a neuron (by netuid + uid) and the block it was set.
hotkey-ownerThe coldkey that owns a hotkey, or None if unowned.
netuids-for-hotkeyEvery subnet a hotkey is registered on, as a sorted list of netuids.
neuronsEvery neuron on a subnet in ONE runtime-API call (the metagraph fast path).
owned-hotkeysEvery hotkey owned by a coldkey (the reverse of hotkey_owner).
uidUID of a hotkey on a subnet, or None if not registered there.

Prices & swaps

QuerySummary
alpha-priceCurrent spot alpha price for a subnet, as TAO per alpha.
alpha-pricesSpot alpha price for every subnet, as TAO per alpha keyed by netuid.
quote-stakeSimulate staking amount_tao TAO into a subnet: alpha out, fee, and slippage.
quote-unstakeSimulate unstaking amount_alpha alpha from a subnet: TAO out, fee, and slippage.

Staking

QuerySummary
auto-stakeThe hotkey a coldkey auto-stakes its rewards to on a subnet, or None if unset.
auto-stake-allEvery auto-stake destination configured for a coldkey.
root-claim-typeHow a coldkey claims root alpha emission: Swap, Keep, or KeepSubnets(+subnets).
stakeAlpha staked by a coldkey to a hotkey on a subnet (TAO when netuid is 0).
stake-for-coldkeyEvery stake position held by a coldkey, across all hotkeys and subnets.
stake-for-coldkeysEvery stake position for several coldkeys at once, in one runtime call.
stake-value-for-coldkeyA coldkey's stake marked to TAO at spot prices (excludes slippage/fees), block-pinned.
stake-value-for-coldkeysSpot-price stake valuation for several coldkeys at once, at one block.
staking-hotkeysEvery hotkey a coldkey has stake with, owned or nominated.

Subnets

QuerySummary
burnCurrent burn (recycle) cost to register on a subnet.
commit-reveal-enabledWhether commit-reveal weights are enabled on a subnet.
mechanism-countCurrent mechanism count configured for a subnet.
mechanism-emission-splitEmission split between mechanisms on a subnet.
metagraphThe full metagraph for a subnet in one call (stakes, ranks, emissions, axons, ...).
subnetTempo, burn, and neuron count for one subnet (the three reads run concurrently).
subnet-hyperparametersAll hyperparameters for a subnet (named fields; version-dependent set).
subnet-identityThe identity metadata of a subnet, or None.
subnet-namesRegistered name of every subnet that published an identity, keyed by netuid.
subnet-registration-costCurrent cost to register a new subnet.
subnet-start-scheduleWhen a registered subnet can call start_call.
subnetsInfo for every subnet, fetched in four batched map queries rather than
token-symbolsChain-registered token symbol of every subnet, keyed by netuid.

Weights & bonds

QuerySummary
bondsValidator bond rows as {validator_uid: {miner_uid: bond}}, scaled to 0..1.
timelocked-weight-commitsPending (still-encrypted) commit-reveal weight commits, grouped by epoch.
weightsValidator weight rows as {validator_uid: {miner_uid: fraction}}, each row summing to 1.