Getting Data

Learn how to retrieve account-scoped balances, orders, positions, transactions, and sync status.

Once the session is initialized and the user has approved read permissions on a financial account grant, you can retrieve accounts, balances, positions, transactions, orders, and lots with a consistent API shape.

Overview

The most common read methods are:

  • finatic.v1.listAccounts()
  • finatic.v1.listBalances({ accountId })
  • finatic.v1.listPositions({ accountId })
  • finatic.v1.listTransactions({ accountId })
  • finatic.v1.listOrders({ accountId })

Each SDK call returns the standard Finatic response envelope. Store the response trace ID with support logs and user-visible failures.

Get Accounts

Retrieve accounts granted to your company:

Account filters

Account list filters are company/grant scoped. Use resource-specific filters after you choose an accountId.

  • brokerId (string, optional): Filter by broker (for example, alpaca or tastytrade).
  • accountType (string, optional): Filter by account type.
  • status (string, optional): Filter by account status.
  • currency (string, optional): Filter by currency code.
  • limit (number, optional): Number of results to return.
  • offset (number, optional): Number of results to skip.

Get Balances

Retrieve balances for one financial account:


Get Positions

Retrieve positions for one financial account:


Get Orders

Retrieve orders for one financial account:


Transactions and lots

Sync status, pagination, and responses

Sync status (server only)

Pagination — pass limit and offset on list calls.

See Standard Response Object and Error Handling.

Next