Skip to main content
Version: 1.0.0

Atomiq REST API

The Atomiq REST API lets your application quote, prepare, and settle cross-chain swaps between Bitcoin/Lightning and smart-chain networks like Solana and Starknet.

If you're just getting started, see the REST API Guide first, then come back here when you need the details.

A few things to know​

  • Tokens are identified as CHAIN-TICKER — e.g. BITCOIN-BTC, LIGHTNING-BTC, STARKNET-STRK. The address field is the on-chain contract address, and is an empty string for native BTC on Bitcoin/Lightning.
  • Amounts are in base units — sats for Bitcoin, Fri for Starknet (1 STRK = 10¹⁸ Fri), Wei for EVM, lamports for Solana. Human-readable decimals (e.g. 1.5) are only used where a field is explicitly typed as DecimalString.
  • Large integers are JSON strings, not numbers. Any field typed as BigIntString is a base-10 string, because JSON can't safely represent arbitrary-precision integers. Parse them with BigInt(...) on the client.
  • Paths follow the SDK convention /<endpointName> under your chosen base path (default /api). Integrations may mount the same operations elsewhere.