Skip to main content
All reads need data:read (connections and consents need connections:read). Live data is fetched from the bank at request time through the connection gateway cache and is never stored.

Connections

GET /v2/connections (cheap), GET /v2/connections/{id}. Filters: status[], provider. Include: accounts.
status is computed: pending (accounts not landed yet or MFA outstanding), active, expiring (consent ends within 30 days), expired, invalidated (bank-side), revoked.

Consents

GET /v2/consents?connection= and GET /v2/consents/{id}. status is active, expiring, expired or withdrawn; brokerage consents have no expiry (expires_at: null). termination_reason is free text, not an enum: it is either our own note for a withdrawal we initiated (connection_deleted) or the bank’s wording for one the user made at their end. Show it, do not branch on it.

Accounts

GET /v2/accounts?connection= (cheap), GET /v2/accounts/{id}. account_number is masked to the last four digits.
  • GET /v2/accounts/{id}/balance (mid): { "object": "balance", "account": "acct_…", "current": { "amount": 123456, "currency": "aud" }, "available": { "amount": 120000, "currency": "aud" }, "currency": "aud" }; current/available are money objects or null.
  • GET /v2/accounts/{id}/details (mid): product name, deposit and lending rates, fees, features and loan details as the bank reports them, in snake_case. Banking accounts only.

Transactions

GET /v2/transactions?account=acct_…&from=&to=&include_pending=true (heavy). account is required. Newest first, limit up to 100, follow next_page_url. When the 5,000 row ceiling is reached the response carries X-Redbark-Truncated: true; narrow from/to.
provider_category is the bank or enrichment code (see /v2/provider_categories); category is the user category it resolves to through your source claims, or null. GET /v2/transactions/{id}?account= retrieves one transaction by its tagged provider id within the account’s recent window (from/to optional).

Holdings and trades

GET /v2/holdings?account= and GET /v2/trades?account=&from=&to= (heavy, Professional plan). Quantities are decimal strings; prices and values are money objects in the holding’s currency.

Provider categories

GET /v2/provider_categories lists every primary category and subcategory (with parent). This is what v1 served at /v1/categories; your own taxonomy lives at /v2/categories. The vocabulary is fixed and short, so this list is not paginated: it always returns every code in one response, next_page_url is always null, and limit is ignored.