HeyTraders Documentation

Market Feeds Research API

Market Feed operations expose derivatives data gathered across supported exchanges. Every operation requires research and completes synchronously.

Operations

MethodPathRequired scopePurpose
GET/v1/research/funding-ratesresearchRead current funding-rate rows by exchange
GET/v1/research/open-interestresearchRead open-interest rows by exchange
GET/v1/research/long-short-ratioresearchRead Binance Futures account ratio for one symbol

Symbols and response semantics

Multi-exchange resources map exchange identifiers to arrays of provider rows. Preserve the map key because similarly named symbols can represent different contracts. The long/short route uses the Binance Futures symbol format defined in OpenAPI; do not reuse a spot symbol without validation.

The open-interest aggregation includes exchanges that expose a native bulk OI snapshot. Binance Futures exposes current OI per symbol instead; use GET /v1/market/open-interests for its bounded symbol fan-out.

Funding rate, open interest and ratio records describe market observations, not account positions or executable quotes. Keep source exchange and timestamp with every value. Empty rows mean the synchronous downloader completed without matching data; they are not interchangeable with a failed download.

Failures

Downloader timeout returns 504 UPSTREAM_TIMEOUT, unavailable downloader infrastructure returns 503 UPSTREAM_UNAVAILABLE, and a failed or malformed provider result returns a 502 error. Retry only idempotent GET requests and retain the original query parameters when doing so.