---
title: "Get brokerage overview"
method: GET
path: "/api/brokerage"
tags: ["Brokerage"]
---

# Get brokerage overview

`GET /api/brokerage`

Brokerage overview (SnapTrade + Plaid investment, unified): accounts, balances, positions, activities, and snapshots.

## Query parameters

- `endDate` string
- `startDate` string
- `activitiesLimit` number
- `positionsLimit` number

## Response `200`

Brokerage overview payload

- BrokerageOverview
  - `balances` BrokerageBalance[], required
    - `accountId` string, required
    - `buyingPower` string, nullable, required
    - `cash` string, nullable, required
    - `createdAt` string, nullable, required
    - `currencyCode` string, nullable, required
    - `currencyName` string, nullable, required
    - `id` string, required
    - `lastSync` string, nullable, required
    - `snapTradeAccountId` string, nullable, required
    - `updatedAt` string, nullable, required
    - `userId` string, required
  - `balancesByAccount` object, required
  - `activities` BrokerageActivity[], required
    - `accountId` string, required
    - `activityId` string, nullable, required
    - `amount` string, nullable, required
    - `createdAt` string, nullable, required
    - `currencyCode` string, nullable, required
    - `currencyId` string, nullable, required
    - `currencyName` string, nullable, required
    - `description` string, nullable, required
    - `exchangeCode` string, nullable, required
    - `exchangeId` string, nullable, required
    - `exchangeMicCode` string, nullable, required
    - `exchangeName` string, nullable, required
    - `externalReferenceId` string, nullable, required
    - `fee` string, nullable, required
    - `figiCode` string, nullable, required
    - `fxRate` string, nullable, required
    - `id` string, required
    - `institution` string, nullable, required
    - `lastSync` string, nullable, required
    - `optionSymbol` unknown
    - `optionType` string, nullable, required
    - `pagination` unknown
    - `price` string, nullable, required
    - `rawSymbol` string, nullable, required
    - `securityTypeCode` string, nullable, required
    - `securityTypeDescription` string, nullable, required
    - `securityTypeId` string, nullable, required
    - `settlementDate` string, nullable, required
    - `snapTradeAccountId` string, nullable, required
    - `symbol` unknown
    - `symbolDescription` string, nullable, required
    - `symbolId` string, nullable, required
    - `symbolTicker` string, nullable, required
    - `tradeDate` string, nullable, required
    - `type` string, nullable, required
    - `units` string, nullable, required
    - `updatedAt` string, nullable, required
    - `userId` string, required
  - `activitiesByAccount` object, required
  - `positions` BrokeragePosition[], required
    - `accountId` string, required
    - `averagePurchasePrice` string, nullable, required
    - `createdAt` string, nullable, required
    - `currencyCode` string, nullable, required
    - `currencyId` string, nullable, required
    - `currencyName` string, nullable, required
    - `exchangeCode` string, nullable, required
    - `exchangeId` string, nullable, required
    - `exchangeMicCode` string, nullable, required
    - `exchangeName` string, nullable, required
    - `figiCode` string, nullable, required
    - `id` string, required
    - `isQuotable` boolean, nullable, required
    - `isTradable` boolean, nullable, required
    - `lastSync` string, nullable, required
    - `localId` string, nullable, required
    - `openPnl` string, nullable, required
    - `price` string, nullable, required
    - `rawSymbol` string, nullable, required
    - `securityTypeCode` string, nullable, required
    - `securityTypeDescription` string, nullable, required
    - `securityTypeId` string, nullable, required
    - `snapTradeAccountId` string, nullable, required
    - `symbol` string, nullable, required
    - `symbolDescription` string, nullable, required
    - `symbolId` string, nullable, required
    - `units` string, nullable, required
    - `updatedAt` string, nullable, required
    - `userId` string, required
  - `positionsByAccount` object, required
  - `accounts` BrokerageAccount[], required
    - `accountDetails` object, nullable, required
      - `balance` string, nullable, required
      - `id` string, required
      - `lastSync` string, nullable, required
    - `accountStatus` string, nullable, required
    - `accountType` string, nullable, required
    - `balanceData` unknown
    - `balances` object[], required
      - `buyingPower` string, nullable, required
      - `cash` string, nullable, required
      - `currencyCode` string, nullable, required
      - `currencyName` string, nullable, required
      - `id` string, required
      - `lastSync` string, nullable, required
    - `cashRestrictions` unknown
    - `createdDate` string, required
    - `id` string, required
    - `institutionName` string, nullable, required
    - `name` string, nullable, required
    - `needsReauth` boolean, required — True when the SnapTrade authorization backing this account is disabled and requires user reconnect via `generateConnectionPortal` with `reconnectAuthorizationId`. Always false for non-SnapTrade accounts.
    - `snaptradeAuthorizationId` string, nullable, required — SnapTrade authorization id for reconnect flows. Null for Plaid / manual accounts. Pass as `reconnectAuthorizationId` to `generateConnectionPortal` when `needsReauth` is true.
    - `source` 'plaid' | 'snaptrade' | 'manual', required — Origin of the account: SnapTrade, Plaid, or manual.
    - `userId` string, required
  - `portfolioSnapshots` PortfolioSnapshot[], required
    - `accountId` string, required
    - `id` string, required
    - `snapshotDate` string, required
    - `value` number, required
  - `userBrokerages` string[], required

## Other responses

- `401` — Unauthorized
- `403` — Subscription required
- `422` — Validation failed

---

[API](https://skmtc.net/cobaltpf/apis/cobalt-api.md) · [All operations](https://skmtc.net/cobaltpf/apis/cobalt-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cobaltpf/cobalt-api/versions/8ef0dfb5d23c/schema)