Get yield risk

Get risk ratings for a yield

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/risk \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.yield.xyz/v1/yields/{yieldId}/risk', 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://api.yield.xyz/v1/yields/{yieldId}/risk",
  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://api.yield.xyz/v1/yields/{yieldId}/risk"

	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://api.yield.xyz/v1/yields/{yieldId}/risk")

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

{
  "updatedAt": "<string>",
  "credora": {
    "rating": {},
    "score": {},
    "psl": {},
    "publishDate": {},
    "curator": {}
  },
  "stakingRewards": {
    "rating": {},
    "score": {},
    "potentialRating": {},
    "potentialScore": {},
    "ratedAt": {},
    "ratedSince": {},
    "profileUrl": {},
    "reportUrl": {},
    "providerName": {},
    "version": {},
    "type": {},
    "chain": {},
    "contractAddress": {},
    "riskMetrics": {
      "users": {}
    }
  }
}

{
  "message": "Validation failed",
  "error": "Bad Request",
  "statusCode": 400
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500
}

GET

yields

{yieldId}

risk

Get risk ratings for a yield

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/risk \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.yield.xyz/v1/yields/{yieldId}/risk', 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://api.yield.xyz/v1/yields/{yieldId}/risk",
  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://api.yield.xyz/v1/yields/{yieldId}/risk"

	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://api.yield.xyz/v1/yields/{yieldId}/risk")

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

{
  "updatedAt": "<string>",
  "credora": {
    "rating": {},
    "score": {},
    "psl": {},
    "publishDate": {},
    "curator": {}
  },
  "stakingRewards": {
    "rating": {},
    "score": {},
    "potentialRating": {},
    "potentialScore": {},
    "ratedAt": {},
    "ratedSince": {},
    "profileUrl": {},
    "reportUrl": {},
    "providerName": {},
    "version": {},
    "type": {},
    "chain": {},
    "contractAddress": {},
    "riskMetrics": {
      "users": {}
    }
  }
}

{
  "message": "Validation failed",
  "error": "Bad Request",
  "statusCode": 400
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500
}

The response has updatedAt plus one optional block per rating provider: credora (rating, score, psl, publishDate, curator) and stakingRewards (rating, score, potential rating and score, rating dates, profile URL). A block is absent when that provider has not rated the yield. Ratings and scores come from the provider and are not normalized across providers. The yield must be enabled for your project, otherwise the call returns 400. A yield with no risk data returns 404.

Authorizations

x-api-key

string

header

required

Path Parameters

yieldId

string

required

The unique identifier of the yield

Example:

"ethereum-eth-lido-staking"

Response

Risk ratings retrieved successfully

updatedAt

string

required

Timestamp of when yield.xyz last computed risk data for this yield (ISO 8601)

credora

object

Show child attributes

stakingRewards

object

Show child attributes

⌘I

Getting started

Earn

Trade

Borrow

Authorizations

Path Parameters

Response