API reference
OpenAPI specREST API for BankSync (v1.0.0). Generated from the live OpenAPI 3.1 spec, so it never drifts from the routes. Expand any endpoint for parameters, a response example, copyable cURL/JavaScript/Python, and an in-page Try It.
Base URL
https://api.banksync.ioProduction
Authentication
X-API-KeyAPI key — pass in the X-API-Key header. Obtain from Developer Settings in the BankSync app.Authorization: Bearer <token>Firebase ID token — pass as a Bearer token in the Authorization header.
Banks
Manage bank connections linked to your workspace. Each bank represents a connection to a financial institution via Plaid, SaltEdge, or SnapTrade.
Accounts
Retrieve live account data for a bank connection, fetched directly from the financial institution.
Transactions
Query bank transactions with date range or cursor-based pagination.
Balances
Fetch live account balances directly from the institution.
Trades
Investment trades: buys, sells, dividends, and other investment transactions.
Holdings
Current investment portfolio positions and market values.
Orders
Open and pending brokerage orders for an investment account.
Loans
Loan and liability details including balances, rates, and payment schedules.
Feeds
Data pipeline configurations that sync financial data to your connected integrations.
Enrichments
Transformation rules that clean and categorize transaction data before it syncs.
Syncs
Trigger data synchronization for feeds.
Jobs
Monitor sync job status and history.
Integrations
Connected integrations (Notion, Google Sheets, Airtable, Excel, databases).
Workspace
Identity and plan for the authenticated workspace, including membership and the scopes your credential holds.
API Keys
Manage API keys for programmatic access.