API Reference

Build powerful financial applications with Finceos API. Access AI-powered document analysis, transaction management, and intelligent insights.

API Features

Everything you need to build amazing financial applications

RESTful API

Clean, predictable URLs and standard HTTP response codes

Real-time Webhooks

Get notified instantly when events occur in your account

Comprehensive Documentation

Detailed guides, examples, and interactive API explorer

Rate Limiting

Fair usage policies with clear limits and error messages

Getting Started

Start building with Finceos API in minutes

1

Get API Keys

Sign up for a Finceos account and generate your API keys from the developer dashboard.

curl -H "Authorization: Bearer YOUR_API_KEY" \
    https://api.finceos.com/v1/user/profile
2

Install SDK

Use our official SDKs for faster development and better type safety.

npm install @finceos/sdk
3

Make Your First Request

Upload a document and get AI-powered analysis results.

const finceos = new Finceos({apiKey: 'your-api-key'});
const analysis = await finceos.documents.analyze(file);

API Endpoints

Complete reference of available endpoints

Authentication

POST/api/auth/login

Authenticate user and receive access token

User Management

GET/api/user/profile

Get current user profile information

Document Processing

POST/api/documents/upload

Upload financial document for AI analysis

GET/api/documents/{id}/analysis

Get AI analysis results for a document

Financial Data

GET/api/transactions

List user transactions with filtering options

POST/api/transactions/categorize

Automatically categorize transactions using AI

AI Insights

GET/api/insights/spending

Get AI-powered spending insights and recommendations

Budgeting

GET/api/budgets

Get user budgets and spending limits

SDKs & Libraries

Official libraries for popular programming languages and frameworks

JavaScript/Node.js

Official SDK for JavaScript and Node.js applications

npm install @finceos/sdk

Python

Python SDK for data analysis and backend integration

pip install finceos-python

React Components

Pre-built React components for quick integration

npm install @finceos/react

Mobile SDKs

Native SDKs for iOS and Android applications

Coming soon

Need Help?

Get support from our developer-friendly team