API reference

The endpoints below form the public Blacksheep API. Every public endpoint requires Ed25519 request signing (see Authentication) — session-authenticated endpoints used by the dashboard backend are not listed here.

Conventions

• Base URL — https://api.blacksheep.money
• HTTP method — All public endpoints are called with POST and a JSON body (endpoints that take no input are called with an empty body).
• Envelopes — Success responses wrap the result in { "data": ... }; endpoint errors return { "error": { "code", "message" } } (signature failures return 401 with a flat { "error": "<code>" } — see Authentication).
• Currency objects in responses also carry a metadata field (a JSON-encoded string, typically "{}") — omitted from the examples in these docs.
• Amounts — Always in the smallest unit as a string (e.g. "15000" AUD = $150.00). Never use Number — use BigInt or a decimal library.
• Currencies — Wire format: { "value": "...", "code": "AUD", "decimals": 2 }. Crypto currencies also carry a chain (e.g. "ethereum").

Grouping

• account.* — Read account state: balances, external accounts (bank, wallet).
• quote.* — Fetch an indicative swap quote.
• transaction.* — Initiate swaps, submit withdrawals, read transaction history.