Skip to Content
TypeScript SDKInstallation

Installation

npm

npm install @spectrumnodes/sdk

yarn

yarn add @spectrumnodes/sdk

pnpm

pnpm add @spectrumnodes/sdk

Usage

import { Spectrum } from '@spectrumnodes/sdk';
 
const spectrum = new Spectrum({ api: 'https://your-endpoint.simplystaking.xyz/YOUR_API_KEY/' });

CommonJS

const { Spectrum } = require('@spectrumnodes/sdk');
 
const spectrum = new Spectrum({ api: 'https://your-endpoint.simplystaking.xyz/YOUR_API_KEY/' });

TypeScript

The SDK ships with full type definitions. No @types/ package needed.

import { Spectrum } from '@spectrumnodes/sdk';
import type { ChainSlug, SpectrumConfig } from '@spectrumnodes/sdk';
 
const config: SpectrumConfig = {
  api: process.env.SPECTRUM_API!,
  defaultChain: 'ethereum' as ChainSlug,
};
 
const spectrum = new Spectrum(config);

Requirements

  • Node.js >= 18: the SDK uses native fetch (no polyfill needed)
  • TypeScript >= 5.0 (if using TypeScript)
  • Works in modern browsers with fetch and AbortController support
OverviewConfiguration