SIREN

The Scam-Investigation-Registry-Engine (SIREN) is an open registry of fraud-associated wallets.

Introduction:

This documentation provides information about the SIREN Scam Wallets Public API, which can be used to verify if a wallet address is suspicious or not. By utilising this API, developers can integrate a feature into their applications or systems to analyse wallet addresses and determine if they exhibit any suspicious or potentially fraudulent behaviour. The API provides valuable insights and data that can help in identifying and mitigating risks associated with fraudulent activities in the cryptocurrency ecosystem.

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.

Endpoint

/siren/scam/wallets

METHOD: GET

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/siren/scam/wallets', {
  headers: {
    'x-api-key': 'your-api-key',
    'x-user-email': 'your-email'
  }
})
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

Response Explanation

The response you receive is structured as an array, which contains multiple objects. Each of these objects possesses several specific fields, which are detailed as follows:

Key
Type
Explanation

address

string

The scam wallet address

risk_level

number

Risk associated with the wallet address

number_of_reports

number

Number of reports submitted against the scam wallet

scam_tags

array

Associated tags that describe the type of scams

fraud_case_link

string

Link to the fraud case on Xerberus Platform


Last updated