Skip to content

docs/api-reference/overview.mdx's "Request shape" section omits the GET /api/:exchange/:method calling convention used throughout the rest of the API reference #2376

Open

Description

@realfishsam

Gap

docs/api-reference/overview.mdx's "Request shape" section states that every venue pass-through call has exactly one wire shape: POST /api/:exchange/:method with a JSON {"args": [...]} body. It presents this as the only calling convention. But the server also implements a GET /api/:exchange/:method route (query-string args, gated by method-verbs.json), and this GET form is in fact the primary convention demonstrated in the curl examples on nearly every generated endpoint page in the same API reference section (e.g. fetch-markets.mdx, fetch-events.mdx, fetch-ohlcv.mdx, fetch-order-book.mdx, all headed openapi: GET ...).

Core

core/src/server/app.ts:489-513 — implements the GET /api/:exchange/:method route separately from the POST route, with args taken from the query string and gated by method-verbs.json.

TypeScript SDK / Python SDK

N/A — documentation-accuracy finding.

Evidence

Read docs/api-reference/overview.mdx's "Request shape" section (POST-only claim) against core/src/server/app.ts:489-513 (GET route implementation) and the openapi: GET ... headers on docs/api-reference/fetch-markets.mdx, fetch-events.mdx, fetch-ohlcv.mdx, fetch-order-book.mdx.

Impact

A reader of the overview page — meant to be the conceptual introduction to the section — comes away believing GET requests aren't supported at all, despite GET being the form shown in curl examples throughout the very section this page introduces.


Found by automated Core-to-SDK surface coverage audit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions