API reference

OpenAPI spec

REST 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.

Tables

Stored datasets inside your workspace: read and write the rows of a table, and inspect its columns.

Dashboards

Your workspace’s dashboards: list and read them, move one into a folder or back to the top level, and set the order dashboards are listed in. Moving and ordering never change a dashboard’s content or its last-edited time.

Widgets

Your workspace’s widgets, and the rows they show: list them and read the data of a widget’s saved query, at most 500 rows, the way a dashboard renders it.

Automations

Automations over your banks, feeds and tables (preview, for invited workspaces): build a draft by commands, publish a revision, have a member approve its grant, activate it, and read its runs.

Marketplace

The BankSync Marketplace: search listings (templates, apps, widgets and the Directory) and read one listing with what it needs from a workspace.

Blueprints

Your workspace’s saved blueprints: export resources as one, save, list, read, update, delete and restore them. A blueprint is the portable form an install is made from.

Installs

Install a template into your workspace: plan an install against your banks, feeds and connections, run it, then list, read, rename, retry, update or remove installs.

Content

The workspace tree (preview, for invited workspaces): read where your automations sit, create folders, rename, set icons, move, trash, restore and star items. Reading it also lists your banks, feeds and other resources as read-only sections, each only when the key may read that resource.

Support

Support cases for your workspace, as the key’s user: list, read and open cases, reply on one and close it. Only the cases that user may see are listed; staff-only notes and actions stay in BankSync’s support console.

Syncs

Trigger data synchronization for feeds.

Jobs

Monitor sync job status and history.

Integrations

Connected integrations (Notion, Google Sheets, Airtable, Excel, databases).

Clients

A firm’s clients: its client portals and the client workspaces shared with it.

Workspace

Identity and plan for the authenticated workspace, including membership and the scopes your credential holds.

Account security

Your own sign-in security, read-only: whether two-step verification is on, whether a recovery key was saved or used, and your recent security activity. Always the account the credential acts for.

API Keys

Manage API keys for programmatic access.