Skip to main content
GET
Stat IPFS object
Returns metadata for an IPFS object without downloading it: its cid, size, cumulativeSize (total DAG size in bytes), type (file or dir), and blocks. Useful to check size/type before fetching, e.g. NFT media.
Requires the IPFS add-on (X-Api-Key). Node-only — there is no Blockfrost fallback; if the self-hosted node is unavailable this returns 503.
Example

Authorizations

X-Api-Key
string
header
required

API key (programmatic access — recommended)

Send your API key in the X-Api-Key header. Keys start with nxs_ and are created in the dashboard (or via POST /api/keys with a session JWT).

Each key is scoped to one chain and one network (for example cardano-mainnet), fixed at creation time. It cannot query a different network on the same chain, and it cannot query a different chain at all. A mismatched network parameter returns 400 Network Mismatch. Create one key per chain and network under the same account.

This is the credential most integrations should use.

Query Parameters

path
string
required
Maximum string length: 500

Response

200 - application/json

OK

cid
string
size
integer<int64>
cumulativeSize
integer<int64>
type
string
blocks
integer<int64>