Spark Runes API

Client + config

import { BridgeSDK } from "@satsterminal-sdk/bridge";
// or via suite: const { bridge } = createClient({ apiKey, bridge: true });

const bridge = new BridgeSDK({ apiKey, baseUrl }); // baseUrl optional; defaults to core API

Amounts: strings (u64) to avoid precision loss.
Payloads map camelCase params to snake_case bodies (e.g., userPublicKey -> user_public_key).
Namespace: bridge.spark.runes (top-level methods remain for Runes).

Methods

`bridge.spark.runes.getBTCDepositAddress(params)`

Issue a BTC deposit address for bridging Runes to Spark.

Param	Type	Notes
`userPublicKey`	`string`	User pubkey used to derive the multisig
`runeId`	`string`	Rune identifier (e.g., `840000:3`)
`amount`	`string`	Requested amount (u64 string)

Returns: { address: string } Also available as bridge.getBTCDepositAddress(...).

`bridge.spark.runes.bridgeRunes(params)`

Submit a proof of BTC deposit to kick off minting on Spark.

Param	Type	Notes
`btcAddress`	`string`	User’s BTC address used for the deposit
`bridgeAddress`	`string`	Bridge-issued BTC deposit address (from `getBTCDepositAddress`)
`txid`	`string`	Deposit transaction id
`vout`	`number`	Output index with the rune deposit

Returns: { requestId: string } Also available as bridge.bridgeRunes(...).

`bridge.spark.runes.getActivity(userPublicKey)`

Fetch bridge activity for a user. Returns: SparkRunesBridgeActivity[] Also available as bridge.getActivity(...).

`bridge.spark.runes.getTransaction(txid)`

Fetch a single bridge activity by transaction id. Returns: SparkRunesBridgeActivity Also available as bridge.getTransaction(...).

Activity shape

Field	Type	Notes
`runeId`	`string`	Rune identifier
`amount`	`string`	Requested amount
`normalizedAmount`	`string`	Normalized u64 amount
`btcDepositAddress`	`string`	Address used for BTC-side deposit
`sparkBridgeAddress?`	`string`	Spark-side deposit address (wRunes exit)
`status`	`"failed" \| "pending" \| "address_issued" \| "waiting_for_confirmations" \| "ready_for_mint" \| "spent" \| "minted"`	Lifecycle state
`confirmations?`	`number`	BTC confirmations seen
`txid?`	`string`	Deposit transaction id
`vout?`	`number`	Deposit output index
`wruneMetadata?`	`any`	Token metadata, if available

Use getActivity to poll until minted (Runes -> Spark) or spent (Spark -> Runes) depending on direction.

Status reference

Status	Meaning
`pending`	Request registered, awaiting deposit info
`address_issued`	Deposit/exit address generated
`waiting_for_confirmations`	Deposit detected; waiting for BTC confs or Spark balance check
`ready_for_mint`	Verification passed; mint/burn in progress
`minted`	Spark mint completed (Runes -> Spark)
`spent`	BTC payout built/sent (Spark -> Runes)
`failed`	Terminal failure; retry by requesting a new address

Overview

Suite

UI Components

Swaps

Borrow

Bridge

Earn

Client + config

Methods

`bridge.spark.runes.getBTCDepositAddress(params)`

`bridge.spark.runes.bridgeRunes(params)`

`bridge.spark.runes.getActivity(userPublicKey)`

`bridge.spark.runes.getTransaction(txid)`

Activity shape

Status reference

​Client + config

​Methods

​bridge.spark.runes.getBTCDepositAddress(params)

​bridge.spark.runes.bridgeRunes(params)

​bridge.spark.runes.getActivity(userPublicKey)

​bridge.spark.runes.getTransaction(txid)

​Activity shape

​Status reference

Client + config

Methods

`bridge.spark.runes.getBTCDepositAddress(params)`

`bridge.spark.runes.bridgeRunes(params)`

`bridge.spark.runes.getActivity(userPublicKey)`

`bridge.spark.runes.getTransaction(txid)`

Activity shape

Status reference