HuntAPI

Node.js

Installieren Sie das Node.js-SDK von HuntAPI und starten Sie Ihren ersten API-Aufruf.

Das offizielle Node.js-SDK von HuntAPI mit einer typisierten Methode pro Endpunkt und einem generischen request() für alles andere.

Voraussetzungen

  • Node.js 20+

Installation

npm install @huntapi/sdk

API-Schlüssel erhalten

Kopieren Sie Ihren API-Schlüssel aus dem HuntAPI-Dashboard und legen Sie ihn in der Umgebungsvariable HUNTAPI_API_KEY ab, die das SDK standardmäßig liest. Checken Sie ihn nicht in die Versionsverwaltung ein.

Schnellstart

import { HuntApiClient } from "@huntapi/sdk";

const client = new HuntApiClient({ apiKey: process.env.HUNTAPI_API_KEY });

const response = await client.mediaMetadata({
  query: "https://www.youtube.com/watch?v=Z5YP8kznWZs",
});
console.log(response.data);

Asynchrone Jobs

Download-Endpunkte sind asynchron: Sie geben eine job_id zurück, und Jobs können bis zu 12 Stunden laufen. Das SDK kann auf ihr Ende warten.

const submitted = await client.videoDownload({
  query: "https://www.youtube.com/watch?v=Z5YP8kznWZs",
  video_quality: "720p",
});
const job = await client.waitForJob(submitted.data.job_id, {
  onProgress: (j) => console.log(`${j.status} ${j.progress ?? 0}%`),
});
console.log(JSON.stringify(job.data, null, 2));

Fehler

Eine Antwort außerhalb von 2xx löst einen API-Fehler mit Status und Meldung aus. Die vollständige Liste finden Sie unter Statuscodes.

import { HuntApiApiError } from "@huntapi/sdk";

try {
  await client.mediaMetadata({
    query: "https://www.youtube.com/watch?v=Z5YP8kznWZs",
  });
} catch (error) {
  if (error instanceof HuntApiApiError) {
    console.error(error.status, error.message, error.responseBody);
  }
  throw error;
}

Wiederholungen

Anfragen werden bis zu 3-mal wiederholt nach einem Netzwerkfehler, einem 408, 500, 502, 503 oder 504 oder einem Ratenlimit des Tarifs. Kontingentfehler pro Schlüssel und clientseitige Timeouts werden nicht wiederholt. Die Wartezeit beginnt bei 1 Sekunde und wächst pro Wiederholung um das 1,5-Fache; ein Retry-After-Header hat Vorrang.

const client = new HuntApiClient({ maxRetries: 5, retryDelay: 500 });

// or for one request
await client.mediaMetadata(
  { query: "https://www.youtube.com/watch?v=Z5YP8kznWZs" },
  { maxRetries: 0 },
);

Batch-Anfragen

Führen Sie viele Aufrufe gleichzeitig aus, standardmäßig 10. Ein Fehler stoppt die anderen nicht.

const inputs = [
  "https://www.youtube.com/watch?v=Z5YP8kznWZs",
  "https://www.youtube.com/watch?v=jNQXAC9IVRw",
];
const results = await client.batch(
  inputs,
  (query) => client.mediaMetadata({ query }),
  { concurrency: 5 },
);

for (const result of results) {
  if (result.status === "fulfilled") console.log(result.value.data);
  else console.error(inputs[result.index], result.reason);
}

Beliebiger Endpunkt

request() erreicht jeden Pfad, auch Endpunkte, die nach Ihrer SDK-Version erschienen sind.

const response = await client.request("GET", "/v1/usage");

Häufige Fehler

  • Den API-Schlüssel in Frontend-Code einbauen. Jeder könnte ihn lesen. Rufen Sie die API von Ihrem Server auf.
  • Jeden 401 als falschen Schlüssel behandeln. Ein 401 kann auch ein Ratenlimit sein: Lesen Sie die Meldung. Das SDK wiederholt Tarif-Ratenlimits automatisch.
  • Einen 402 wiederholen. Es sind keine Credits oder Kontingente mehr übrig, eine Wiederholung kann also nicht gelingen. Siehe Credits.
  • Auf lange Anfragen warten. Nutzen Sie ab 60 Sekunden den asynchronen Modus wie oben gezeigt, statt das Timeout zu erhöhen. Siehe Timeout.

Auf dieser Seite