Risk Ratings

Welcome to our public API documentation! Our API provides easy access to a variety of data and functionality from our platform. To get started, review the endpoints below to see what data and functionality is available, and be sure to follow the authentication requirements for each endpoint. If you have any questions or need assistance, please reach out to us via email.

Requirements

To access our API, you must include the following headers in your request:

• x-api-key: Your API key, which has been shared with you.

• x-user-email: The email address associated with your account.

Make sure to include these headers in all requests to our API. If you have any questions or need assistance, please contact our support team.

API Key and Email:

• The API key is a 16-character alphanumeric string, which will be provided to you. Keep it safe and confidential.

• The email associated with your account should be included as the value for the x-user-email header in all requests to our API.

URL for API

The base URL for our API is:

<https://api.xerberus.io/public/v1/{endpoint}>

You should replace {endpoint} with the specific endpoint you are hitting.

Endpoints

Our API offers the following endpoint:

/risk/scores

This endpoint provides risk scores for various assets on the Xerberus platform. The response will include the asset name, risk score, and fingerprint for each asset.

Make sure to include the required headers in your request:

• x-api-key: Your API key.

• x-user-email: Your email address associated with your account.

Here is an example of how to make the request using axios with NodeJS:

axios.get('<https://api.xerberus.io/public/v1/risk/scores>', {
  headers: {
    'x-api-key': 'your-api-key',
    'x-user-email': 'your-email'
  }
})
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

/risk/score/asset

This endpoint provides risk scores for a single asset on the Xerberus platform. The response will include the asset name, risk score, and fingerprint for each asset.

Make sure to include the required headers in your request:

• x-api-key: Your API key.

• x-user-email: Your email address associated with your account.

You will need to pass an asset fingerprint to fetch the data for the respective asset.

Here is an example of how to make the request using axios with NodeJS:

axios.get('<https://api.xerberus.io/public/v1/risk/score/asset?fingerprint={fingerprint}>', {
  headers: {
    'x-api-key': 'your-api-key',
    'x-user-email': 'your-email'
  }
})
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

What am I seeing?

Rating	Explanation
AAA - A	Investment Grade
BBB - B	Speculative
CCC - C	Highly Speculative
D	Junk

Error Responses

Missing Requirements

If the x-api-key or x-user-email headers are not provided in your API request, you will receive an error response with the message "Missing Email or API key".

Here is an example of the generated error:

{
    "error": "Missing Email or API key"
}

API Key Lost

If you ever lose your API key, don't worry, we're here to help. Simply contact us via email and we'll be happy to provide you with a new one. Our team understands that losing access to important data can be frustrating, so we'll do everything we can to assist you in getting back up and running as quickly as possible. Please keep in mind that it's important to keep your API key safe and confidential to prevent unauthorized access to your account. If you have any questions or concerns about API key security, please don't hesitate to reach out to our support team.