Skip to main content
POST
/
v1
/
info
/
candleSnapshot
Get Candle Data
curl --request POST \
  --url https://api.hypereth.io/v1/info/candleSnapshot \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "candleSnapshot",
  "req": {
    "coin": "BTC",
    "interval": "1h",
    "startTime": 1681920000000,
    "endTime": 1681923600000
  }
}
'
[
  {
    "T": 1681923600000,
    "o": "43200.0",
    "h": "43350.5",
    "l": "43150.0",
    "c": "43250.0",
    "v": "125.75",
    "n": 47
  }
]

Body

application/json
​
type
enum<string>
required

Request type identifier

Available options:
candleSnapshot
​
req
object
required

Response

Array of price candles

​
T
integer<int64>
required

Candle start time timestamp in milliseconds. Represents the beginning of the time interval.

Example:

1681923600000

​
o
string
required

Opening price for the time period

Example:

"43200.0"

​
h
string
required

Highest price during the time period

Example:

"43350.5"

​
l
string
required

Lowest price during the time period

Example:

"43150.0"

​
c
string
required

Closing price for the time period

Example:

"43250.0"

​
v
string
required

Volume traded during the time period. Represents the total amount of the base asset traded.

Example:

"125.75"

​
n
integer

Number of trades during the time period

Example:

47