# SatsTerminal SDK

## Docs

- [API Keys](https://developer.satsterminal.com/api-keys.md): How to obtain and use your SatsTerminal API key.
- [Borrow sdk](https://developer.satsterminal.com/borrow/api-reference/borrow-sdk.md)
- [Errors](https://developer.satsterminal.com/borrow/api-reference/errors.md)
- [Types](https://developer.satsterminal.com/borrow/api-reference/types.md)
- [Architecture](https://developer.satsterminal.com/borrow/core-concepts/architecture.md)
- [Sessions](https://developer.satsterminal.com/borrow/core-concepts/sessions.md)
- [Smart wallets](https://developer.satsterminal.com/borrow/core-concepts/smart-wallets.md)
- [Workflows](https://developer.satsterminal.com/borrow/core-concepts/workflows.md)
- [Complete loan flow](https://developer.satsterminal.com/borrow/examples/complete-loan-flow.md)
- [Nodejs usage](https://developer.satsterminal.com/borrow/examples/nodejs-usage.md)
- [React integration](https://developer.satsterminal.com/borrow/examples/react-integration.md)
- [Configuration](https://developer.satsterminal.com/borrow/getting-started/configuration.md)
- [Installation](https://developer.satsterminal.com/borrow/getting-started/installation.md)
- [Quick start](https://developer.satsterminal.com/borrow/getting-started/quick-start.md)
- [Cross chain withdrawals](https://developer.satsterminal.com/borrow/guides/cross-chain-withdrawals.md)
- [Getting a loan](https://developer.satsterminal.com/borrow/guides/getting-a-loan.md)
- [Managing collateral](https://developer.satsterminal.com/borrow/guides/managing-collateral.md)
- [Portfolio positions](https://developer.satsterminal.com/borrow/guides/portfolio-positions.md)
- [Repaying a loan](https://developer.satsterminal.com/borrow/guides/repaying-a-loan.md)
- [Borrow Overview](https://developer.satsterminal.com/borrow/overview.md): Bitcoin-backed borrowing with smart accounts, multi-chain support, and secure workflows.
- [Best practices](https://developer.satsterminal.com/borrow/resources/best-practices.md)
- [Error handling](https://developer.satsterminal.com/borrow/resources/error-handling.md)
- [Troubleshooting](https://developer.satsterminal.com/borrow/resources/troubleshooting.md)
- [Withdrawals](https://developer.satsterminal.com/borrow/withdrawals.md): Move borrowed assets back to Bitcoin or to an EVM address (gasless).
- [Bridge API Overview](https://developer.satsterminal.com/bridge/api.md): Choose a bridge type and view its API reference.
- [Installation](https://developer.satsterminal.com/bridge/getting-started/installation.md): Install the Bridge SDK standalone or via the suite client.
- [Bridge Overview](https://developer.satsterminal.com/bridge/overview.md): Spark Runes and Spark Stables bridge types.
- [Bridge Quickstarts](https://developer.satsterminal.com/bridge/quickstart.md): Pick a bridge type and follow its quickstart.
- [Spark Runes API](https://developer.satsterminal.com/bridge/spark-runes/api.md): Bridge SDK methods for Spark Runes (BTC to Spark and back).
- [Spark Runes Architecture](https://developer.satsterminal.com/bridge/spark-runes/architecture.md): Services, flows, signing, and trust model for the Spark Runes bridge.
- [Spark Runes Overview](https://developer.satsterminal.com/bridge/spark-runes/overview.md): Bridge BTC Runes to Spark wRunes and back.
- [Spark Runes Quickstart](https://developer.satsterminal.com/bridge/spark-runes/quickstart.md): Request BTC deposit addresses, submit proofs, and track runes bridge status.
- [Spark Stables API](https://developer.satsterminal.com/bridge/spark-stables/api.md): Bridge SDK methods for Spark Stables (USDC to/from USDB on Spark).
- [Spark Stables Architecture](https://developer.satsterminal.com/bridge/spark-stables/architecture.md): Quote-based stablecoin bridge for inbound and outbound stables.
- [Spark Stables Overview](https://developer.satsterminal.com/bridge/spark-stables/overview.md): Quote-based stablecoin bridge between USDC and USDB on Spark.
- [Spark Stables Quickstart](https://developer.satsterminal.com/bridge/spark-stables/quickstart.md): Quote deposits and withdrawals, submit proofs, and track stablecoin bridge status.
- [Earn API Reference](https://developer.satsterminal.com/earn/api.md): EarnSDK methods and types.
- [Earn Overview](https://developer.satsterminal.com/earn/overview.md): Deposit stablecoins or BTC into yield protocols via the SDK.
- [Earn Quickstart](https://developer.satsterminal.com/earn/quickstart.md): Deposit and withdraw in a few steps.
- [Getting Started](https://developer.satsterminal.com/getting-started.md): Install the SDK, initialize with your apiKey, and make your first call.
- [Overview](https://developer.satsterminal.com/overview.md): Modular SatsTerminal SDK packages and how they fit together.
- [Suite usage](https://developer.satsterminal.com/suite/usage.md): Use one apiKey to access swaps, borrow, and bridge from a single entrypoint.
- [API Reference](https://developer.satsterminal.com/swaps/api.md): Full V2 and V1 method reference, parameters, and example flows.
- [Examples](https://developer.satsterminal.com/swaps/examples.md): End-to-end scripts for common V2 flows (buy, sell, alkanes, suite).
- [Swaps Overview](https://developer.satsterminal.com/swaps/overview.md): Understand the SatsTerminal swaps SDKs, V1 vs V2 flows, and when to use each.
- [Quickstart](https://developer.satsterminal.com/swaps/quickstart.md): Ship a full V2 swap flow in minutes (quote → PSBT → submit).

## OpenAPI Specs

- [openapi](https://developer.satsterminal.com/api-reference/openapi.json)