Skip to main content

Documentation Index

Fetch the complete documentation index at: https://stabyl.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Stabyl exposes separate production and staging base URLs. API keys are environment-specific.
EnvironmentBase URLPurpose
Productionhttps://api.stabyl.com/v1Live balances, deposits, market data, and orders
Staginghttps://api-staging.stabyl.com/v1Integration testing before launch

Request Conventions

HeaderRequiredNotes
X-Api-KeyMost endpointsRequired except documented public endpoints
Content-Type: application/jsonJSON writesRequired for request bodies
Idempotency-KeyOrder writesRequired for create, cancel, and replace
Use query strings for GET filters and JSON bodies for POST, PATCH, and DELETE operations that accept a body. Send all times in UTC. Treat amount fields as decimal strings.

Simulation

Simulation endpoints are non-production utilities. They can create test deposits, test withdrawal records, test KYB states, and test product update notifications outside production. They are useful for end-to-end testing when you need deterministic activity without moving real funds.
Simulation withdrawals are testing records only. Production withdrawals are initiated from the Stabyl Pro web account.

Environment Checklist

  • Use a staging key with https://api-staging.stabyl.com/v1.
  • Use a production key with https://api.stabyl.com/v1.
  • Do not route simulation calls from production code.
  • Keep separate storage for staging and production cursors, order IDs, transaction IDs, and saved recipients.
  • Verify base URL and key environment before investigating authentication or access failures.