API discovery
Unauthenticated API-origin discovery document pointing agents to the canonical API base URL, full docs, web-origin OpenAPI spec, health check, and the COMPLETE index of authenticated data routes. data.authenticated_routes is the whole authenticated route surface, not a sample: it carries every authenticated route this spec documents, so an agent that starts here never has to guess a path. The index is a hand-maintained const in backend/src/api_v1/discovery.rs kept in step with this spec by review; no automated check compares the two, so treat this spec as authoritative if they ever disagree.
Headers
Opt into strict query-name validation. The default is compatible: unknown names are ignored and reported in X-Query-Ignored. With strict, an unknown name returns 400 bad_request with error.reason unknown_query_parameter before the handler runs, including when its percent escape is incomplete.
Response
API discovery document
Changes
Changed in 16 of the 89 revisions of this API.53440
- ●
added the new
freshness_ceiling_unsatisfiedenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
freshness_ceiling_unsatisfiedenum value to the/response property for the response statusresponse-property-enum-value-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ●
- ●
added the new
export_expiredenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
export_expiredenum value to the/response property for the response statusresponse-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
the
response property const value changed fromBearer API key required for data endpoints; discovery (/api/v1)health/api/v1/platformsand the MCP handshake (initializepingtools/list on /api/v1/mcp) are public. A 401 carries WWW-Authenticate with the resource_metadata URL.toBearer API key required for data endpoints; discovery (/api/v1)health/api/v1/platformsthe Pick of the Day commitment ledger (/api/v1/pick-of-the-day/ledger)and the MCP handshake (initializepingtools/list on /api/v1/mcp) are public. A 401 carries WWW-Authenticate with the resource_metadata URL.for the statusresponse-property-const-changed
- ▲
- ●
added the new
unknown_query_parameterenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
unknown_query_parameterenum value to the/response property for the response statusresponse-property-enum-value-added
- ○
added the new optional
headerrequest parameterX-Query-Validationnew-optional-request-parameter
- ●
- ●
added the new
webhook_secret_rotation_not_preparedenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
webhook_secret_rotation_not_preparedenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
webhook_secret_rotation_overlap_activeenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
webhook_secret_rotation_overlap_activeenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
- ●
added the new
ip_rate_limitedenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
ip_rate_limitedenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
ip_throttledenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
ip_throttledenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
- ●
added the new
invalid_bodyenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
invalid_pathenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
invalid_queryenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
method_not_allowedenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
payload_too_largeenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
request_timeoutenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
unsupported_media_typeenum value to the/response property for the response statusresponse-property-enum-value-added
- ○
added the media type
application/jsonfor the response with the statusresponse-media-type-added
- ●
- ●
added the new
insufficient_scopeenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
monthly_quota_exceededenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
- ●
added the new
api_key_in_queryenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
- ▲
the
response property const value changed fromBearer API key required for data endpoints; discovery (/api/v1)healthand /api/v1/platforms are public.toBearer API key required for data endpoints; discovery (/api/v1)health/api/v1/platformsand the MCP handshake (initializepingtools/list on /api/v1/mcp) are public. A 401 carries WWW-Authenticate with the resource_metadata URL.for the statusresponse-property-const-changed
- ▲
the
response property const valuepartial_whale_threshold_fillswas removed for the statusresponse-property-const-removed
- ▲
the
response property const valuepartial_whale_threshold_fillswas removed for the statusresponse-property-const-removed
- ●
added the new
graded_wallet_fillsenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
graded_wallet_fillsenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
partial_whale_threshold_fillsenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
partial_whale_threshold_fillsenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
request_accounting_unavailableenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
sandbox_api_keyenum value to the/response property for the response statusresponse-property-enum-value-added
- ●
added the new
subscription_inactiveenum value to the/response property for the response statusresponse-property-enum-value-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲