Quick Start

Integrate our Sats Terminal SDK to your dApp/Wallet/Swap UI

The Sats Terminal SDK package provides access to the Sats Terminal API to find and execute the best on-chain trade for runes across various exchanges.

Installation

npm

npm install satsterminal-sdk

Importing the SDK

The satsterminal-sdk is compatible with both CommonJS and ES6 module systems.

For CommonJS:

const { SatsTerminal } = require('satsterminal-sdk');

For ES6 Modules/TypeScript:

import { SatsTerminal } from 'satsterminal-sdk';

The satsterminal-sdk library is natively type-safe, providing enhanced code reliability and developer experience, especially when using TypeScript.

Configuration

The satsterminal-sdk requires configuration when initializing:

import { SatsTerminal } from 'satsterminal-sdk';

const satsTerminal = new SatsTerminal({
  apiKey: 'your_api_key_here'
});

API key is required and is rate-limited, you can find more details about this here.

Apply for an API key here: Sats Terminal Partnership Form