API Reference

Browse Finatic HTTP OpenAPI operations and generated client and server SDK method references for brokerage workflows.

Use this page as the API hub. The SDK reference is the primary integration surface for Client, Node, and Python. The HTTP API tab mirrors the checked-in OpenAPI artifact for direct REST integrations.

Integration model: SDK users typically do not persist Finatic session ids — the SDK manages session lifecycle. Session ids appear in the HTTP tab for direct REST callers creating portal links and polling sync status.

Generated 9/13/2026, 12:25:29 PM · @finatic/client@1.1.0 · @finatic/server-node@1.0.2 · finatic-server-python@1.0.3

getPortalUrl

openPortalClient only

getToken

startSession

listAccounts

getAccount

listBalances

listPositions

listOrders

listTransactions

getOrder

getOrderFills

getOrderEvents

createOrder

modifyOrder

cancelOrder

getAccountOrderSchema

getAccountGrant

listAccountGrants

revokeAccountGrant

updateAccountGrant

createWebhookSubscription

getWebhookCatalog

getWebhookPayloadSchema

listWebhookSubscriptions

revokeWebhookSubscription

updateWebhookSubscription

Command Palette

API Reference

Session ManagementInitialize SDKs, open Connect, and inspect session-scoped user state.

Account dataRead financial data from granted accounts — balances, positions, orders, and transactions. Requires an accountId from listAccounts or Connect.

Account grantsPermissions your company has to a user’s financial accounts — created when the user approves access in Connect. Use these to list, update, or revoke access — not to read balances or positions.

WebhooksBrowse the webhook catalog, manage subscriptions, and verify delivery payloads.