Base URLs
| Environment | URL |
|---|---|
| Sandbox | https://sandbox.api.bluumfinance.com/v1 |
| Production | https://api.bluumfinance.com/v1 |
| Sandbox (legacy alias) | https://test-service.bluumfinance.com/v1 |
| Production (legacy alias) | https://service.bluumfinance.com/v1 |
Authentication
HTTP Basic Auth: your API Key is the username, your API Secret is the password. SendAuthorization: Basic base64(API_KEY:API_SECRET). See How the API works for the full walkthrough.
Endpoint groups
| Group | Description |
|---|---|
| Investors | Create, read, and manage investors |
| Documents | Upload and track KYC documents |
| Funding Sources | Link bank accounts (Plaid or manual) |
| Transfers | Deposits and withdrawals |
| Trading | Place, estimate, and cancel orders |
| Positions | Investor holdings and P&L |
| Assets | Search and hydrate the tradable catalog |
| Market Data | Quotes, bars, and snapshots (add-on product) |
| Webhooks | Event subscription management |
Conventions
- Decimal values are strings to preserve precision (e.g.
"178.50"). - Dates use ISO 8601 (
2025-06-15T14:30:00Z). - IDs are prefixed by resource type —
inv_,dep_,wd_,ord_,pos_,doc_,fs_,wh_,apk_. Passing a raw UUID where a prefixed id is expected returns400. - Lists accept
limitandoffsetand return an envelope:{ "object": "list", "url", "has_more", "data": [] }. - Errors return
{ "error": { "type", "code", "message", "param"? } }with codes shapedBLUM-{STATUS}-{SEQ}. See the Error Code Reference. - Rate limits — sandbox 10 req/s, production 25 req/s per key pair.
Interactive playground
Every endpoint page has a live playground. Enter your API Key and Secret in the auth fields to make real requests against the sandbox.Additional resources
Postman Collection
Pre-built requests for every endpoint.
SDKs
Client libraries and code generation.
Error Codes
The complete error catalog.
Glossary
Key terms used across the docs.