Service APIs overview
Find the reference, guide or specification for each BSV blockchain service API. The services expose HTTP APIs, and AuthSocketA WebSocket protocol on Socket.IO with BRC-103 mutual authentication uses WebSocket. For the hosts to call on each network, see Network endpoints.
HTTP APIs
| API | What it does | Reference | Guide or specification |
|---|---|---|---|
| ARC | Submits one transaction or a batch to ARCThe broadcaster that came before BSV Broadcaster. BSV Broadcaster keeps most of its request and response shapes, but the ARC class of @bsv/sdk does not work with it and reports the status of a transaction by its ID | ARC broadcast | Broadcast with BSV Broadcaster |
| Overlay | Accepts BEEFBackground Evaluation Extended Format (BRC-62): a transaction with the evidence a host needs to verify it. transactions into an overlay serviceBuilt from topic managers, which decide what is admitted, and lookup services, which query what was admitted., answers lookup queries, lists the topic managers and lookup services it hosts, and exposes admin routes | Overlay | Run an overlay with @bsv/overlay-express |
| MessageBox | Holds messages for a named box on a MessageBoxA store-and-forward messaging service: it holds each message until its recipient reads it server until the recipient lists and acknowledges them, and registers devices and permissions | MessageBox | Send messages with @bsv/message-box-client |
| Merkle service | Watches transaction IDs and sends each BUMPBSV Unified Merkle Path (BRC-74): a compact proof that a transaction is in a block to a callback URL when the proof is available | Merkle service | Merkle service specification |
| File storage | Uploads a file to a UHRPUniversal Hash Resolution Protocol (BRC-26): file storage where a file is found by the hash of its content storage server, finds who hosts a hash, lists uploads and renews an advertisement | UHRP storage | UHRP specification |
| Wallet storage | Exposes a remote wallet storage provider over HTTP: actions, outputs, certificates and sync | Wallet storage | Plug in your own storage |
| BRC-121 payments | Charges for an HTTP resource. The resource answers 402 Payment Required with the x-bsv-sats and x-bsv-server headers, and the client repeats the request with a payment | BRC-121 payments | Gate an API behind payments |
Protocols
ts-stack describes these protocols as AsyncAPI specifications:
AuthSocket WebSocket protocol
Socket.IO with BRC-103Mutual authentication, where the wallet and the server prove their identity keys to each other authentication, where each side signs its messages and the other verifies them.
BRC-103 mutual authentication
The handshake in which a client and a server prove their identity keys to each other, used by MessageBox and AuthSocket.
BRC-29 and GASP have no page on this site. Their specifications are in ts-stack:
- BRC-29 covers peer-to-peer payments with a payment address derived from both identity keys.
- GASPGraph Aware Sync Protocol, how two overlay nodes synchronize transaction state syncs transaction state between two overlay nodes, as described in its specification.
Related articles
To learn more about service APIs on the BSV blockchain, review these articles: