xerberus.io

Cardano

The following endpoints are available for the Cardano ecosystem

/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, subject and fingerprint for each asset.

This API supports two query parameters:

  • fingerprint - unique identifiers for each asset inside a minting policy

  • subject - the asset ID of the asset

You can pass either one of the above as per your requirement.

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 for each parameter:

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));

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

API Output Example

{
    "status": "success",
    "data": {
        "version": "Alpha v1.3",
        "scores": [
            {
                "asset_name": "rsRSN",
                "subject": "04b95368393c821f180deee8229fbd941baaf9bd748ebcdbf7adbb14727352534e",
                "fingerprint": "asset1yjgux2s0xjdyawrccns0dd8dxs3k35qkyhh79y",
                "risk_category": "D"
            },
            {
                "asset_name": "MOAI",
                "subject": "04c40336e67982e02cc75336cf436a224569df1b950a18c6667189d64d4f4149",
                "fingerprint": "asset1c7e9u94flehmrvj8nx3per7faswnn8kfn745jc",
                "risk_category": "D"
            },
                etc...]
            }
}

What am I seeing?

PreviousGetting StartedNextPolygon

Last updated