Skip to main content
The JavaScript SDK is published on npm as @profoundai/client. It ships with TypeScript types.

Installation

Quick start

Create a client and run a report

Authentication

The SDK reads your API key from either of these sources:
  1. Environment variable (recommended): set PROFOUND_API_KEY in your environment.
  2. Constructor parameter: pass apiKey when initializing the client.
Set the environment variable
For details on obtaining an API key, see Authentication.

Error handling

Catch API errors

Rate limiting

The API has a default limit of 600 requests per hour per API key. When you exceed this limit, you receive a 429 Too Many Requests error. The SDK throws an error that you can catch and handle.
Handle rate limits

Async support

The SDK is fully async/await based. All methods return promises.
Await any method

Code examples

Every endpoint in the API documentation includes working JavaScript samples. Browse the Endpoints section in the REST API & SDKs tab for examples covering:
  • Organization management
  • Category discovery
  • Report generation
  • Raw data access
SDK interfaces may change as we improve the API. Pin to a specific version in production environments.