Reference overview
Look up the exact methods, endpoints and errors your app works with on the BSV blockchain, from the BRC-100BSV Request for Comments 100, the standard interface between apps and wallets Wallet API to the HTTP APIs of BSV blockchain services. Use a reference page when you already know what your app calls and need the precise request, response, URL or error. To see how the parts fit together, read How the BSV blockchain works. To build a feature step by step, follow the guides. The classes and methods of the TypeScript SDK packages are in the SDK API reference.
What each reference covers
Each row names a reference and what you look up in it. The Wallet API and the service APIs are generated from their OpenAPI specifications, with a page for each endpoint:
| Kind | What you look up | Reference |
|---|---|---|
| Networks | The explorer, faucet, broadcast endpoints, wallet storage and address format of each network | Network endpoints |
| Errors | The cause of a wallet error, by its name or the start of its message, and what to check | Error codes |
| Wallet | Each wallet method, such as createAction, listOutputs and getNetwork, with its request and response | Wallet API (BRC-100) |
| Service API | Submitting transactions to ARCThe broadcast API that came before BSV Broadcaster, one at a time or in a batch, and reading their status | ARC broadcast |
| Service API | Submitting tagged BEEFBackground Evaluation Extended Format (BRC-62), a transaction sent with its proofs transactions to an overlay serviceBuilt from topic managers, which decide what is admitted, and lookup services, which query what was admitted., querying its lookup services and managing it through its admin routes | Overlay |
| Service API | Sending, listing and acknowledging messages in a MessageBoxHolds each message until its recipient reads it, and setting who may send to it | MessageBox |
| Service API | Registering a transaction ID to receive its Merkle proofThe proof that a transaction is in a block, checked against the block header at a callback URL | Merkle service |
| Service API | Uploading, finding and renewing files that a UHRPUniversal Hash Resolution Protocol (BRC-26), storage that addresses a file by its SHA-256 hash host serves | UHRP storage |
| Service API | The HTTP interface of a remote wallet storage provider: actions, outputs, certificates and sync | Wallet storage |
| Service API | The 402 Payment Required exchange and the x-bsv-* headers of a paid request | BRC-121 payments |
| Standard | Resolving a PaymailA handle that looks like an email address and names a user's services handle into a user’s identity key | Paymail |
The Bitcoin protocol and the Network Access Rules have their own sites, at protocol.bsvblockchain.org and nar.bsvblockchain.org.
Related articles
To learn more about the reference pages of the BSV blockchain, review these articles: