public/get_apr_history

Retrieves historical Annual Percentage Rate (APR) data for yield-generating tokens. APR represents the annualized return rate for holding these tokens on Deribit.

This method is only applicable to yield-generating tokens: USDE, STETH, USDC, and BUILD. Use the limit parameter to specify the number of days to retrieve (default 365, maximum 365), and before to retrieve APR history before a specific epoch day.

📖 Related Support Article: Yield reward-bearing coins

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/public/get_apr_history \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "public/get_apr_history",
  "params": {
    "currency": "steth",
    "limit": 5
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/public/get_apr_history"

payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "public/get_apr_history",
    "params": {
        "currency": "steth",
        "limit": 5
    }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 1,
    method: 'public/get_apr_history',
    params: {currency: 'steth', limit: 5}
  })
};

fetch('https://test.deribit.com/api/v2/public/get_apr_history', 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://test.deribit.com/api/v2/public/get_apr_history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 1,
    'method' => 'public/get_apr_history',
    'params' => [
        'currency' => 'steth',
        'limit' => 5
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://test.deribit.com/api/v2/public/get_apr_history"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"public/get_apr_history\",\n  \"params\": {\n    \"currency\": \"steth\",\n    \"limit\": 5\n  }\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/public/get_apr_history")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"public/get_apr_history\",\n  \"params\": {\n    \"currency\": \"steth\",\n    \"limit\": 5\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/public/get_apr_history")

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

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"public/get_apr_history\",\n  \"params\": {\n    \"currency\": \"steth\",\n    \"limit\": 5\n  }\n}"

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

200

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "data": [
      {
        "day": 20200,
        "apr": 2.814
      },
      {
        "day": 20199,
        "apr": 2.749
      },
      {
        "day": 20198,
        "apr": 2.684
      },
      {
        "day": 20197,
        "apr": 2.667
      },
      {
        "day": 20196,
        "apr": 2.722
      }
    ],
    "continuation": 20196
  }
}

Query Parameters

currency · enum<string> · required

Currency for which to retrieve APR history

Available options: usde, steth, usdc, build

Example:

"steth"

limit · integer

Number of days to retrieve (default 365, maximum 365)

Example:

5

before · integer

Used to receive APR history before given epoch day

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. data · object[] · required

Hide child attributes

result.data. day · integer

The full epoch day

result.data. apr · number

The APR of the day

result. continuation · string

Continuation token for pagination.

Example:

"xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT"

id · integer

The id that was sent in the request