DevelopersOsai website ↗
API v1
Updates

Track the interfaces your integration uses.

Follow the versioned interface and capability configuration agreed for your institution.

API v1 reference

The reference covers customer financial resources, institutional identity, Console operations, exchange workflows and market-data reads. Each operation has a dedicated page with its authentication model, request fields and response definitions. This is documentation coverage, not a dated service-release history.

Contract compatibility

Preserve documented field types, amount scales, resource IDs and error codes. Read instrument capabilities before selecting an order instruction. Unknown response metadata should not break an otherwise compatible client; required application fields still need validation.

Plan for interface changes

Use the contract version and enabled capabilities provided to your institution. Coordinate changes to credential scope, permissions, event subscriptions or accounting workflows with your integration owner. Do not infer that a newly documented operation is automatically enabled for every institution.

Browse the API reference →Integration onboarding →

16 suggested pages

Get startedIntroductionIntegrate institutional FX and stablecoin trading with quotes, orders, market data, account records and settlement reporting.Get startedQuickstartMake an authenticated read, request a quote and follow an instruction without losing its original references.Get startedAuthenticationUse the correct authentication scheme for API credentials, Console sessions and market-data feeds.Get startedErrorsDistinguish invalid inputs, denied access, conflicts, rate limits and uncertain outcomes.Get startedRate limitsUse response headers, bounded concurrency and backoff rather than repeated bursts.Get startedAmounts & precisionKeep minor-unit money, fixed-point FX rates and instrument-scaled quantities exact.Get startedPagination & recoveryUse each resource’s pagination model and preserve stable recovery checkpoints.Financial workflowsQuotes & acceptanceRequest explicit FX economics, review conditions and retain accepted terms.Financial workflowsTrade lifecycleTrack funding, execution and settlement as distinct business transitions.Financial workflowsBalances & transactionsRead institutional financial positions and reconcile movements by currency.Financial workflowsBeneficiariesRegister beneficiaries and coordinate their institutional approval lifecycle.Financial workflowsCredential managementCreate, inspect, rotate and revoke application credentials without exposing secrets.Events & reliabilityIdempotencyPrevent duplicate financial effects across retries and uncertain outcomes.Events & reliabilityWebhooks & verificationVerify deliveries, persist original events and make downstream processing idempotent.Events & reliabilityEvent payloadsUnderstand the customer event envelope and business transitions behind subscriptions.Events & reliabilityDelivery retries & replayRepair webhook delivery without creating a second business event.