API Documentation

Integrate FinAItics into your applications with our powerful RESTful API. Build custom dashboards, automate workflows, and access real-time financial data.

Quick Start

Get up and running with the FinAItics API in minutes

1. Get API Key

Generate your API key from the dashboard settings

2. Make Request

Use our SDK or make HTTP requests to our endpoints

3. Build Amazing

Create powerful financial applications and workflows

API Reference

Complete reference for all available endpoints

GET
/api/v1/cashflow/forecast

Get cash flow forecast data for a specified time period

start_date
string
Required
Start date (YYYY-MM-DD)
end_date
string
Required
End date (YYYY-MM-DD)
granularity
string
Optional
daily, weekly, monthly (default: weekly)
GET
/api/v1/metrics/summary

Get key financial metrics and KPIs

period
string
Optional
30d, 90d, 1y (default: 30d)
POST
/api/v1/integrations/sync

Trigger a manual sync for connected integrations

integration_id
string
Required
ID of the integration to sync
force
boolean
Optional
Force sync even if recently synced
GET
/api/v1/alerts

List active alerts and notifications

status
string
Optional
active, resolved, all (default: active)
type
string
Optional
cash_flow, sync, security

SDKs & Libraries

Official SDKs and community libraries for popular programming languages

JavaScript/Node.js

Official JavaScript SDK for browser and Node.js environments

Installation

npm install finaitics-sdk

Example Usage

const FinAItics = require('finaitics-sdk');

const client = new FinAItics({
  apiKey: 'your-api-key',
  environment: 'production' // or 'sandbox'
});

const forecast = await client.cashflow.getForecast({
  startDate: '2024-01-01',
  endDate: '2024-03-31'
});

Python

Official Python SDK with async/await support

Installation

pip install finaitics-python

Example Usage

import finaitics

client = finaitics.Client(
    api_key='your-api-key',
    environment='production'
)

forecast = client.cashflow.get_forecast(
    start_date='2024-01-01',
    end_date='2024-03-31'
)

cURL

Direct HTTP requests using cURL

Installation

Available on all systems

Example Usage

curl -X GET 'https://api.finaitics.com/v1/cashflow/forecast'   -H 'Authorization: Bearer your-api-key'   -H 'Content-Type: application/json'   -d '{
    "start_date": "2024-01-01",
    "end_date": "2024-03-31"
  }'

Authentication

Secure API access using Bearer token authentication

API Key Authentication

All API requests must include your API key in the Authorization header as a Bearer token.

Request Headers

Authorization: Bearer your-api-key-here
Content-Type: application/json

Security Best Practices

  • Never expose your API key in client-side code
  • Use environment variables to store API keys
  • Rotate API keys regularly
  • Use different keys for different environments

Rate Limits & Environments

API usage limits and testing environments

Rate Limits

Starter Plan1,000 requests/hour
Professional Plan10,000 requests/hour
Enterprise PlanCustom limits

Rate limit headers are included in all responses to help you track usage.

Environments

Production
api.finaitics.com

Live data and real integrations

Sandbox
sandbox-api.finaitics.com

Test data for development

Need Help?

Our developer support team is here to help you integrate successfully.

Response time: 24 hours • Available Mon-Fri 9am-5pm PST