--- title: "Manage chunks" method: GET path: "/chunks" tags: ["Admin"] --- # Manage chunks `GET /chunks` Manage, investigate, and display the Unchained Index. Corresponds to the chifra chunks command line. ## Query parameters - `mode` 'manifest' | 'index' | 'blooms' | 'pins' | 'addresses' | 'appearances' | 'stats', required - `blocks` string[] - `check` boolean - `belongs` string[] - `firstBlock` number - `lastBlock` number - `maxAddrs` number - `deep` boolean - `rewrite` boolean - `count` boolean - `metadata` boolean - `sleep` number - `chain` string - `noHeader` boolean - `fmt` string ## Response `200` returns the requested data - object - `data` union[] — Produces Appearance, AppearanceTable, ChunkAddress, ChunkBloom, ChunkIndex, ChunkPin, ChunkRecord, ChunkStats, Count, IpfsPin, Manifest, Message, RangeDates or ReportCheck data. Corresponds to the chifra chunks command line. - union - Appearance — an appearance (``) of an address anywhere on the chain (note that in some cases, not all fields will appear depending on the command) - `address` string, address — the address of the appearance - `blockNumber` number — the number of the block - `transactionIndex` number — the index of the transaction in the block - `traceIndex` number — the zero-based index of the trace in the transaction - `reason` string, string — the location in the data where the appearance was found - `timestamp` number — the timestamp for this appearance - `date` string, datetime — the timestamp as a date (calculated) - AppearanceTable — an appearance table for an address - `AddressRecord` object — the address record for these appearances - `Appearances` AppRecord[] — all the appearances for this address - ChunkAddress — internal-use only data model detailing a single address record in the address table of an index chunk - `address` string, address — the address in this record - `range` string, blkrange — the block range of the chunk from which this address record was taken - `offset` number — the offset into the appearance table of the first record for this address - `count` number — the number of records in teh appearance table for this address - `rangeDates` object — if verbose, the block and timestamp bounds of the chunk (may be null) - ChunkBloom — internal-use only data model detailing a single bloom filter file - `range` string, blkrange — the block range (inclusive) covered by this chunk - `magic` string, string — an internal use only magic number to indicate file format - `hash` string, hash — the hash of the specification under which this chunk was generated - `nBlooms` number — the number of individual bloom filters in this bloom file - `nInserted` number — the number of addresses inserted into the bloom file - `fileSize` number — the file size on disc in bytes of this bloom file - `byteWidth` number — the width of the bloom filter - `rangeDates` object — if verbose, the block and timestamp bounds of the chunk (may be null) - ChunkIndex — internal-use only data model detailing a single index chunk file - `range` string, blkrange — the block range (inclusive) covered by this chunk - `magic` string, string — an internal use only magic number to indicate file format - `hash` string, hash — the hash of the specification under which this chunk was generated - `nAddresses` number — the number of addresses in this chunk - `nAppearances` number — the number of appearances in this chunk - `fileSize` number — the file size on disc in bytes of this bloom file - `rangeDates` object — if verbose, the block and timestamp bounds of the chunk (may be null) - ChunkPin — a JSON object containing the results of pinning the Unchained Index - `version` string, string — the version string hashed into the chunk data - `chain` string, string — the chain to which this manifest belongs - `timestampHash` string, ipfshash — IPFS cid of file containing timestamps - `specHash` string, ipfshash — IPFS cid of the specification - `manifestHash` string, ipfshash — IPFS cid of file containing CIDs for the various chunks - ChunkRecord — a single record in the manifest detailing the IPFS hases and file sizes for each bloom filter and index chunk - `range` string, blkrange — the block range (inclusive) covered by this chunk - `bloomHash` string, ipfshash — the IPFS hash of the bloom filter at that range - `indexHash` string, ipfshash — the IPFS hash of the index chunk at that range - `bloomSize` number — the size of the bloom filter in bytes - `indexSize` number — the size of the index portion in bytes - `rangeDates` object — if verbose, the block and timestamp bounds of the chunk (may be null) - ChunkStats — summary statistics about an Unchained Index bloom filter and index chunk - `range` string, blkrange — the block range (inclusive) covered by this chunk - `nAddrs` number — the number of addresses in the chunk - `nApps` number — the number of appearances in the chunk - `nBlocks` number — the number of blocks in the chunk - `nBlooms` number — the number of bloom filters in the chunk's bloom - `recWid` number — the record width of a single bloom filter - `bloomSz` number — the size of the bloom filters on disc in bytes - `chunkSz` number — the size of the chunks on disc in bytes - `addrsPerBlock` number — the average number of addresses per block - `appsPerBlock` number — the average number of appearances per block - `appsPerAddr` number — the average number of appearances per address - `ratio` number — the ratio of appearances to addresses - `rangeDates` object — if verbose, the block and timestamp bounds of the chunk (may be null) - Count — the number of items in the given database - `count` number — the number of items in the given database - IpfsPin — internal-use only data model detailing a single remote or local ipfs pinned file - `cid` string, ipfshash — the CID of the file - `datePinned` string, string — the date the CID was first created - `status` string, string — the status of the file (one of [all|pinned|unpinned|pending]) - `size` number — the size of the file in bytes - `fileName` string, string — the metadata name of the pinned file - Manifest — a JSON object containing records for each bloom filter and index chunk in the Unchained Index - `version` string, string — the version string hashed into the chunk data - `chain` string, string — the chain to which this manifest belongs - `specification` string, ipfshash — IPFS cid of the specification - `chunks` ChunkRecord[] — a list of the IPFS hashes of all of the chunks in the unchained index - `range` string, blkrange — the block range (inclusive) covered by this chunk - `bloomHash` string, ipfshash — the IPFS hash of the bloom filter at that range - `indexHash` string, ipfshash — the IPFS hash of the index chunk at that range - `bloomSize` number — the size of the bloom filter in bytes - `indexSize` number — the size of the index portion in bytes - `rangeDates` object — if verbose, the block and timestamp bounds of the chunk (may be null) - Message — used for various responses when no real data is generated - `msg` string, string — the message - `num` number — a number if needed - RangeDates — shows first and last timestamps and dates for a given block range - `firstTs` number — the timestamp of the first block in this range - `firstDate` string, datetime — the first timestamp as a date - `lastTs` number — the timestamp of the most recent block in this range - `lastDate` string, datetime — the last timestamp as a date - ReportCheck — report on checking contents of chunks - `result` string, string — the result of the check - `visitedCnt` number — the number of visited items in the cache - `checkedCnt` number — the number of checks - `skippedCnt` number — the number of skipped checks - `passedCnt` number — the number of passed checks - `failedCnt` number — the number of failed checks - `msgStrings` String[] — an array of messages explaining failed checks - `reason` string, string — the reason for the test ## Other responses - `400` — bad input parameter ## Changes - **2025-07-23** `c907b904ae7a` — 1 info - added the new optional `query` request parameter `metadata` - **2025-07-23** `b0d42559be36` — 2 warning, 2 info - removed the optional property `data/items/oneOf[#/components/schemas/chunkBloom]/size` from the response with the `200` status - removed the optional property `data/items/oneOf[#/components/schemas/chunkIndex]/size` from the response with the `200` status - added the optional property `data/items/oneOf[#/components/schemas/chunkBloom]/fileSize` to the response with the `200` status - added the optional property `data/items/oneOf[#/components/schemas/chunkIndex]/fileSize` to the response with the `200` status - **2024-12-17** `2428f6f19a07` — 1 breaking, 1 warning, 6 info - added `#/components/schemas/count, #/components/schemas/rangeDates` to the `data/items/` response property `oneOf` list for the response status `200` - removed the optional property `data/items/oneOf[#/components/schemas/chunkStats]/rangeEnd` from the response with the `200` status - added the optional property `data/items/oneOf[#/components/schemas/chunkAddress]/rangeDates` to the response with the `200` status - added the optional property `data/items/oneOf[#/components/schemas/chunkBloom]/rangeDates` to the response with the `200` status - …4 more - …earlier changes not shown [Full history](https://skmtc.dev/trueblocks/apis/trueblocks-api/changes/chunks/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)