Getting Started

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 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 at [e-mail]

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 32-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.

Getting an API Key

To obtain an API Key and begin utilising our suite of APIs, we kindly request that you contact fill out this google form: https://forms.gle/5KS4invKmQ9j5bpdA

Our team will review your request and provide the necessary credentials promptly. Should you have any additional questions or need further assistance, please do not hesitate to reach out. We look forward to supporting your integration and helping you get the most out of our API offerings.

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.

Important Notice Regarding Usage

Our APIs are free to use. Xerberus covers the cost of maintaining both the core product and its APIs. In return, we kindly ask that you display the Xerberus brand within your product as a gesture of acknowledgment.

Correct Risk Rating Display

• Display the branded Xerberus rating SVGs matching the "risk_category" string value provided in the API for a given token. Example:
• The assets can be found here
• Clicking on the rating of a given token should redirect to the matching Xerberus webApp page. You can use the corresponding "asset_name" value in the url as such: - For Cardano tokens : app.xerberus.io/risk/rating/cardano/{asset_name} - For Ethereum tokens: app.xerberus.io/risk/rating/ethereum/{asset_name}

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 at [e-mail] 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.