Skip to main content
The official SDKs wrap every endpoint in this documentation with typed requests and responses. They send your key in the X-API-KEY header and read it from the OSINTCAT_API_KEY environment variable when you do not pass one.

JavaScript and TypeScript

Runs on Node.js 18+, Bun, Deno and Cloudflare Workers, with no dependencies.
Every method is named after its endpoint group: client.breach.search(), client.github.profile(), client.dns.resolve(). Any answer other than 2xx throws an error with the status code and the body described in Errors.
The SDK does not retry on its 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.
Keep your API key on the server. Never ship it in a browser or mobile app.

Go

Go 1.21 or later.

Python

Python 3.10 or later. Until the SDK is on PyPI, install it from GitHub:
Do not pip install osintcat for now: that name on PyPI still holds an old client that does not work with the API.

Source code

The SDKs are open source (MIT): TypeScript, Python, Go.

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; install it with npm install osintcat@latest.