Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.redbark.co/llms.txt

Use this file to discover all available pages before exploring further.

The REST API is in beta. This endpoint’s response shape may change.
Returns a paginated list of trades for a brokerage connection. Trades are fetched live from the brokerage provider. No investment data is stored on Redbark servers.
This endpoint requires a Professional plan subscription. Saver-plan API keys get a generic 403 (API access requires a Developer or Professional plan). Developer-plan keys get a 403 with "code": "professional_required" specifically for this endpoint.

​
Request

GET /v1/trades

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_API_KEY

​
Query parameters

ParameterTypeRequiredDefaultDescription
connectionIdstringYesBrokerage connection to fetch trades from
accountIdstringNoAll accountsFilter to a specific brokerage account
fromstringNo(provider default)Start date (YYYY-MM-DD or ISO 8601). No from is passed through to the brokerage provider as-is; SnapTrade’s behaviour without from depends on the underlying broker.
tostringNo(provider default)End date (YYYY-MM-DD or ISO 8601)
limitintegerNo200Maximum items to return (1 to 500)
offsetintegerNo0Number of items to skip
connectionId must refer to a brokerage connection. Passing a banking connection ID returns a 400 error. Use the List Connections endpoint to find your brokerage connection IDs.

​
Response limits

To bound memory under wide date ranges, the service stops fetching upstream pages once it has roughly 5,000 matching rows for a single request. When this happens:
  • The response sets X-Redbark-Truncated: true.
  • pagination.hasMore is true and pagination.total is -1 (the exact total isn’t known when paging stops early).
  • Continue paginating with the next offset + limit window — the same cap applies per request, not per session.

​
Response

Responses are cached at the edge for 10 minutes per key+connection+query. 
{
  "data": [
    {
      "id": "2026-03-15-VAS.AX-BUY-4487.5-50-2026-03-17-9.5-",
      "accountId": "d4e5f6a7-b8c9-0123-d4e5-f6a7b8c90123",
      "accountName": "Trading Account",
      "symbol": "VAS.AX",
      "name": "Vanguard Australian Shares ETF",
      "type": "buy",
      "quantity": "50",
      "price": "89.75",
      "currency": "AUD",
      "totalAmount": "4487.5",
      "fees": "9.5",
      "tradeDate": "2026-03-15",
      "settlementDate": "2026-03-17",
      "description": null
    },
    {
      "id": "2026-03-10-CBA.AX-SELL-2846-20-2026-03-12-9.5-",
      "accountId": "d4e5f6a7-b8c9-0123-d4e5-f6a7b8c90123",
      "accountName": "Trading Account",
      "symbol": "CBA.AX",
      "name": "Commonwealth Bank of Australia",
      "type": "sell",
      "quantity": "20",
      "price": "142.3",
      "currency": "AUD",
      "totalAmount": "2846",
      "fees": "9.5",
      "tradeDate": "2026-03-10",
      "settlementDate": "2026-03-12",
      "description": null
    }
  ],
  "pagination": {
    "total": -1,
    "limit": 200,
    "offset": 0,
    "hasMore": true
  }
}

​
Trade object

FieldTypeDescription
idstringDeterministic trade identifier built from tradeDate-symbol-TYPE-totalAmount-quantity-settlementDate-fees-description. Treat as an opaque string — the format is not a stable API contract.
accountIdstringUUID of the brokerage account
accountNamestringAccount display name
symbolstringTicker symbol (e.g. VAS.AX, AAPL)
namestring | nullSecurity name
typestringOne of "buy", "sell", "dividend", "split", "transfer", "fee", "interest", or "other"
quantitystringNumber of units traded (decimal string; supports fractional shares)
pricestringPrice per unit at execution
currencystringCurrency code (e.g. AUD, USD)
totalAmountstringTotal value of the trade
feesstring | nullBrokerage fees charged
tradeDatestringDate or ISO 8601 timestamp when the trade executed — the provider passes through whatever SnapTrade returns in trade_date. May be a date-only string (YYYY-MM-DD) or a full ISO datetime depending on the broker.
settlementDatestring | nullSettlement date/timestamp — same format caveat as tradeDate
descriptionstring | nullAdditional description from the broker, if any
All monetary and quantity fields are strings to preserve decimal precision. Parse them as decimals in your application.

​
Pagination object

FieldTypeDescription
totalintegerTotal number of matching trades. Returns -1 when hasMore is true (the total is not known until all pages have been fetched). When hasMore is false, total is the exact count.
limitintegerLimit applied to this request
offsetintegerOffset applied to this request
hasMorebooleantrue if more items exist beyond this page

​
Error responses

StatusWhen
400Missing connectionId, invalid date format, or connection is not a brokerage
403API access requires a Developer or Professional plan (Saver), or professional_required for brokerage endpoints (Developer plan on a brokerage endpoint)
404Connection or account not found, or does not belong to you
503Brokerage provider temporarily unavailable. Retry later.

​
Date validation

The from and to parameters accept:
  • Date strings: 2026-03-01
  • Full ISO 8601: 2026-03-01T00:00:00Z
Invalid formats return a 400 with details: 
{
  "error": {
    "message": "Invalid date parameters",
    "details": [
      "from: Must be a valid ISO 8601 date string (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ)"
    ]
  }
}

​
Examples

​
All trades for a connection

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.redbark.co/v1/trades?connectionId=e8f1a2b3-7c4d-5e6f-8a9b-0c1d2e3f4a5b"

​
Filter by date range

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.redbark.co/v1/trades?connectionId=e8f1a2b3-7c4d-5e6f-8a9b-0c1d2e3f4a5b&from=2026-01-01&to=2026-03-31"

​
Paginate

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.redbark.co/v1/trades?connectionId=e8f1a2b3-7c4d-5e6f-8a9b-0c1d2e3f4a5b&limit=50&offset=50"

​
Python: fetch all pages

import requests

API_KEY = "YOUR_API_KEY"
BASE = "https://api.redbark.co"

all_trades = []
offset = 0
limit = 200

while True:
    resp = requests.get(
        f"{BASE}/v1/trades",
        headers={"Authorization": f"Bearer {API_KEY}"},
        params={
            "connectionId": "e8f1a2b3-7c4d-5e6f-8a9b-0c1d2e3f4a5b",
            "from": "2026-01-01",
            "to": "2026-03-31",
            "limit": limit,
            "offset": offset,
        },
    )
    data = resp.json()
    all_trades.extend(data["data"])

    if not data["pagination"]["hasMore"]:
        break
    offset += limit

print(f"Fetched {len(all_trades)} trades")

​
JavaScript: fetch all pages

const API_KEY = "YOUR_API_KEY";
const BASE = "https://api.redbark.co";

const allTrades = [];
let offset = 0;
const limit = 200;

while (true) {
  const params = new URLSearchParams({
    connectionId: "conn_abc123",
    from: "2026-01-01",
    to: "2026-03-31",
    limit: String(limit),
    offset: String(offset),
  });

  const resp = await fetch(`${BASE}/v1/trades?${params}`, {
    headers: { Authorization: `Bearer ${API_KEY}` },
  });
  const { data, pagination } = await resp.json();

  allTrades.push(...data);

  if (!pagination.hasMore) break;
  offset += limit;
}

console.log(`Fetched ${allTrades.length} trades`);