Getting Data
Learn how to retrieve account-scoped balances, orders, positions, transactions, and sync status.
Copy a read after Connect has created a durable grant. Use the financial accountId from listAccounts (or from account.grant.created). Keep your company API key on the backend.
The Client SDK returns { success, error, warning }. Server Node and Python return { traceId, data, warnings, errors }.
listAccounts
Retrieve accounts granted to your company. After a new Connect flow, wait for account.grant.created before expecting the new account in this list, and check syncStatus before account-scoped reads:
companyAccountId is your tenant. Never pass it as {accountId} — the API returns ACCOUNT_ID_TYPE_MISMATCH.
Account pagination
Account lists are company/grant scoped. Use limit and offset for pagination, and request sync status when deciding whether a newly granted account is ready.
- limit (number, optional): Number of results to return. - offset (number, optional): Number of results to skip. - includeSyncStatus / include_sync_status (boolean, optional): Include account sync state.
---
## listBalances
Retrieve balances for one financial account:
---
## listPositions
Retrieve positions for one financial account:
---
## listOrders
Retrieve orders for one financial account:
---
## Transactions and lots
Position-lot reads are not exposed by the published v1 facades. Use the released account positions response instead of documenting a non-existent listPositionLots helper.
Sync status, pagination, and responses
Sync status (server only) — aggregate pending means no selected accounts are visible yet, syncing means at least one account is still working, reauth_required means at least one selected account needs the user to reauthenticate, failed means at least one account failed, and ready means the selected accounts are ready for reads. Stop polling and send the user back through Connect when reauthentication is required. Provider timing varies; poll this state rather than sleeping for a fixed interval.
The released server facades do not yet wrap this endpoint. Call it directly with X-API-Key:
Pagination — pass limit and offset on list calls.
See Standard Response Object and Error Handling.
## Next
- Trading - Webhooks - API Reference