QuickScan API V1

Documentation of the QuickScan API

GET https://api.solidityscan.com/api/v1/quickscan/{platform_id}/{chain_id}/{contract_address}

SolidityScan Public API [Example]

Example Request

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

Example Response

{
  "scan_report": {
    "contract_address": "0x4ee38aa8d7449a177119e983610D73e9ace932dA",
    "contract_chain": "mainnet",
    "contract_platform": "etherscan",
    "contract_url": "https://etherscan.io/address/0x4ee38aa8d7449a177119e983610D73e9ace932dA",
    "contractname": "AdventurerStaking",
    "scanner_reference_url": "https://api.solidityscan.com/quickscan/0x4ee38aa8d7449a177119e983610D73e9ace932dA/etherscan/mainnet",
    "scan_status": "scan_done",
    "scan_summary": {
      "issue_severity_distribution": {
        "critical": 4,
        "gas": 7,
        "high": 2,
        "informational": 4,
        "low": 8,
        "medium": 0
      },
      "lines_analyzed_count": 191,
      "scan_time_taken": 2,
      "score": "3.56",
      "score_v2": "71.20",
      "threat_score": "91.67"
    }
  },
  "status": "success"
}

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

Headers

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

Parameters

{{platform_id}}

{{chain_id}

Documentation of the QuickScan API for BuildBear Private Explorer

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}

Example Request

curl --location --request GET 'https://api.solidityscan.com/api/v1/quickscan/10/Chief_Zam_Wesell_083680d0/0x7aedDA0c95e90d8c40c29621d8A7eb62F7702334'
  • header Authorization: Token {{token}}

Example 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"
}

Parameters

  • {{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

Last updated