HeyTraders Documentation

Exchanges API

Use this API to discover canonical exchange IDs, connection metadata, and the tradable ticker catalog. Do not infer orderable symbols from market-news or CMC discovery data.

Operations

MethodPathRequired scopePurpose
GET/v1/exchangespublicList supported live exchanges
GET/v1/exchanges/{exchange_name}publicRead one exchange and its credential metadata
GET/v1/exchanges/{exchange_name}/credential-schemapublicRead the dynamic credential field definition
GET/v1/exchanges/{exchange_name}/tickerspublicRead the venue's canonical tradable ticker universe

Symbol discovery

Ticker rows expose the canonical ticker, venue symbol, precision, market namespace, settlement asset, collateral, and readiness fields. Before an order:

  1. Select an exchange returned by GET /v1/exchanges.
  2. Fetch its tickers, optionally with namespace for namespaced Hyperliquid markets.
  3. Require is_tradable=true; inspect market_status and status_reason when false.
  4. Preserve the returned ticker or exact symbol rather than rebuilding it.

The ticker response uses X-Total-Count, X-Returned-Count, X-Exchange, and, when applicable, X-Market-Namespace headers. limit truncates returned rows but does not change the total count.

Credentials boundary

Credential schemas describe the fields and account types the HeyTraders web connection flow will request. They can contain nested choices and encrypted fields. Public external-agent routes do not accept raw venue secrets. Ask the human to connect or update credentials in the HeyTraders browser, then discover the resulting account through GET /v1/accounts.

Current public identifiers and venue-specific connection guidance are also available under the supported-exchanges/... documentation topics.