Private node, external interface

API guide and request builder for the local Bitcoin plus ord stack.

Use this guide to integrate wallets, dashboards, inscription tools, rune tooling, and transaction broadcast clients against the authenticated API exposed by this node.

Live Status

Health is public. Full status requires the API key.

No request sent yet.

Endpoint Explorer

Search by route, capability, method, or upstream service.

Sub-1 sat/vB Broadcast

Broadcast is enabled through controlled endpoints, not arbitrary RPC forwarding.

Policy model

The API accepts signed raw transaction hex and calls Bitcoin Core policy checks before broadcast. It does not impose a 1 sat/vB minimum. Transactions below 1 sat/vB can be submitted if the local node accepts them under current policy.

Check GET /v1/bitcoin/policy. A minrelaytxfee_btc_kvb value of 0.00000100 is equivalent to 0.1 sat/vB. Anything below the local floor is rejected by Core, and transactions accepted locally are still not guaranteed to propagate or confirm.

Required flow

  1. Decode the signed hex with POST /v1/bitcoin/tx/decode.
  2. Dry-run with POST /v1/bitcoin/tx/validate.
  3. Broadcast with POST /v1/bitcoin/tx/broadcast.
  4. Poll GET /v1/bitcoin/tx/{txid}/status and use RBF or package relay when needed.

Client Flows

Reference patterns for external integrations.

Ordinal-aware UTXO selection

Validate an address, fetch ord assets for candidate outputs, avoid spending inscribed or runic UTXOs unless intentional, then build the PSBT in the client wallet.

Inscription and rune lookup

Use inscription metadata, content, output, rune, and parent/child endpoints to render explorer views without exposing the ord server directly.

Batch mint or chained transaction flow

Create topologically sorted signed transactions, validate as a package, submit the package, then watch mempool entries and outspends.

Replace or accelerate

Use transaction status, mempool entry, ancestors, descendants, and package validation to decide whether RBF or CPFP is the correct follow-up.

Operations

Commands for running and verifying the stack.

./scripts/start
./scripts/status
./scripts/health-check
./scripts/status-watchdog
./scripts/start-cloudflare-tunnel

Keep Bitcoin Core RPC and ord HTTP bound to 127.0.0.1. Expose this API through TLS, keep API key auth enabled, and rotate data/api/api-key if it is shared too broadly.