curl --request GET \
--url https://api.citadel.example/api/v1/status \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.citadel.example/api/v1/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"network": "mainnet",
"chains": [
{
"chain": "evm",
"instance": "base",
"indexing": {
"state": "live",
"head": 22841903,
"indexed": 22841901,
"lag_blocks": 2,
"since": null,
"as_of": "2026-10-08T12:00:00Z"
},
"nodes": "available"
},
{
"chain": "tron",
"instance": "tron",
"indexing": {
"state": "catching_up",
"head": 76119240,
"indexed": 76119221,
"lag_blocks": 19,
"since": null,
"as_of": "2026-10-08T12:00:00Z"
},
"nodes": "degraded"
}
],
"checked_at": "2026-10-08T12:00:20Z"
}Get network status
How each chain of one network is doing now: whether Citadel’s index keeps up with the
chain, and whether Citadel has a chain node to build and send transactions through. Look
here when deposits arrive late or sends fail with rpc_unavailable, to tell a chain or
index delay from a problem on your side.
indexing.state:
state | |
|---|---|
live | The index keeps up with the chain. |
catching_up | Behind, past a quarter of the chain’s lag threshold; deposits arrive later than usual. |
stalled | Far behind the chain head, or not advancing. |
backfilling | Indexing a stretch of blocks it missed; deposits from it arrive as it goes. |
unreachable | The chain cannot be reached. |
stale | No recent word from the indexer; the figures are as of as_of. |
head is the chain’s latest block as Citadel’s nodes see it, indexed the last block
Citadel has indexed, lag_blocks the difference. since is when the current trouble began
(null when there is none). nodes is available with a node in rotation, degraded when
only slow or lagging nodes are left, unavailable when there is none: a transaction cannot
be built or sent on that chain until one is back.
network is required. Needs the read scope.
curl --request GET \
--url https://api.citadel.example/api/v1/status \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.citadel.example/api/v1/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.citadel.example/api/v1/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.citadel.example/api/v1/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"network": "mainnet",
"chains": [
{
"chain": "evm",
"instance": "base",
"indexing": {
"state": "live",
"head": 22841903,
"indexed": 22841901,
"lag_blocks": 2,
"since": null,
"as_of": "2026-10-08T12:00:00Z"
},
"nodes": "available"
},
{
"chain": "tron",
"instance": "tron",
"indexing": {
"state": "catching_up",
"head": 76119240,
"indexed": 76119221,
"lag_blocks": 19,
"since": null,
"as_of": "2026-10-08T12:00:00Z"
},
"nodes": "degraded"
}
],
"checked_at": "2026-10-08T12:00:20Z"
}Authorizations
An API key minted in the console (ctd_…). Authenticates; never authorizes funds. A key
carries scopes (read, wallets.write, transactions.write, events.write,
webhooks.write, policy.write) and may be limited to vaults, to IP addresses, and in
lifetime — see Authentication.
Query Parameters
The network the data lives on. Required — there is no default network: without it,
422 network_required. A wallet named by its id on another network: 422 network_mismatch.
The network the data lives on. Required wherever it appears in a request — there is no
default network. One your installation does not serve: 422 network_not_served.
mainnet, testnet Response
Each chain of the network.
The network the data lives on. Required wherever it appears in a request — there is no
default network. One your installation does not serve: 422 network_not_served.
mainnet, testnet Show child attributes
Show child attributes