Demo docs: examples are illustrative.

JavaScript SDK

A typed client for Node.js, Bun, Deno, and edge runtimes.

Install

npm install @referral-api/js

Create a client

Prop

Type

Typed responses

Every method is fully typed. Hover over the code below to see the types.

import {  } from '@referral-api/js';

const  = new ({ : 'sk_test_51Hx' });

const { data } = await ..({ : 'unlocked' });        
const data: Reward[]

const owed = .((, ) =>  + ., 0);      
const owed: number

Errors

Failed requests throw a ReferralApiError with the same fields as the API error object.

import { ReferralApiError } from '@referral-api/js';

try {
  await client.referrers.create({ programId: 'prog_8Hq2LmN4', externalId: 'user_1042', email: 'maya@example.com' });
} catch (error) {
  if (error instanceof ReferralApiError && error.type === 'conflict') {
    // this customer is already enrolled
  }
}

How is this guide?

SDKs

Official libraries for calling Referral API.

Reactnew

A referral panel you can drop into your app's settings page.

On this page

Install Create a client Typed responses Errors