API Endpoints

Complete API Reference

Explore all available API endpoints and their specifications.

API Categories

Accounts

Manage bank accounts and financial connections.

View Endpoints

Transactions

Handle financial transactions and payments.

View Endpoints

Analytics

Access financial analytics and insights.

View Endpoints

Account Endpoints

GET /api/accounts

Retrieve all connected accounts for the authenticated user.

Query Parameters: page, limit, search, accountType, status
Response: { accounts, pagination }

POST /api/accounts

Create a new account connection.

Body: { accountName, accountType, bankName, currency, ... }

GET /api/accounts/{id}

Get detailed information about a specific account.

Path Parameter: id

PUT /api/accounts/{id}

Update an existing account.

Path Parameter: id
Body: { accountName?, accountType?, ... }

DELETE /api/accounts/{id}

Remove an account connection.

Path Parameter: id

Transaction Endpoints

GET /api/transactions

Get all transactions with optional filtering.

Query Parameters: type, status, category, startDate, endDate, search, limit, offset
Response: { transactions }

POST /api/transactions

Create a new transaction.

Body: { type, amount, currency, description, accountId, ... }

GET /api/transactions/{id}

Get detailed information about a specific transaction.

Path Parameter: id

PUT /api/transactions/{id}

Update an existing transaction.

Path Parameter: id
Body: { type?, amount?, description?, ... }

DELETE /api/transactions/{id}

Delete a transaction.

Path Parameter: id

Analytics Endpoints

GET /api/analytics

Get comprehensive financial analytics and overview metrics.

Query Parameters: period (30d), metric (overview)
Response: { period, metric, data: { overview, revenue, expenses, performance } }

GET /api/analytics/revenue

Get revenue analytics and trends.

Query Parameters: period (12months)
Response: { analytics }

GET /api/analytics/expenses

Get expense analytics and breakdowns.

Response: { analytics }

GET /api/analytics/performance

Get performance metrics and KPIs.

Response: { metrics }

GET /api/analytics/clients

Get client analytics and statistics.

Response: { totalClients, activeClients, newClientsThisMonth, clientRetention, satisfactionScore }

Ready to Start Building?

Explore our SDKs and client libraries to get started quickly.

View SDKs