System

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.

get/api/v1

Headers

X-Query-Validation'strict'

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

object'api_discovery' required

Changes

Changed in 16 of the 89 revisions of this API.53440

  • ece7a25b7a4422See the full diff
    • ●

      added the new freshness_ceiling_unsatisfied enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new freshness_ceiling_unsatisfied enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ●

      added the new export_expired enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new export_expired enum value to the / response property for the response status

      response-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 from Bearer API key required for data endpoints; discovery (/api/v1) health /api/v1/platforms and the MCP handshake (initialize ping tools/list on /api/v1/mcp) are public. A 401 carries WWW-Authenticate with the resource_metadata URL. to Bearer API key required for data endpoints; discovery (/api/v1) health /api/v1/platforms the Pick of the Day commitment ledger (/api/v1/pick-of-the-day/ledger) and the MCP handshake (initialize ping tools/list on /api/v1/mcp) are public. A 401 carries WWW-Authenticate with the resource_metadata URL. for the status

      response-property-const-changed

  • 1c5e270b412421See the full diff
    • ●

      added the new unknown_query_parameter enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new unknown_query_parameter enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional header request parameter X-Query-Validation

      new-optional-request-parameter

    • ●

      added the new webhook_secret_rotation_not_prepared enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new webhook_secret_rotation_not_prepared enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new webhook_secret_rotation_overlap_active enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new webhook_secret_rotation_overlap_active enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ip_rate_limited enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ip_rate_limited enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ip_throttled enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ip_throttled enum value to the / response property for the response status

      response-property-enum-value-added

  • 7b5489c2cd3e71See the full diff
    • ●

      added the new invalid_body enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_path enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new invalid_query enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new method_not_allowed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new payload_too_large enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new request_timeout enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new unsupported_media_type enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ●

      added the new insufficient_scope enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new monthly_quota_exceeded enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new api_key_in_query enum value to the / response property for the response status

      response-property-enum-value-added

  • 1b8c2226ee7b371See the full diff
    • ▲

      the response property const value changed from Bearer API key required for data endpoints; discovery (/api/v1) health and /api/v1/platforms are public. to Bearer API key required for data endpoints; discovery (/api/v1) health /api/v1/platforms and the MCP handshake (initialize ping tools/list on /api/v1/mcp) are public. A 401 carries WWW-Authenticate with the resource_metadata URL. for the status

      response-property-const-changed

    • ▲

      the response property const value partial_whale_threshold_fills was removed for the status

      response-property-const-removed

    • ▲

      the response property const value partial_whale_threshold_fills was removed for the status

      response-property-const-removed

    • ●

      added the new graded_wallet_fills enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new graded_wallet_fills enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new partial_whale_threshold_fills enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new partial_whale_threshold_fills enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new request_accounting_unavailable enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new sandbox_api_key enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new subscription_inactive enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the required property / to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog