AMamberdata

Historical

Changed on

Provides historical long/short ratio data for futures instruments, including timestamps, long and short account distributions, and ratio values across exchanges.

get/futures/long-short-ratio/{instrument}

Request

  • Base URL
    https://api.amberdata.com/markets
  • URL
    https://api.amberdata.com/markets/futures/long-short-ratio/{instrument}
  • Auth
    API key in header x-api-key

Path parameters

instrumentstring required

The futures instrument for which data will be retrieved.

Query parameters

exchangestring required

The exchange for which data should be retrieved. Only 1 exchange is allowed.

startDatestring date-time

[Optional] Payload only includes data after this date (inclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

endDatestring date-time

[Optional] Payload only includes data before this date (exclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

timeFormat'milliseconds' | 'ms*' | 'iso' | 'iso8601' | 'hr' | 'human_readable'

[Optional] Time format of the timestamps in the return payload.

timeInterval'minutes' | 'hours' | 'days'

[Optional] Time interval to aggregate the historical data to.

metricType'default' | 'topTraderPositions' | 'topTraderAccounts'

[Optional] Specifies the long/short ratio metric to retrieve.

ValueDescription
defaultLong/short ratio across all accounts on the exchange. Available for all supported exchanges.
topTraderPositionsLong/short ratio by position size (dollar-weighted) among the top 20% of traders by margin balance. Reflects where the largest capital is allocated.
topTraderAccountsLong/short ratio by account count among top traders — each account counted once regardless of position size. Reflects how many large traders are bullish vs bearish.

[Supported exchanges] topTraderPositions and topTraderAccounts are only supported for binance. Requests using these values with other exchanges will return an empty response.

sortDirectionstring

[Optional] Specifies the direction in which the data is sorted (by timestamp). [Defaults] asc (ascending order). [Usage Conditions] This parameter can only be used if the startDate and endDate timeframe is within the most recent 24 hours, or if the startDate and endDate parameters are not used at all. [Examples] ascending | descending | asc | desc

Headers

Accept-Encodingstring required
api-versionstring

Response

200

statusinteger
titlestring
descriptionstring

Changes