Skip to main content
GET
/
api
/
ipfs
/
ls
List IPFS directory
curl --request GET \
  --url https://nexus.gerowallet.io/api/ipfs/ls \
  --header 'Authorization: Bearer <token>'
{
  "cid": "<string>",
  "links": [
    {
      "name": "<string>",
      "cid": "<string>",
      "size": 123,
      "type": "<string>"
    }
  ],
  "truncated": true
}
Lists the immediate entries under a directory or DAG CID — each with name, cid, size, and type (file or dir). Ideal for browsing NFT-collection folders or multi-file uploads. Results are capped (truncated: true when the directory exceeds the server limit).
Requires the IPFS add-on (X-Api-Key). Node-only; returns 503 if the self-hosted node is unavailable.
Example
curl "https://nexus.gerowallet.io/api/ipfs/ls?path=<DIRECTORY_CID>" \
  -H "X-Api-Key: $NEXUS_API_KEY"

Authorizations

​
Authorization
string
header
required

JWT Token Authentication

Query Parameters

​
path
string
required
Maximum string length: 500

Response

200 - application/json

OK

​
cid
string
​
links
object[]
​
truncated
boolean