Dateien

Dateien auf IPFS hochladen, auflisten und abrufen.

Datei hochladen

POST /upload/new

Laden Sie eine beliebige Datei auf IPFS hoch. Die Datei wird gepinnt und ein permanenter CID wird zurückgegeben.

Anfragekörper

Parameter	Typ	Erforderlich	Beschreibung
content	string | object	Ja	JSON-Objekt/-Array oder base64-kodierte Dateidaten (Bilder, PDFs, HTML oder jeder andere Dateityp).
description	string	Nein	Kurze Beschreibung des hochgeladenen Inhalts.
metadata	object	Nein	Benutzerdefinierte Schlüssel-Wert-Paare, die an die Datei angehängt werden. Max. 10 Schlüssel. Schlüssel müssen alphanumerisch oder Unterstrich sein, 1-64 Zeichen. Werte müssen Strings sein, max. 256 Zeichen pro Wert. Gesamte Metadatengröße darf 4 KB nicht überschreiten.

Beispielanfrage

curl -X POST https://api.ipfs.ninja/upload/new \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": { "name": "example", "value": 42 },
    "description": "Test upload",
    "metadata": {
      "project": "my-app",
      "environment": "production"
    }
  }'

Ein Bild hochladen (base64)

const fs = require("fs");
const image = fs.readFileSync("photo.png").toString("base64");

const response = await fetch("https://api.ipfs.ninja/upload/new", {
  method: "POST",
  headers: {
    "X-Api-Key": "bws_your_api_key_here",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    content: image,
    description: "Profile photo"
  })
});

Antwort 200 OK

{
  "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
  "sizeMB": 0.042,
  "uris": {
    "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
  }
}

Dateien auflisten

GET /upload/list

Rufen Sie eine Liste Ihrer hochgeladenen IPFS-Dateien innerhalb eines Zeitraums ab.

Abfrageparameter

Parameter	Typ	Erforderlich	Beschreibung
from	number	Ja	Beginn des Zeitraums, Unix-Zeitstempel in Millisekunden.
to	number	Ja	Ende des Zeitraums, Unix-Zeitstempel in Millisekunden.

Beispielanfrage

curl "https://api.ipfs.ninja/upload/list?from=1704067200000&to=1735689600000" \
  -H "X-Api-Key: bws_your_api_key_here"

Antwort 200 OK

[
  {
    "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "fileName": "Test upload",
    "fileType": "json",
    "sizeMB": 0.001,
    "createdAt": 1711036800000,
    "metadata": {
      "project": "my-app",
      "environment": "production"
    },
    "uris": {
      "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
      "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
    }
  }
]

Datei abrufen

GET /file/:cid

Rufen Sie Metadaten für eine bestimmte hochgeladene Datei anhand ihres CID ab.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
cid	string	Ja	Der IPFS Content Identifier der Datei.

Beispielanfrage

curl https://api.ipfs.ninja/file/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN \
  -H "X-Api-Key: bws_your_api_key_here"

Antwort 200 OK

{
  "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
  "fileName": "Test upload",
  "fileType": "json",
  "sizeMB": 0.001,
  "createdAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
  }
}