Developer quickstart

Copy-paste these steps with the backend API running locally (default port 3002).

0) Prerequisite

Start the stack from the repo root (see Start in 5 minutes). You need a reachable API base URL:

export QD_API=http://localhost:3002

For production or staging, replace QD_API with your deployed gateway origin (same paths under /api).

1) Verify the gateway

curl -s "$QD_API/health"

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

2) Open interactive API docs (schema truth)

In the browser, open: {QD_API}/api/docs/ — for example http://localhost:3002/api/docs/ Use Swagger for request/response shapes, parameters, and authentication requirements. This docs site stays narrative-only for HTTP fields.

3) Download the OpenAPI document

The gateway exposes the machine-readable spec here:

curl -s "$QD_API/api/docs/swagger" -o openapi.json

Inspect metadata:

jq '.info' openapi.json

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

4) First API call (no auth)

Development market overview (useful for integrations and debugging):

curl -s "$QD_API/api/dev/market-summary" | jq .

You should see success and a data.markets array when the database and oracle paths are healthy.

5) Next steps (Coinbase-style funnel)

Step	Page
Secure requests	Authentication
Patterns and boundaries	API overview
Streaming updates	WebSockets overview
Errors and throttling	Errors and rate limits
Terminal context	Trading overview

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

Strategy collaboration spaces for trading teams Parsing the PortfolioAccount zero-copy buffer

⌘I

​Developer quickstart

​0) Prerequisite

​1) Verify the gateway

​2) Open interactive API docs (schema truth)

​3) Download the OpenAPI document

​4) First API call (no auth)

​5) Next steps (Coinbase-style funnel)