---
title: "Get status on caches"
method: GET
path: "/status"
tags: ["Admin"]
---

# Get status on caches

`GET /status`

Report on the state of the internal binary caches. Corresponds to the <a href="/chifra/admin/#chifra-status">chifra status</a> command line.

## Query parameters

- `modes` string[]
- `diagnose` boolean
- `firstRecord` number
- `maxRecords` number
- `chains` boolean
- `caches` boolean
- `healthcheck` boolean
- `chain` string
- `noHeader` boolean
- `fmt` string

## Response `200`

returns the requested data

- object
  - `data` union[] — Produces <a href="/data-model/admin/#cacheitem">CacheItem</a>, <a href="/data-model/admin/#chain">Chain</a> or <a href="/data-model/admin/#status">Status</a> data. Corresponds to the <a href="/chifra/admin/#chifra-status">chifra status</a> command line.
    - union
      - CacheItem — a single entry in the results of a status query when `--verbose` is enabled
        - `type` string, string — the type of the cache
        - `items` Any[] — the individual items in the cache (if --verbose)
        - `lastCached` string, string — the date of the most recent item added to the cache
        - `nFiles` number — the number of items in the cache
        - `nFolders` number — the number of folders holding that many items
        - `path` string, string — the path to the top of the given cache
        - `sizeInBytes` number — the size of the cache in bytes
      - Chain — a configuration item carrying information about a single chain
        - `chain` string, string — the common name of the chain
        - `chainId` number — the chain id as reported by the RPC
        - `symbol` string, string — the symbol of the base currency on the chain
        - `rpcProvider` string, string — a valid RPC provider for the chain
        - `remoteExplorer` string, string — a remote explorer for the chain such as Etherscan
        - `localExplorer` string, string — the local explorer for the chain (typically TrueBlocks Explorer)
        - `ipfsGateway` string, string — an IPFS gateway for pinning the index if enabled
      - Status — status-related data about the TrueBlocks system including the server and local binary caches
        - `cachePath` string, string — the path to the local binary caches
        - `caches` CacheItem[] — a collection of information concerning the binary caches
          - `type` string, string — the type of the cache
          - `items` Any[] — the individual items in the cache (if --verbose)
          - `lastCached` string, string — the date of the most recent item added to the cache
          - `nFiles` number — the number of items in the cache
          - `nFolders` number — the number of folders holding that many items
          - `path` string, string — the path to the top of the given cache
          - `sizeInBytes` number — the size of the cache in bytes
        - `chain` string, string — the current chain
        - `chainConfig` string, string — the path to the chain configuration folder
        - `clientVersion` string, string — the version string as reported by the rpcProvider
        - `chainId` string, string — the path to config files
        - `hasEsKey` boolean — `true` if an Etherscan key is present
        - `hasPinKey` boolean — `true` if a Pinata API key is present
        - `indexPath` string, string — the path to the local binary indexes
        - `isApi` boolean — `true` if the server is running in API mode
        - `isArchive` boolean — `true` if the rpcProvider is an archive node
        - `isTesting` boolean — `true` if the server is running in test mode
        - `isTracing` boolean — `true` if the rpcProvider provides Parity traces
        - `isScraping` boolean — `true` if the scraper is running
        - `networkId` string, string — the network id as reported by the rpcProvider
        - `progress` string, string — the progress string of the system
        - `rootConfig` string, string — the path to the root configuration folder
        - `rpcProvider` string, string — the current rpcProvider
        - `version` string, string — the TrueBlocks version string
        - `chains` Chain[] — a list of available chains in the config file
          - `chain` string, string — the common name of the chain
          - `chainId` number — the chain id as reported by the RPC
          - `symbol` string, string — the symbol of the base currency on the chain
          - `rpcProvider` string, string — a valid RPC provider for the chain
          - `remoteExplorer` string, string — a remote explorer for the chain such as Etherscan
          - `localExplorer` string, string — the local explorer for the chain (typically TrueBlocks Explorer)
          - `ipfsGateway` string, string — an IPFS gateway for pinning the index if enabled

## Other responses

- `400` — bad input parameter

## Changes

- **2025-07-04** `1df61d994f7e` — 1 info
  - added the new optional `query` request parameter `caches`
- **2024-06-01** `d659e0eb3b8e` — 1 info
  - added the new optional `query` request parameter `healthcheck`
- **2024-05-30** `6e93566c8cd3` — 2 breaking
  - the `data/items/oneOf[#/components/schemas/cacheItem]/items/items/` response's property type/format changed from ``/`` to `string`/`` for status `200`
  - the `data/items/oneOf[#/components/schemas/status]/caches/items/items/items/` response's property type/format changed from ``/`` to `string`/`` for status `200`
- **2024-05-06** `6803b81d9e78` — 2 breaking
  - for the `query` request parameter `firstRecord`, the type/format was changed from `number`/`blknum` to `number`/`uint64`
  - for the `query` request parameter `maxRecords`, the type/format was changed from `number`/`blknum` to `number`/`uint64`
- …earlier changes not shown

[Full history](https://skmtc.dev/trueblocks/apis/trueblocks-api/changes/status/get.md)

---

[API](https://skmtc.dev/trueblocks/apis/trueblocks-api.md) · [All operations](https://skmtc.dev/trueblocks/apis/trueblocks-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trueblocks/trueblocks-api/revisions/2a176f1485a9/schema)