Guides
Core concepts that apply to both the REST API and MCP server. Start here to understand authentication, data types, and error handling.
Authentication
API keys, bearer tokens, scopes, and permissions
Resources & Types
Banks, accounts, transactions, feeds, jobs, and more
Error Handling
Status codes, error format, and troubleshooting
Getting Started
New to the BankSync API? Follow these steps to go from zero to your first API call.
Create an API key
Open the BankSync app, navigate to Workspace menu → Developers, and generate a key with the scopes you need. See the Authentication guide for details.
Understand the data model
BankSync organises data as Workspace → Banks → Accounts → Transactions/Balances/Trades/Holdings/Loans, plus Feeds and Jobs for syncing. Read the Resources & Types guide for the full picture.
Make your first request
Use the REST API reference to explore endpoints interactively, or connect an AI agent via the MCP server.