Skip to main content
GET
Resolve IPFS content
Resolves IPFS content for a CID (or CID/path) and returns the raw bytes (application/octet-stream). Resolution goes through Nexus’ self-hosted kubo node first — which fetches any reachable CID via the DHT — and falls back to Blockfrost for content the node can’t serve.
Requires the IPFS add-on. Authenticate with X-Api-Key. Without the add-on the endpoint returns 402 payment_required.
Extras
  • Range requests — send a Range: bytes=<start>-<end> header to get 206 Partial Content with a Content-Range header (handy for large files / media).
  • HEAD — issue an HEAD /api/ipfs?path=<CID> to read Content-Type and Content-Length without transferring the body.
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.

Headers

Range
string

Optional HTTP Range header (e.g. 'bytes=0-1023'). When present, the self-hosted node serves a 206 Partial Content response.

Query Parameters

path
string
required

IPFS path (CID or CID/path). Supports both CIDv0 (Qm...) and CIDv1 (ba...) formats. Accepts paths with or without ipfs:// or ipfs/ prefix.

Maximum string length: 500

Response

Content successfully resolved

The response is of type file.