Get candles

Get historical candles

curl --request GET \
  --url https://perps.yield.xyz/v1/markets/{marketId}/candles \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://perps.yield.xyz/v1/markets/{marketId}/candles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://perps.yield.xyz/v1/markets/{marketId}/candles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://perps.yield.xyz/v1/markets/{marketId}/candles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://perps.yield.xyz/v1/markets/{marketId}/candles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "marketId": "hyperliquid-btc-usdc",
  "interval": "1h",
  "candles": [
    {
      "openTime": 1704067200000,
      "closeTime": 1704070799999,
      "open": "42150.5",
      "high": "42500.0",
      "low": "42000.0",
      "close": "42350.25",
      "volume": "1234.56",
      "trades": 482
    }
  ]
}

{
  "statusCode": 401,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Invalid API key",
  "details": {
    "message": "Invalid API key",
    "code": "AUTH_INVALID_API_KEY"
  }
}

{
  "statusCode": 429,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Rate limit exceeded",
  "details": {
    "message": "Rate limit exceeded",
    "code": "RATE_LIMIT_EXCEEDED",
    "error": "Too Many Requests",
    "retryAfter": 30
  }
}

GET

markets

{marketId}

candles

Get historical candles

curl --request GET \
  --url https://perps.yield.xyz/v1/markets/{marketId}/candles \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://perps.yield.xyz/v1/markets/{marketId}/candles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://perps.yield.xyz/v1/markets/{marketId}/candles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://perps.yield.xyz/v1/markets/{marketId}/candles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://perps.yield.xyz/v1/markets/{marketId}/candles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "marketId": "hyperliquid-btc-usdc",
  "interval": "1h",
  "candles": [
    {
      "openTime": 1704067200000,
      "closeTime": 1704070799999,
      "open": "42150.5",
      "high": "42500.0",
      "low": "42000.0",
      "close": "42350.25",
      "volume": "1234.56",
      "trades": 482
    }
  ]
}

{
  "statusCode": 401,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Invalid API key",
  "details": {
    "message": "Invalid API key",
    "code": "AUTH_INVALID_API_KEY"
  }
}

{
  "statusCode": 429,
  "timestamp": "2026-05-04T12:00:00.000Z",
  "path": "/v1/actions",
  "message": "Rate limit exceeded",
  "details": {
    "message": "Rate limit exceeded",
    "code": "RATE_LIMIT_EXCEEDED",
    "error": "Too Many Requests",
    "retryAfter": 30
  }
}

interval and from are required; from and to are Unix timestamps in milliseconds and to defaults to the current interval boundary. A request returns at most 5000 candles: when the range is wider, the most recent 5000 before to are returned. To read a longer history, request windows of at most 5000 intervals and move both from and to. Prices and volume are decimal strings; volume is in base asset units. This is a plain GET; the Perps API has no streaming price feed.

Authorizations

x-api-key

string

header

required

Path Parameters

marketId

string

required

The market identifier

Example:

"hyperliquid-btc-usdc"

Query Parameters

interval

enum<string>

required

Available options:

1m,

5m,

15m,

1h,

4h,

1d

Example:

"1h"

from

number

required

Start time (unix milliseconds)

Example:

1704067200000

number

End time (unix milliseconds)

Example:

1704153600000

Response

Candle data

marketId

string

required

Example:

"hyperliquid-btc-usdc"

interval

enum<string>

required

Available options:

1m,

5m,

15m,

1h,

4h,

1d

Example:

"1h"

candles

object[]

required

Show child attributes

⌘I

Getting started

Earn

Trade

Borrow

Authorizations

Path Parameters

Query Parameters

Response