# Vulnerability Score API V1

Documentation of the QuickScan API

GET [https://api.solidityscan.com/api/v1/quickscan/{platform\_id}/{chain\_id}/{contract\_address}](https://credshields.gitbook.io/solidityscan-security-api/)

### SolidityScan Public API \[Example] <a href="#solidityscan-public-api-example" id="solidityscan-public-api-example"></a>

{% tabs %}
{% tab title="Request" %}

```
curl --location --request GET 'https://api.solidityscan.com/api/v1/quickscan/1/1/0x4ee38aa8d7449a177119e983610D73e9ace932dA' \
--header 'Authorization: Token {{token}}'
```

{% endtab %}

{% tab title="Response" %}

```
{
  "scan_report": {
    "contract_address": "0x4ee38aa8d7449a177119e983610D73e9ace932dA",
    "contract_chain": "mainnet",
    "contract_platform": "etherscan",
    "contract_url": "https://etherscan.io/address/0x4ee38aa8d7449a177119e983610D73e9ace932dA",
    "contractname": "AdventurerStaking",
    "is_quick_scan": true,
    "is_threat_scan": false,
    "is_verified_scan": true,
    "request_type": "quick_scan",
    "scanner_reference_url": "https://develop.solidityscan.com/quickscan/0x4ee38aa8d7449a177119e983610D73e9ace932dA/etherscan/mainnet?ref=blockscout",
    "scan_status": "scan_done",
    "scan_summary": {
      "issue_severity_distribution": {
        "critical": 4,
        "gas": 23,
        "high": 1,
        "informational": 144,
        "low": 9,
        "medium": 4
      },
      "lines_analyzed_count": 162,
      "scan_time_taken": 3,
      "score_v2": "0.50",
      "threat_scan_risk_level": "High Risk",
      "score_rating": "Low"
    }
  },
  "total_detectors_count": 498,
  "status": "success"
}
```

{% endtab %}
{% endtabs %}

This API will return the count of total vulnerabilities detected by SolidityScan and the security score of the Smart Contract for a contract address whose contract code is verified on the supported explorers.

**Supported Explorers for Verified Contracts**

The information about the supported Explorers can be found [here](https://apidoc.solidityscan.com/solidityscan-security-api/introduction/supported-platforms)

**Accept** application/json, text/plain, \**/\** **Accept-Language** en-GB,en **Connection** keep-alive **Content-Type** application/json **Authorization** Token {{token}}

### **Parameters** <a href="#parameters" id="parameters"></a>

{% content-ref url="../platform-parameters" %}
[platform-parameters](https://apidoc.solidityscan.com/solidityscan-security-api/getting-started/platform-parameters)
{% endcontent-ref %}

#### Documentation of the QuickScan API for BuildBear Private Explorer <a href="#documentation-of-the-quickscan-api-for-buildbear-private-explorer" id="documentation-of-the-quickscan-api-for-buildbear-private-explorer"></a>

BuildBear is a platform where the developer can create their own private testnet, customized according to their own requirements. All Smart Contracts deployed and verified on BuildBear can also be scanned at SolidityScan for the count of total vulnerabilities

GET [https://api.solidityscan.com/api/v1/quickscan/10/{testnet\_id}/{contract\_address}](https://credshields.gitbook.io/solidityscan-security-api/)

{% tabs %}
{% tab title="Request" %}

```
curl --location --request GET 'https://api.solidityscan.com/api/v1/quickscan/10/Chief_Zam_Wesell_083680d0/0x7aedDA0c95e90d8c40c29621d8A7eb62F7702334'
```

* header `Authorization: Token {{token}}`
  {% endtab %}

{% tab title="Response" %}

```
{
    "scan_report": {
        "contract_address": "0x7aedDA0c95e90d8c40c29621d8A7eb62F7702334",
        "contract_chain": "buildbear",
        "contract_platform": "buildbear",
        "contract_url": "https://explorer.buildbear.io/Chief_Zam_Wesell_083680d0/address/0x7aedDA0c95e90d8c40c29621d8A7eb62F7702334",
        "node_reference_id": "Chief_Zam_Wesell_083680d0",
        "scanner_reference_url": "https://solidityscan.com/quickscan/0x7aedDA0c95e90d8c40c29621d8A7eb62F7702334/buildbear/Chief_Zam_Wesell_083680d0",
        "scan_status": "scan_done",
        "scan_summary": {
            "issue_severity_distribution": {
                "critical": 0,
                "gas": 4,
                "high": 0,
                "informational": 3,
                "low": 2,
                "medium": 0
            },
            "lines_analyzed_count": 35,
            "scan_time_taken": 1,
            "score": "3.43",
            "score_v2": "68.57",
            "threat_score": "100.00"
        }
    },
    "status": "success"
}
```

{% endtab %}
{% endtabs %}

### **Parameters** <a href="#parameters-1" id="parameters-1"></a>

* {{platform\_id}} = 10

All BuildBear Private Testnet are recognized with the `platform_id` as `10`

* {{testnet\_id}

All Private Testnets created on BuildBear have a unique name/id. This name is available from either the (a) RPC link, the (b) Explorer Link, or the (c) Faucet Link generated by BuildBear. Sample Screenshot from BuildBear below:

For the above Testnet: `Accepted Mace Windu` the explorer link is `https://explorer.buildbear.io/Accepted_Mace_Windu_2561384` thus the `{{testnet_id}}` is `Accepted_Mace_Windu_2561384`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidoc.solidityscan.com/solidityscan-security-api/getting-started/apis/vulnerability-score-api-v1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.