Get Volume Analytics

GET https://api.sfox.com/v1/analytics/volume

Retrieve historical exchange volume analytics by currency.

circle-info

Data is not forward-filled and, therefore, may be incomplete. e.g. no data will be returned for an interval during which 0 trades were recorded.

circle-exclamation

Query Parameters

Name
Type
Description

start_time required

timestamp

Unix timestamp (ms) of the first datapoint to return

end_time

timestamp

Unix timestamp (ms) of the last datapoint to return

interval required

int

Duration of each datapoint in seconds (i.e. interval = 86400 = daily volume data)

(60 | 3600 | 86400)

currency required

string

The currency to retrieve data for (i.e. eth)

net

boolean

Retrieve "net volume" (net buy/sell volume) or "gross volume" (total traded volume)

(true | false)

default = false

by_exchange

boolean

Retrieve total market volume or volume by exchange

(true | false) default = false

Response Body

Key
Description

timstamp

The Unix timestamp (ms) of the beginning of the interval

exchange

The exchange associated with the volume data (only returned if by_exchange = true in the request)

volume

The quantity of the specified currency traded during this interval

usd_notional

The USD value of the quantity of the specified currency traded during this interval

Responses

chevron-right200: Gross Volumehashtag
chevron-right200: Net Volumehashtag
chevron-right200: Gross Volume by Exchangehashtag
chevron-right200: Net Volume by Exchangehashtag
chevron-right401: Unauthorizedhashtag
chevron-right422: Unprocessable Entityhashtag

Example Request

Last updated