Skip to main content

​
Rate Limits & API Keys

Our API is free to integrate but rate-limited. An API key is required for all requests (except when using the Embed).
  • Default limits: 5 requests per second across all endpoints.
  • Exceeding the limit triggers a 5-minute ban.
  • Need more throughput? Contact us and we can raise limits for approved partners.
Apply for an API key: Sats Terminal Partnership Form

​
Getting an API key

  1. Log into the SatsTerminal dashboard.
  2. Create or view your API keys in sidebar menu.
  3. Keep keys secret; do not commit them to source control.

​
Using the key

Pass the key when initializing any client: 
import { SatsTerminal } from "satsterminal-sdk";
const swaps = new SatsTerminal({ apiKey: process.env.API_KEY! });
or with the suite: 
import { createClient } from "satsterminal-sdk";
const { swaps, borrow } = createClient({ apiKey: process.env.API_KEY!, borrow: { /* ... */ } });
Using the Embed? You do not need an API key—the widget handles auth for you.

​
Best practices

  • Store keys in environment variables or a secrets manager.
  • Rotate keys periodically.
  • Use different keys per environment (dev/staging/prod).