SolidityScan Security API
  • Introduction
    • 📋Overview of SolidityScan
    • 💡Key Features
    • 💻Supported Platforms
  • Getting Started
    • ⭐Web Application
      • ⏩QuickScan
      • Scan a Online Git Repository
      • Scanning a Deployed Contract
      • 🗃️Upload and Scan Solidity Project
      • 👨‍💼Organisation
    • ⚙️APIs
      • 🔏Generating Private Key
      • 🌐SolidityScan Private API
        • WebSocket API
          • Project Scan
          • Verified Contract Scan
          • Project Quick Scan
          • Project Threat Scan
          • File Upload Scans
          • Scan Lifespan and Events
        • HTTP API
      • RustScan API
      • 🔐Vulnerability Score API V1
      • 💢ThreatScore API V1
      • ThreatScore API V2
      • SolidityScan WebSocket Events
        • Private QuickScan WS
        • 🔐Private ThreatScan WS
        • WS references
      • ⚙️Postman Collection
      • Platform Info
    • 📑SolidityScan SDK
    • Platform Parameters
      • Arbitrum
        • Arbiscan
        • Blockscout
      • Asset Chain
        • Blockscout
      • Astar
        • Blockscout
        • SubScan
      • Aurora
        • Aurora Explorer
      • Avalanche
        • Snowtrace
        • Routescan
      • Base
        • BaseScan
        • Blockscout
      • BlackFort
        • Blockscout
      • BOBA
        • Routescan
      • Binance
        • Bscscan
      • BuildBear
        • BuildBear
      • Camino
        • Blockscout
      • Celo
        • Celo Explorer
        • Blockscout
      • Chiliz
        • Routescan
      • Connext
        • Blockscout
      • Creditcoin
        • Blockscout
      • Cronos
        • Cronos Explorer
      • Darwinia
        • SubScan
      • Ethereum Classic
        • Blockscout
      • Ethereum
        • Etherscan
        • Blockscout
      • Etherlink
        • Blockscout
      • Fantom
        • Ftmscan
      • 5ireChain
        • 5ireChain
      • Flare
        • Routescan
      • Fuse
        • Fuse Explorer
        • Blockscout
      • Gnosis
        • Blockscout
      • Hemi
        • Blockscout
      • Immutable
        • Blockscout
      • IOTA
        • Blockscout
      • Japan Open Chain
        • Blockscout
      • Lightlink
        • Blockscout
      • Linea
        • LineaScan
        • Blockscout
      • Lisk
        • Blockscout
      • LUKSO
        • Blockscout
      • Metis
        • Routescan
      • Moonbeam Network
        • SubScan
      • Neon
        • Blockscout
      • Nordek
        • Nordekscan
      • Omni
        • Blockscout
      • One World Chain
        • Blockscout
      • Optimism
        • Optimism
        • Blockscout
      • Peaq Network
        • SubScan
      • Playnance
        • Blockscout
      • Polkadot
        • SubScan
      • Polygon
        • Polygonscan
        • Blockscout
      • re.al
        • Blockscout
      • Redstone
        • Blockscout
      • Reef
        • ReefScan
      • Reya
        • Blockscout
      • Rootstock
        • Blockscout
      • Shibarium
        • Blockscout
      • Shimmer
        • Blockscout
      • Soneium
        • Blockscout
      • Stability
        • Blockscout
      • Tron
        • Tronscan
      • XDC
        • BlocksScan
      • Zetachain
        • Blockscout
      • zkSync
        • Blockscout
  • Integrations
    • GitHub
    • BitBucket
    • GitLab
    • Slack
    • VS Code
    • Remix
  • Audit Reports
    • 📒QuickScan Report
    • 📢Generate and Publish Reports
  • Pricing
    • 💰SolidityScan Pricing
Powered by GitBook
On this page
  • SolidityScan Public API [Example]
  • Parameters
  • Parameters
  1. Getting Started
  2. APIs

Vulnerability Score API V1

PreviousRustScan APINextThreatScore API V1

Last updated 1 month ago

Documentation of the QuickScan API

GET

SolidityScan Public API [Example]

curl --location --request GET 'https://api.solidityscan.com/api/v1/quickscan/1/1/0x4ee38aa8d7449a177119e983610D73e9ace932dA' \
--header 'Authorization: Token {{token}}'
{
  "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"
}

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

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

Parameters

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

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

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

⚙️
🔐
https://api.solidityscan.com/api/v1/quickscan/{platform_id}/{chain_id}/{contract_address}
here
Platform Parameters
https://api.solidityscan.com/api/v1/quickscan/10/{testnet_id}/{contract_address}