@indiciaosint/sdk
v2.0.9
Published
Developer-friendly TypeScript SDK for the Indicia API
Readme
@indiciaosint/sdk
Typed TypeScript client for the Indicia API.
Create a key in the dashboard, or send an OAuth 2.1 access token as Authorization: Bearer.
npm i @indiciaosint/sdkimport { Indicia } from "@indiciaosint/sdk";
const client = new Indicia({
apiKey: process.env.INDICIA_API_KEY,
});
const me = await client.users.getInfo();
const github = await client.socials.searchGithub({ query: "octocat" });INDICIA_API_KEY is read automatically if you omit apiKey.
Auth
| | |
| --- | --- |
| API key | new Indicia({ apiKey }) or INDICIA_API_KEY (x-api-key) |
| OAuth | new Indicia({ auth: async () => ({ headers: { Authorization: Bearer ${token} } }) }) |
OAuth tokens must be issued with resource=https://api.indicia.app. Device and authorization-code flows are documented at indicia.app/device and the authorization server metadata.
Client
client.users
client.pricing
client.activity
client.intelligence
client.socials
client.infrastructure
client.unified
client.tools
client.organizationsGitHub, username, and face searches stream over SSE — iterate the returned stream with for await.
Errors
Failed HTTP responses throw IndiciaError (statusCode, body). Timeouts throw IndiciaTimeoutError.
Generate
This repository holds the Fern config.
- Regen: daily, on
workflow_dispatch, and on pushes to Fern config / these workflows. Pullshttps://api.indicia.app/openapi, commits the snapshot if it changed, then cuts a GitHub release (patch bump from npm latest). - Publish: each
vX.Y.ZGitHub release (automatic or manual) publishes@indiciaosint/[email protected].
fern check
fern generate --group ts-sdk --force --version <semver>
python3 fern/scripts/pack-sdk.py sdks/typescript <semver>Issues against the generated client: open a GitHub issue. Do not PR generated output.
