Skip to main content
The official SDKs cover every endpoint you can use today, with typed requests and responses; endpoints marked unavailable are added when they return. They are open source (MIT) and send your key in the X-API-KEY header.
1

Create an API key

Under Settings → Developer, create a key. Choose its scopes and how long it works. The key is shown once: copy it.
2

Install the SDK

Node.js 18 or later, Bun, Deno or Cloudflare Workers. No dependencies.
3

Set your key

The SDK reads the key from the OSINTCAT_API_KEY environment variable. Keep it out of your code, and never ship it in a browser or mobile app.
4

Make your first request

Save this as first.mjs and run node first.mjs. It shows your plan and how many lookups are left today.
first.mjs
5

Handle errors

Every answer other than 2xx raises an error with the status code and the answer, which names a request_id (a server error also an error_id): quote it to support. A lookup that fails is not charged.
Every endpoint page shows its call in each language. Source and issues: github.com/OsintCatHQ/osintcat-typescript.

Retries and timeouts

The SDKs do not retry on their own. A lookup retried after a timeout may already have been counted or charged, and 429 LIMIT_REACHED cannot succeed before the allowance resets at 00:00 UTC, so you decide when to try again. TypeScript and Python requests time out after 60 seconds; in Go pass a context with a deadline, and in PHP set timeout in the client options.

Upgrading from osintcat 1.x

Versions 1.x of the npm package were an older client that no longer works with the API. Version 2 is the SDK described here: npm install osintcat@latest.