API reference

Integrate trading and financial operations.

Find authentication, request fields and response definitions for quotes, orders, market data, accounts and settlement records.

Customer financial APIs use API keys. Console and exchange workflows use approved institutional sessions. Market-data feeds use scoped bearer credentials. Access and enabled workflows are configured for your institution.

Accounts

GETHealth check/v1/healthGETGet institution balances/v1/balancesGETList institution transactions/v1/transactions

Route status

GETGet entitled customer facing route availability and capabilities/v1/providers/status

Beneficiaries

POSTRegister an institution beneficiary for review/v1/beneficiaries

Webhooks

POSTConfigure the institution's signed customer webhook endpoint/v1/webhook-endpointsPOSTQueue another delivery attempt for an existing customer event/v1/webhook-deliveries/{event_id}/replay

Credentials

POSTCreate an environment scoped API credential/v1/credentialsGETList institution credential metadata/v1/credentialsGETGet institution credential metadata/v1/credentials/{public_id}DELETERevoke an institution credential/v1/credentials/{public_id}POSTRotate an active institution credential/v1/credentials/{public_id}/rotate

Quotes

POSTCreate a quote/v1/quotesGETGet quote by ID/v1/quotes/{quote_id}POSTAccept a quote/v1/quotes/{quote_id}/accept

Trades

GETList institution trades/v1/tradesGETGet trade by ID/v1/trades/{trade_id}

Settlement reports

GETGet settlement by ID/v1/settlements/{settlement_id}GETList terminal settlement outcomes for the institution/v1/reports/settlements

Company access

POSTStart Login/api/auth/startPOSTStart Step Up/api/auth/step-upGETRead Session/api/auth/sessionPOSTRevoke Session/api/auth/logoutGETOne time state and browser bound OIDC callback/api/auth/callbackGETList Members/v1/console/membersGETList Roles/v1/console/rolesPOSTChange Membership/v1/console/members/changeGETRead Audit/v1/console/auditPOSTCreate Invitation/v1/console/invitationsGETList Invitations/v1/console/invitationsGETRead Invitation/v1/console/invitations/{invitation}POSTCancel Invitation/v1/console/invitations/{invitation}/cancelGETResolve Company Workspace/api/auth/company/{slug}POSTStart Company Login/api/auth/company/{slug}/startPOSTExplicitly replace an invitation token and queue a new delivery generation/v1/console/invitations/{invitation}/reissuePOSTSubmit Access Application/v1/access-applicationsPOSTVerify Application Email/v1/access-applications/verify-email

Console operations

Exchange

Market data

GETDiscover scoped candle series and read semantics, not executable instruments/v1/exchange/candle-seriesGETGet exchange candles/v1/exchange/candlesGETGet exchange source health/v1/exchange/source-health