The REST API is in beta. Endpoints, request formats, and response shapes may change. Pin your integration to a specific API version once versioning is available.
Base URL
Authentication
All API requests require a Bearer token. Create an API key in the dashboard and include it in theAuthorization header:
API access requires an active subscription (trialing, active, or past due). You can revoke keys from the dashboard at any time.
Rate limits
Authenticated requests are limited to 30 requests per minute per API key. Unauthenticated or failed auth requests are limited to 10 per minute per IP address. Every response includes rate limit headers:| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum requests allowed per window |
X-RateLimit-Remaining | Requests remaining in the current window |
Retry-After | Seconds until the next request is allowed (only present on 429 responses) |
Error format
All errors return a JSON envelope:| Field | Type | Description |
|---|---|---|
message | string | Error description |
code | string | undefined | Machine-readable error code, when available |
details | string[] | undefined | Validation details, when available |
HTTP status codes
| Status | Meaning |
|---|---|
200 | Success |
400 | Invalid parameters |
401 | Missing or invalid API key |
403 | Subscription required, or Pro plan required for brokerage endpoints |
404 | Resource not found or does not belong to you |
429 | Rate limited |
500 | Internal server error |
502 | Banking provider temporarily unavailable |
Pagination
List endpoints supportlimit and offset query parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | Varies by endpoint | Maximum number of items to return |
offset | integer | 0 | Number of items to skip |
pagination object:
OpenAPI specification
A machine-readable OpenAPI 3.1 spec is available at:/doc via Swagger UI.
Quick start
Get your API key
Go to Settings > API Keys in the dashboard and create a new key. Copy the key. It is only shown once.