Security

The security endpoints can be used to retrieve details of vulnerability and security statistics of certain smart contracts of the protocols our system supports.

Retrieves the security vulnerability data of corresponding protocol.

This endpoint returns the security vulnerability data of given protocol for last 7 recorded documents.

GEThttps://api.alterscope.org/data/security/{protocol}/vulnerabilities

Path parameters

protocol*string

the name of the protocol, e.g. aave

Response

200404406500

OK

Body

application/json

vulnerability_statisticsobject

timestampstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.alterscope.org/data/security/{protocol}/vulnerabilities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "vulnerability_statistics": {
    "high": 0,
    "low": 0,
    "medium": 0,
    "none": 0
  },
  "timestamp": "text"
}

Sample Request

Note: The sample request below shows security data for aave protocol.

curl https://api.alterscope.org/data/security/aave/vulnerabilities -H "Authorization: Bearer <your_access_token>"

Note: For a comprehensive list of protocols whose security vulnerability data can be requested please refer to supported protocols page.

Sample Response

The sample response below will display security vulnerability data of corresponding protocol for the past 7 days.

{
   "status":true,
   "data":[
      {
         "protocol":"aave",
         "vulnerability_statistics":{
            "high":3,
            "low":84,
            "medium":3,
            "none":0
         },
         "timestamp":"2023-11-02T01:00:28.045588377Z"
      },
      {
         "protocol":"aave",
         "vulnerability_statistics":{
            "high":3,
            "low":84,
            "medium":3,
            "none":0
         },
         "timestamp":"2023-11-01T01:00:32.121854132Z"
      },
      {
         "protocol":"aave",
         "vulnerability_statistics":{
            "high":3,
            "low":84,
            "medium":3,
            "none":0
         },
         "timestamp":"2023-10-31T01:00:33.904022906Z"
      },
      {
         "protocol":"aave",
         "vulnerability_statistics":{
            "high":3,
            "low":84,
            "medium":3,
            "none":0
         },
         "timestamp":"2023-10-30T01:00:34.351041721Z"
      },
      {
         "protocol":"aave",
         "vulnerability_statistics":{
            "high":3,
            "low":84,
            "medium":3,
            "none":0
         },
         "timestamp":"2023-10-29T01:00:33.599495637Z"
      },
      {
         "protocol":"aave",
         "vulnerability_statistics":{
            "high":3,
            "low":84,
            "medium":3,
            "none":0
         },
         "timestamp":"2023-10-28T01:00:28.690077933Z"
      },
      {
         "protocol":"aave",
         "vulnerability_statistics":{
            "high":3,
            "low":84,
            "medium":3,
            "none":0
         },
         "timestamp":"2023-10-27T01:00:41.726485931Z"
      }
   ]
}

Sample Response Description

protocol: Name of the protocol. For supported list of protocols check here. vulnerability_statistics: The severity of vulnerabilities is often categorized into three levels: High, Medium, Low and their numbers are specified.

• High-severity vulnerabilities are critical weaknesses that pose a significant threat to the security of a system.

• Medium-severity vulnerabilities are less critical than high-severity ones but still pose a notable risk to the security of a system.

• Low-severity vulnerabilities are the least critical, representing weaknesses that have a relatively minor impact on security.

timestamp: Date and Time associated with the protocol data.

Retrieves the security static data of corresponding protocol.

This endpoint returns the latest available security static data of given protocol.

GEThttps://api.alterscope.org/data/security/{protocol}/static

Path parameters

protocol*string

the name of the protocol, e.g. aave

Response

200404406500

OK

Body

application/json

protocolstring

contract_creation_datestring

last_contract_update_datestring

num_hacksnumber

most_active_contractstring

active_contract_num_transactionsnumber

team_visibilityboolean

bounty_amountnumber

Request

JavaScriptCurlPython

const response = await fetch('https://api.alterscope.org/data/security/{protocol}/static', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "protocol": "text",
  "contract_creation_date": "text",
  "last_contract_update_date": "text",
  "num_hacks": 0,
  "most_active_contract": "text",
  "active_contract_num_transactions": 0,
  "team_visibility": false,
  "bounty_amount": 0
}

Sample Request

Note: The sample request below shows security static data for aave protocol.

curl https://api.alterscope.org/data/security/aave/static -H "Authorization: Bearer <your_access_token>"

Note: For a comprehensive list of protocols whose data can be requested please refer to supported protocols page.

Sample Response

{
   "status":true,
   "data":[
      {
         "protocol":"aave",
         "contract_creation_date":"Jun-08-2022 12:30:46 PM +UTC",
         "last_contract_update_date":"Jun-08-2022 12:30:46 PM +UTC",
         "num_hacks":0,
         "most_active_contract":"0x301F221bc732907E2da2dbBFaA8F8F6847c170c3",
         "active_contract_num_transactions":748,
         "team_visibility":true,
         "bounty_amount":250000
      }
   ]
}

Sample Response Description

• Bounty Amount: The highest permissible reward offered for identifying and reporting a critical vulnerability within the protocol's smart contracts

• Active Contract Transactions: This factor involves monitoring the number of transactions conducted on the project's smart contracts.

• Most Active Contract: This parameter identifies the most active contract within the DeFi project that is experiencing the highest number of transactions.

• Hacks: Hacks refers to the total count of unauthorized modifications, breaches, or exploits recorded within a specific protocol version.

• Team Data Public: A boolean parameter that indicates whether data about the DeFi project's development team is publicly available.

• Protocol: Refers to the specific decentralized finance (DeFi) protocol whose security static data is requested.

• Contract Creation Date: This heading indicates the date and time when the smart contract associated with the specific protocol was created.

• Last Contract Update Date: This heading denotes the date and time of the most recent update made to the smart contract governing the specific protocol.

Retrieves the security score of corresponding protocol.

This endpoint returns the security score of given protocol for last 7 recorded documents.

GEThttps://api.alterscope.org/score/security/{chain}/{protocol}

Path parameters

chain*string

the name of the chain protocol operates on, e.g. ethereum

protocol*string

the name of the protocol, e.g. aave

Response

200404406500

OK

Body

application/json

chainstring

protocolstring

creation_scorenumber

monitoring_scorenumber

support_scorenumber

ux_scorenumber

scorenumber

versionnumber

timestampstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.alterscope.org/score/security/{chain}/{protocol}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "chain": "text",
  "protocol": "text",
  "creation_score": 0,
  "monitoring_score": 0,
  "support_score": 0,
  "ux_score": 0,
  "score": 0,
  "version": 0,
  "timestamp": "text"
}

Sample Request

Note: The sample request below shows security score for the specified chain and its protocol.

curl https://api.alterscope.org/score/security/ethereum/aave -H "Authorization: Bearer <your_access_token>"

Note: For a comprehensive list of protocols and chains whose data can be requested please refer to supported protocols and chains page.

Sample Response

The sample response below will display security score data of corresponding protocol for the past 7 days.

{
   "status":true,
   "data":[
      {
         "chain":"ethereum",
         "protocol":"aave",
         "creation_score":87.39463088808193,
         "monitoring_score":0,
         "support_score":0.75,
         "ux_score":0,
         "score":0.5851308725872129,
         "version":2,
         "timestamp":"15-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "creation_score":87.39463088808193,
         "monitoring_score":0,
         "support_score":0.75,
         "ux_score":0,
         "score":0.5851308725872129,
         "version":2,
         "timestamp":"15-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "creation_score":87.39463088808193,
         "monitoring_score":0,
         "support_score":0.75,
         "ux_score":0,
         "score":0.5851308725872129,
         "version":2,
         "timestamp":"15-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "creation_score":87.39463088808193,
         "monitoring_score":0,
         "support_score":0.75,
         "ux_score":0,
         "score":0.5851308725872129,
         "version":2,
         "timestamp":"14-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "creation_score":87.39463100955889,
         "monitoring_score":0,
         "support_score":0.75,
         "ux_score":0,
         "score":0.5851308733970594,
         "version":2,
         "timestamp":"13-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "creation_score":87.39463100955889,
         "monitoring_score":0,
         "support_score":0.75,
         "ux_score":0,
         "score":0.5851308733970594,
         "version":2,
         "timestamp":"12-01-2024"
      },
      {
         "chain":"ethereum",
         "protocol":"aave",
         "creation_score":87.39463100955889,
         "monitoring_score":0,
         "support_score":0.75,
         "ux_score":0,
         "score":0.5851308733970594,
         "version":2,
         "timestamp":"11-01-2024"
      }
   ]
}

Sample Response Description

1. Chain: Refers to the blockchain network where the protocol operates. For supported list of chains check here.

2. Protocol: Specifies the protocol being used. For supported list of protocols check here.

3. Creation Score: A numerical score representing the protocol's creation process. It likely considers factors such as development progress, community engagement, and technology used.

4. Monitoring Score: Indicates the level of monitoring applied to the protocol.

5. Support Score: Reflects level of support from development ecosystem, various support forums or backing the protocol has received, possibly from investors, developers, or other stakeholders.

6. UX Score: Stands for User Experience Score, which evaluates how user-friendly the protocol's interface is.

7. Score: An overall assessment score that combines various metrics to provide a comprehensive evaluation of the protocol's performance or quality.

8. Version: Indicates the version number of the protocol being referenced.

9. Timestamp: Specifies the date and time when this data was recorded.