Install and configure

Install @reverse-contact/sdk and keep your API key in your server environment. These guides cover the published package version 0.3.0.

Install

npm install @reverse-contact/sdk

pnpm add @reverse-contact/sdk

yarn add @reverse-contact/sdk

bun add @reverse-contact/sdk

deno add npm:@reverse-contact/sdk

On Deno, run your script with --allow-net. Add --allow-env if you read the key from the environment.

Runtime requirements

The SDK runs on Node.js 22 and later, Bun, Deno, and edge runtimes that provide the standard Fetch API, AbortController and crypto.randomUUID. The package ships as ESM and CommonJS and has no runtime dependencies.

API key

Pass your API key with the apiKey option, or omit the option to let the client read RC_API_KEY. These guides use that environment variable, but you can use any server-side source, such as a secret manager. If you serve several workspaces, create one client per key.

Keep the key on your server. Anyone can read a key shipped in front-end code, so the constructor throws when it runs in a browser. Setting dangerouslyAllowBrowser: true bypasses that check and exposes your key to every visitor. See Authentication to create a key.

export RC_API_KEY="your-api-key"

Create a client

import ReverseContact from "@reverse-contact/sdk";
// CommonJS: const { ReverseContact } = require("@reverse-contact/sdk");

const client = new ReverseContact({ apiKey: process.env.RC_API_KEY });
const usage = await client.usage.retrieve();
console.log("Credits left:", usage.quotas?.workspace.credits.left);

new ReverseContact() also reads RC_API_KEY automatically. The constructor raises ReverseContactError when no key is available. See Client options for configuration and First call for enrichment.

Return to the TypeScript SDK overview.