Installation

Install the ESM package from npm:

npm install @requiply/api-sdk

The SDK requires Node.js 18 or later. Browser runtimes must provide fetch, Headers, Response, URL, and AbortSignal.

Import the client and public types from the package root:

import { RequiplyClient, RequiplyError } from '@requiply/api-sdk';
import type { InventoryListResponse } from '@requiply/api-sdk';

Create one client for a Requiply organization:

const requiply = new RequiplyClient({
  apiKey: 'rq_pk_live_...',
});

The client sends requests to https://api.requiply.com by default. Pass baseUrl only to point it somewhere else, such as a proxy of your own. The client appends /api/public/v1 to every resource path and removes trailing slashes from the configured URL.

The package currently provides an ESM import entry point. CommonJS usage is not documented as supported.