Installation

The KINGSTONE SDK is a TypeScript client library for the KINGSTONE B2B Partner API. It wraps all partner endpoints with a fully typed interface, handles authentication, JSON serialization, and error mapping automatically.

Requirements

• Node.js 20+ (uses native fetch)
• TypeScript 5+ (optional but recommended)

Install from npm

npm install @kingstone/sdk

The package has zero runtime dependencies. It uses the native fetch API built into Node.js 20, so there is nothing else to install.

What Is Included

Export	Description
KingstoneClient	The main API client class
KingstoneClientOptions	Constructor options type
KingstoneApiError	Error class for API errors
All response types	TypeScript interfaces for every endpoint response

Module Format

The SDK ships both ESM and CommonJS builds:

// ESM (recommended)
import { KingstoneClient, KingstoneApiError } from '@kingstone/sdk';

// CommonJS
const { KingstoneClient, KingstoneApiError } = require('@kingstone/sdk');

TypeScript Support

TypeScript types are included in the package — there is no separate @types/ package to install. You get full autocomplete and type checking out of the box.

import { KingstoneClient, type SpinResponse } from '@kingstone/sdk';

const client = new KingstoneClient({
  apiKey: 'ks_sandbox_your_key_here',
  sandbox: true,
});

// Full type inference on the response
const result: SpinResponse = await client.spin({
  gameId: 1,
  playerId: 'player-abc',
  wagerUsd: 0.25,
});

// Autocomplete works for all nested fields
console.log(result.outcome.prizeTier);
console.log(result.presentation.comboString);
console.log(result.balance.balanceUsd);

Quick Verify

After installing, verify the SDK is working:

import { KingstoneClient } from '@kingstone/sdk';

const client = new KingstoneClient({
  apiKey: 'ks_sandbox_your_key_here',
  sandbox: true,
});

const { games } = await client.listGames();
console.log(`Connected. Found ${games.length} game(s).`);

Next Steps

• Learn how to configure the client in the Usage guide
• See working code in the Examples
• Handle errors gracefully with the Error Handling guide