Index and node tips

GET/health

Wallet API v1.0.0 · Health

Index and node tips, heights with their hashes, so instances can be compared from one call. Two instances at the same height agree when their indexed_hash match. synced is false while the index lags the node by more than one block. When the node cannot serve the index the status is 503 and the body has an extra error field.

Example

curl 'https://api.tensorcash.org/health'

Parameters

No parameters.

Responses

Status	Description	Body
`200`	Index state	application/json `Health`
`503`	The node cannot serve the index; `error` says why	application/json `Health`

Schemas

`Health`

Field	Type	Required	Description
`network`	`"mainnet" \| "testnet" \| "regtest"`	Yes	Network this instance serves.
`indexed_height`	`integer \| null`	Yes	Height of the index tip the API answers from.
`indexed_hash`	`string \| null`	Yes	Hash of the index tip.
`node_height`	`integer \| null`	Yes	Node's best height at the indexer's last pass.
`node_hash`	`string \| null`	Yes	Node's best block hash at the indexer's last pass.
`synced`	`boolean`	Yes	False while the index lags the node by more than one block.
`mempool_txs`	`integer`	Yes	Transactions in the indexed mempool copy.
`error`	`string`	—	Present with status 503: why the node cannot serve the index.

Source: tensorcash-wallet-api (tensorcash-api) v1.0.0 (772799e) · bobponey · MIT
OpenAPI spec (JSON): /docs/api/wallet-api.openapi.json