List exchanges

GET https://rest.haasapi.com/v1/exchanges

Returns every supported exchange. The exchange value is what the /v1/markets filter accepts and the first segment of every market_tag; spot and futures venues of one exchange are separate codes grouped by family.

Requires the read scope.

Example request

curl "https://rest.haasapi.com/v1/exchanges" \
  -H "Authorization: Bearer hk_live_YOUR_KEY"

Response

200 OK. Returns a ExchangesPage.

{
  "data": [
    {
      "exchange": "BINANCE",
      "name": "Binance",
      "family": "Binance",
      "spot": true,
      "margin": false,
      "futures": false,
      "website": "https://haas.bot/binance"
    },
    {
      "exchange": "BINANCEQUARTERLY",
      "name": "Binance COIN Futures",
      "family": "Binance",
      "spot": false,
      "margin": false,
      "futures": true,
      "website": "https://haas.bot/binance"
    }
  ]
}

Fields

ExchangesPage

Field	Type	Description
data	array of Exchange	Every supported exchange.

Exchange

Field	Type	Description
exchange	string	Exchange code - the value the exchange filter on /v1/markets accepts, and the first segment of every market_tag.
name	string	Human-readable exchange name.
family	string	Groups related codes: an exchange’s spot and futures venues are separate codes in the same family (e.g. BINANCE and BINANCEQUARTERLY are both family Binance).
spot	boolean	Whether the venue trades spot markets.
margin	boolean	Whether the venue supports margin trading.
futures	boolean	Whether the venue trades leveraged derivatives - its markets carry a contract object.
website	string, nullable	The exchange’s website; null when not published.

Errors

All errors are RFC 9457 problem documents.

Status	Description
400	The request is malformed (invalid limit, unusable cursor, …). (code: invalid_request)
401	Missing, malformed, disabled, or revoked API key. (code: invalid_api_key)
500	An unexpected error inside the API. Nothing about the request caused it; retry, and quote the instance value if it persists. (code: internal_error)
502	An internal service answered in a way the API could not serve. Retry. (code: upstream_error)
503	The request could not be served right now. Retry with the same key - do not discard it. (code: temporarily_unavailable)
504	An internal service did not answer within the deadline. Retry with backoff. (code: upstream_timeout)

{
  "type": "https://docs.haasapi.com/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request is malformed (invalid limit, unusable cursor, …).",
  "code": "invalid_request"
}