API explorer
An interactive, always-current reference for the entire Boursa API, rendered directly from the authoritative openapi.yaml with Redoc. Every endpoint, parameter, request body, and response shape — the same spec the platform serves and the @boursa/sdk client is typed against.
The explorer opens full-screen so Redoc's three-pane layout (navigation, documentation, request/response samples) has room to breathe. It is a static render — no keys, no live calls — so it is safe to browse and link to.
What you'll find there
- Authentication & conventions — Bearer auth, the HMAC signing scheme for money endpoints, idempotency, integer micros, pagination, and the bilingual error envelope, all in the spec's
infosection. - Every resource — KYC onboarding, accounts/investors, orders and contract notes, transfers, fund orders, instruments and market data, portfolio analytics, reports, branding, and webhooks.
- The exact request/response schemas the API uses, with the EGX-specific decisions (price bands, ticks, whole shares, T+2) documented inline.
Prefer curated pages?
The hand-written reference in this section (Orders, Accounts, Errors, …) and the Guides add narrative and worked examples on top of the spec. The explorer is the complete, generated counterpart — reach for whichever fits the moment.
Download the spec
The raw spec is available at /openapi.yaml — point your own codegen, Postman, or Insomnia at it.