Skip to main content

Package manager commands

npm
npm install @satsterminal-sdk/bridge
yarn
yarn add @satsterminal-sdk/bridge
pnpm
pnpm add @satsterminal-sdk/bridge
Suite (optional)
npm install satsterminal-sdk

Requirements

  • Node.js 16+ (TypeScript 5+ recommended)
  • API key for Bridge endpoints
  • Optional: custom baseUrl if not using the default core API

TypeScript support

The SDK ships with types; no extra @types packages are needed.
import { BridgeSDK, createBridgeClient } from "@satsterminal-sdk/bridge";
// or via suite
import { createClient } from "satsterminal-sdk";

Verify installation

import { BridgeSDK } from "@satsterminal-sdk/bridge";

const bridge = new BridgeSDK({ apiKey: "YOUR_API_KEY" });
console.log("BridgeSDK ready", !!bridge);

Next steps

  • Spark Runes quickstart: bridge/spark-runes/quickstart
  • Spark Stables quickstart: bridge/spark-stables/quickstart
  • Bridge overview: bridge/overview
  • Explore APIs: bridge/api