Build on Bitcoin with absolute clarity

Name: Wallet Scanner.
Description: Derives addresses for legacy (44), wrapped SegWit (49), native SegWit (84), and Taproot (86); queries Electrum for history/balances; returns used addresses, a single fresh address per branch, and summaries.

Body

{
  "key": "<mnemonic>",        // required: 12+ words, BIP39-valid
  "gapLimit": 20,               // optional: stop after N consecutive unused (1..100)
  "batchSize": 40               // optional: addresses checked in parallel (5..200)
}

curl -X POST "$BASE_URL/api/wallet" \
  -H "Content-Type: application/json" \
  -d '{"key":"abandon abandon ... about","gapLimit":20,"batchSize":40}'

const res = await fetch(`${BASE_URL}/api/wallet`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ key: seed, gapLimit: 20, batchSize: 40 })
});
const data = await res.json();

final res = await http.post(
  Uri.parse('$BASE_URL/api/wallet'),
  headers: { 'Content-Type': 'application/json' },
  body: jsonEncode({ 'key': seed, 'gapLimit': 20, 'batchSize': 40 }),
);
final data = jsonDecode(res.body);

Response (truncated)

{
  "ok": true,
  "meta": {
    "generatedAt": "2025-09-03T12:00:00Z",
    "network": "bitcoin-mainnet",
    "electrum": { "server": "host:50002", "tls": true, "selection": "random" },
    "derivation": { "coinType": 0, "account": 0, "purposes": [44,49,84,86], "branches": { "receive": 0, "change": 1 } },
    "scan": { "gapLimit": 20, "batchSize": 40, "strategy": "history-first; rolling gap; single-fresh; reused scripthash" },
    "security": { "includeWif": true }
  },
  "purposes": {
    "bip84": {
      "receive": {
        "used": [{ "address": "bc1q...", "path": "m/84'/0'/0'/0/0", "index": 0, "wif": "L1...", "tx": { "total": 1, "unconfirmed": 0 }, "balance": { "confirmedSats": "50000", "unconfirmedSats": "0", "totalSats": "50000" } }],
        "fresh": { "address": "bc1q...", "path": "m/84'/0'/0'/0/1", "index": 1, "wif": "Kx...", "tx": { "total": 0, "unconfirmed": 0 }, "balance": { "confirmedSats": "0", "unconfirmedSats": "0", "totalSats": "0" } },
        "summary": { "totalAddressesChecked": 80, "usedAddressCount": 1, "txTotalCount": 1, "txUnconfirmedCount": 0, "balance": { "confirmedSats": "50000", "unconfirmedSats": "0", "totalSats": "50000" } }
      },
      "change": { ... },
      "summary": { ... }
    },
    "bip44": { ... }, "bip49": { ... }, "bip86": { ... }
  },
  "totals": { "totalAddressesChecked": 320, "usedAddressCount": 1, "txTotalCount": 1, "txUnconfirmedCount": 0, "balance": { "confirmedSats": "50000", "unconfirmedSats": "0", "totalSats": "50000" } }
}

How to read it

• bip84 = Native SegWit (bech32 bc1...) — recommended.
• receive / change = branches /0 and /1.
• used[] = addresses that have history (with per‑address balances).
• fresh = the first unused address after the last used — the next one you should display to receive funds.
• summary = counts and totals for that branch or purpose.
• totals = aggregate across all purposes.

Returns API liveness and current network height.

curl "$BASE_URL/v1/health" -H "Authorization: Bearer $API_KEY"

const res = await fetch(`${BASE_URL}/v1/health`, {
  headers: { Authorization: `Bearer ${API_KEY}` }
});
console.log(await res.json());

final res = await http.get(
  Uri.parse('$BASE_URL/v1/health'),
  headers: {'Authorization': 'Bearer $API_KEY'},
);

Response

{
  "ok": true,
  "network": "mainnet",
  "chain_height": 857432
}

Returns confirmed and unconfirmed satoshi balances for a wallet.

Path Parameters

wallet_id (string) — Required

curl "$BASE_URL/v1/wallets/abcd1234/balance" \
  -H "Authorization: Bearer $API_KEY"

const res = await fetch(`${BASE_URL}/v1/wallets/${WALLET_ID}/balance`, {
  headers: { Authorization: `Bearer ${API_KEY}` }
});
const data = await res.json();

final res = await http.get(
  Uri.parse('$BASE_URL/v1/wallets/$WALLET_ID/balance'),
  headers: {'Authorization': 'Bearer $API_KEY'},
);

Response

{
  "confirmed_sats": 125000,
  "unconfirmed_sats": 2000,
  "total_sats": 127000
}

Body

{
  "priority": "fastest" | "fast" | "economy",
  "vbytes": 250
}

curl -X POST "$BASE_URL/v1/transactions/estimate-fee" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"priority":"fast","vbytes":250}'

await fetch(`${BASE_URL}/v1/transactions/estimate-fee`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ priority: 'fast', vbytes: 250 })
});

final res = await http.post(
  Uri.parse('$BASE_URL/v1/transactions/estimate-fee'),
  headers: {
    'Authorization': 'Bearer $API_KEY',
    'Content-Type': 'application/json',
  },
  body: jsonEncode({ 'priority': 'fast', 'vbytes': 250 }),
);

Response

{
  "fee_rate_sat_per_vb": 19,
  "estimated_fee_sats": 4750
}

Body

{
  "tx_hex": "...rawhex..."
}

Response

{
  "txid": "f5c3...",
  "status": "broadcasted"
}

Response

{
  "txid": "f5c3...",
  "confirmations": 3,
  "block_height": 857429,
  "fee_sats": 4768
}