Sign in

v1

latestOpenAPI 3.1.0GPL 3.02026-07-131857173.1 KB
Admin

Manage chunks

Manage, investigate, and display the Unchained Index. Corresponds to the <a href="/chifra/admin/#chifra-chunks">chifra chunks</a> command line.

get/chunks

Query parameters

mode'manifest' | 'index' | 'blooms' | 'pins' | 'addresses' | 'appearances' | 'stats' required

the type of data to process

blocksstring[]

an optional list of blocks to intersect with chunk ranges

checkboolean

check the manifest, index, or blooms for internal consistency

belongsstring[]

in index mode only, checks the address(es) for inclusion in the given index chunk

firstBlocknumber

first block to process (inclusive)

lastBlocknumber

last block to process (inclusive)

maxAddrsnumber

the max number of addresses to process in a given chunk

deepboolean

if true, dig more deeply during checking (manifest only)

rewriteboolean

for the --pin --deep mode only, writes the manifest back to the index folder (see notes)

countboolean

for certain modes only, display the count of records

metadataboolean

for --pin only, pin only metadata files (ts.bin and manifest.json)

sleepnumber

for --remote pinning only, seconds to sleep between API calls

chainstring

the chain to use

noHeaderboolean

suppress the header in the output

fmtstring

export format, one of [ txt | csv | json ]

Response

returns the requested data

Example response

{
  "fileName": "000000000-000000000",
  "bloomHash": "QmbCQaYmfTR3sGNAvASoVjPynaY9UD31Hfxv7dGtzsptkb",
  "indexHash": "QmPmfSrYT5HDpfjj4uYSycaFECo9EqPSuADQ3YPbVp3yu4"
}