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
  1. Getting Started
  2. APIs
  3. SolidityScan WebSocket Events

Private ThreatScan WS

The flow for quickscan ws is as follows:

  • Register the token using auth_token_register event

  • Using the token, send an event to perform a threatscan

1. WebSocket API Documentation

  • URL: api-ws.solidityscan.com

  • Protocol: wss

  • Description: This request requires authorization. The bearer token is sent in the auth_tokenrequest parameter.

Step 1. Auth Token Registration Description: The first step is to register with your auth token to generate an UUID.

{
    "action": "message",
    "payload": {
        "type": "auth_token_register",
        "body": {
            "auth_token": "{Your_Auth_Token}"
        }
    }
}
{
    "type": "auth_token_register",
    "request_uuid": "Your_UUID",
    "payload": {
        "message": "Auth token registered."
    },
    "event_timestamp": "2024-04-19 11:37:17.854547"
}
  • contract_address: The address of the contract to be scanned.

  • contract_platform: The platform which the contract belongs to.

  • contract_chain: The chain which the contract belongs to.

{
    "action": "message",
    "payload": {
        "type": "private_threat_scan_initiate",
        "body": {
            "contract_address": "0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
            "contract_platform": "etherscan",
            "contract_chain": "mainnet"
        }
    }
}
```postman_json
{
    "type": "quick_scan_status",
    "request_uuid": "7b01a6f0f9e35feb448f1ce66f7b78e3",
    "payload": {
        "scan_id": "5bb187534473eb2e",
        "scan_status": "scan_done",
        "project_id": "3dd7c8c2f34eeeba94537ad4c7ee8901",
        "scan_details": {
            "compilerversion": "v0.8.23+commit.f704f362",
            "connection_id": "",
            "contract_address": "0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
            "contract_chain": "mainnet",
            "contract_implementation_address": "",
            "contract_platform": "etherscan",
            "contract_url": "https://etherscan.io/address/0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
            "contractname": "TRIUMPH",
            "currency": "ETH",
            "evmversion": "Default",
            "is_quick_scan": true,
            "licensetype": "MIT",
            "multi_file_scan_status": "scan_done",
            "multi_file_scan_summary": {
                "issue_severity_distribution": {
                    "critical": 5,
                    "gas": 89,
                    "high": 0,
                    "informational": 37,
                    "low": 6,
                    "medium": 7
                },
 .......
PreviousPrivate QuickScan WSNextWS references

Last updated 4 months ago

⚙️
🔐
57KB
response.json