Skip to main content

​
Developer quickstart

Copy-paste these steps with the backend API running and reachable.
Start the stack from the repo root first — see Start in 5 minutes.
1

Set your API origin

Point QD_API at your own gateway origin if you run the stack yourself (same paths under /api).
2

Verify the gateway

Expect JSON indicating the service is up. If this fails, fix networking or process startup before continuing.
3

Open interactive API docs

In the browser, open:$QD_API/api/docs/ — for example https://api.quantdesk.app/api/docs/Use Swagger for request/response shapes, parameters, and authentication requirements. This docs site stays narrative-only for HTTP fields.
4

Download the OpenAPI document

Regenerate openapi.json whenever you need an offline reference or codegen input.
5

Make your first API call

Development market overview (useful for integrations and debugging):
You should see success and a data.markets array when the database and oracle paths are healthy.

​
Next steps

Authentication

Secure requests with SIWS and bearer tokens.

API overview

Patterns, boundaries, and integration funnel.

Building on QuantDesk

On-chain place_order_v2 walkthrough.

WebSockets

Socket.IO streaming updates.
Do not duplicate full endpoint tables from Swagger into Markdown — link Swagger and keep examples short here.