DevelopersOsai website ↗
API v1
Get started

Pagination & recovery

Use each resource’s pagination model and preserve stable recovery checkpoints.

Customer resource pages

Transaction and trade reads use page and page_size where documented. Inspect items, page, page_size and total. Trade filters include supported date, currency, status and customer-reference dimensions.

Read a transaction pagebash
curl "$OSAI_API_BASE_URL/v1/transactions?page=1&page_size=25" \
  -H "Authorization: ApiKey $OSAI_PUBLIC_ID:$OSAI_API_SECRET"

Sequenced resources

Exchange history and book deltas use documented sequence and continuation fields. Preserve an as-of boundary when supplied. Advance a checkpoint only after durably storing the records. A cursor from one resource is not interchangeable with another resource’s page number.

Reconnect after a gap

On a reported sequence gap, read a new snapshot and resume after its sequence. Deduplicate overlapping records by stable IDs. Do not merge deltas across an unknown gap or display a stale book as current.

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.