> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bluumfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Endpoint documentation — base URLs, authentication, endpoint groups, and conventions.

This section is the reference for every Bluum API endpoint: request parameters, response schemas, and an interactive playground. For background on how each object behaves, start with [Concepts](/concepts/investors).

## 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. Send `Authorization: Basic base64(API_KEY:API_SECRET)`. See [How the API works](/get-started/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 returns `400`.
* **Lists** accept `limit` and `offset` and return an envelope: `{ "object": "list", "url", "has_more", "data": [] }`.
* **Errors** return `{ "error": { "type", "code", "message", "param"? } }` with codes shaped `BLUM-{STATUS}-{SEQ}`. See the [Error Code Reference](/resources/error-codes).
* **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

<CardGroup cols={2}>
  <Card title="Postman Collection" icon="paper-plane" href="/resources/postman">
    Pre-built requests for every endpoint.
  </Card>

  <Card title="SDKs" icon="cube" href="/resources/sdks">
    Client libraries and code generation.
  </Card>

  <Card title="Error Codes" icon="triangle-exclamation" href="/resources/error-codes">
    The complete error catalog.
  </Card>

  <Card title="Glossary" icon="book" href="/resources/glossary">
    Key terms used across the docs.
  </Card>
</CardGroup>