Developer platform

FinanceGPT API documentation

Build governed company finance, investment, quantitative, workflow and AI experiences on API v2 with explicit scopes, evidence and execution boundaries.

OpenAPI YAML ML service
API catalog Documentation SDKs ML runtime API plans
Start here

Getting started

API v2 is workspace-scoped. Sandbox and production credentials are separate.
API v2
Authentication

Bearer API key or OAuth service credential issued from the workspace developer console.

Authorization

Every operation requires an explicit product scope. Missing scopes are denied rather than silently downgraded.

Environment

Sandbox responses are deterministic fixtures and do not read production workspace data.

Authorization: Bearer <FinanceGPT API key or OAuth service token>
Accept: application/json
Governed by default. Data access, model inference and financial execution remain separately permissioned. Documentation does not imply execution authority.

Company Finance

Normalized statements, deterministic ratios, resilience, valuation and scenarios.
Available
MethodEndpointScopePurpose
GET /api/v2/companies financial:analysis:read List company finance workspaces
GET /api/v2/companies/{company}/financials financial:analysis:read Normalized periods and provenance
GET /api/v2/companies/{company}/ratios financial:analysis:read Deterministic ratio library
GET /api/v2/companies/{company}/analysis financial:analysis:read Ratios, resilience, DCF and linked forecast
POST /api/v2/companies/{company}/valuations financial:analysis:run Run explicit-assumption DCF
POST /api/v2/companies/{company}/scenarios financial:analysis:run Run deterministic scenario analysis
Example
curl -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json" \
  https://financegpt.tools/api/v2/companies/123/analysis

Data Integrations

Accounting and banking connectors with OAuth, encrypted credentials, synchronization provenance and explicit live verification.
Configuration dependent
Xero

OAuth 2.0, organisation selection, token refresh, financial reports and bank transactions.

QuickBooks Online

OAuth 2.0, report/CDC synchronization, token refresh and signed webhook intake where configured.

Plaid

Link flow, incremental Transactions Sync, balances, item health and webhook-driven refresh where configured.

Verification is explicit. Connector implementation, platform configuration, workspace authorization and the most recent live read check are represented separately. Technical integration does not imply a commercial partnership.

Investment Clients & Portfolios

Manager-scoped client relationships, portfolio records, performance measurement and governed portfolio workflows.
Governed surface

FinanceGPT separates recorded holdings from provider-backed market evidence and from broker execution. Client relationship data remains workspace-scoped and is not exposed through public client APIs unless explicitly governed.

Recorded holdings Provider-backed prices Financial plans TWR performance Portfolio construction Scenario analysis Mandate controls Execution governance Custody reconciliation
MethodEndpointScopePurpose
GET/api/v2/investment/portfolios/{portfolio}/performanceinvestment:readRead TWR runs and evidence-linked valuation subperiods.
POST/api/v2/investment/portfolios/{portfolio}/performance/observationsinvestment:runRecord opening/closing valuation and explicit external cash flow.
POST/api/v2/investment/portfolios/{portfolio}/performance/calculateinvestment:runChain-link non-overlapping subperiod returns and persist methodology evidence.

Financial Data

Canonical provider-backed financial and market data with rights and provenance controls.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

Planning

Forecast, budget and scenario operations with explicit assumptions and evidence.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

Investment Intelligence

Company, portfolio, risk, research and governance operations.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

Investment Execution

Approved order-batch preparation, pre-trade controls and reconciliation.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

Quant Models

Deterministic quantitative model catalog and governed model execution.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

Quant Compute

Bounded backtest, simulation and optimization jobs with lineage.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

ML

Approved learned-model inference with separate runtime verification and model governance.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

QLMs

Governed quantitative-language profiles combining model, evidence and tool boundaries.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

Workflows

Repeatable finance workflows, tasks, evidence and Proof-of-Value instrumentation.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

Financial Actions

Human-approved payment and collection intents with policy controls.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.

MCP

Tool proposal and governed agent integration without implicit execution authority.
Open specification

The OpenAPI document is the machine-readable contract for endpoint definitions, required scopes, request schemas and response objects. Production boundaries remain scope-gated.