Blockfence API Docs
Back to Homepage
  • Welcome to Blockfence API
  • Quick Start
  • Reference
    • API Reference
      • Enrichment
        • Transaction Simulation
        • Address Enrichment
        • Domain Enrichment
        • AI Interpreter
      • Analysis
        • Address Analysis
        • Domain Analysis
        • Transaction Analysis
      • Monitoring
        • Subscribe to Address Events
        • Subscribe to Domain Events
      • Investigation
        • Domain To Addresses
        • Address to Domains
        • Similar Smart Contracts
        • Domain to Linked Domains
        • Domain to Internal Pages
        • Investigate a URL
  • Terms & Policy
    • API License Agreement
    • Terms & Conditions
    • Privacy Policy
Powered by GitBook
On this page

Was this helpful?

Quick Start

Last updated 1 year ago

Was this helpful?

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

If you don't have an API Key, please contact info@blockfence.io to get your key.

Make your first request

To make your first request, send an authenticated request to our analyze endpoint. The response will be the aggregated risk assessment.

Usage Example:

{
    "chain_id": "0x1",
    "blockchain_address": "0x953de0fee9e7b8056dd802b2e9ba0c8e540c68b8",
    "url": "https://sudosswapq.space/"
}
{
    "severity": "HIGH",
    "is_contract": true,
    "bf_web_analysis": [
        {
            "name": "URL Phishing Check",
            "findings": [
                {
                    "description": "This URL was flagged with the following Threat: Phishing!\nProceed with caution!"
                }
            ],
            "severity": "HIGH"
        },
        {
            "name": "URL Similarity Verification",
            "findings": [
                {
                    "description": "  • looks like swap.hiveswap.io",
                    "label": "CONTAINED_STRING"
                }
            ],
            "severity": "LOW"
        }
    ],
    "bf_blockchain_analysis": [
        {
            "name": "Blockfence Smart Contract Analysis",
            "findings": [
                {
                    "description": "Blockfence analysis identified this address as a possible Malicious scam!",
                    "label": "Malicious"
                }
            ],
            "severity": "HIGH"
        },
        {
            "name": "Source Code Verification",
            "findings": [
                {
                    "description": "Verified by Etherscan"
                }
            ],
            "severity": "NONE"
        }
    ],
    "partners_analysis": [
        {
            "name": "GoPlus Labs",
            "findings": [
                {
                    "description": "We found the following risks on GoPlus Labs:"
                },
                {
                    "description": "  • This address has implemented phishing activities.",
                    "label": "phishing_activities"
                },
                {
                    "description": "  • This address has implemented stealing attack.",
                    "label": "stealing_attack"
                }
            ],
            "severity": "HIGH"
        },
        {
            "name": "DappRadar",
            "findings": [
                {
                    "description": "This address is not listed by DappRadar\nProceed with caution!",
                    "label": "DAPPRADAR_NOT_VERIFIED"
                }
            ],
            "severity": "LOW"
        },
        {
            "name": "Forta Network",
            "findings": [
                {
                    "description": "A gang of friendly bots at Forta scanned the address and found no alerts on Forta Network"
                }
            ],
            "severity": "NONE"
        }
    ]
}
  • Get your API keys
  • Make your first request
  • POST/analyze
post

Analyze a blockhain address or a URL

Body
chain_idstring · hexOptionalExample: 0x1
blockchain_addressstring · hexOptionalExample: 0x8904E3E9eaB00F64458845d32Ea22b2279fda1f7
urlstring · hexOptionalExample: https://blockfence.io/
Responses
200
Successful operation
application/json
403
Forbidden
500
Internal Server Error
post
POST /api/v1/analyze HTTP/1.1
Host: api.blockfence.io
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "chain_id": "0x1",
  "blockchain_address": "0x8904E3E9eaB00F64458845d32Ea22b2279fda1f7",
  "url": "https://blockfence.io/"
}
{
  "severity": "NONE",
  "is_contract": true,
  "bf_blockchain_analysis": [
    {
      "name": "Blockfence Smart Contract Analysis",
      "severity": "NONE",
      "findings": [
        {
          "description": "No threats detected",
          "label": "text"
        }
      ]
    }
  ],
  "bf_web_analysis": [
    {
      "name": "URL Similarity Verification",
      "severity": "HIGH",
      "findings": [
        {
          "description": "  • looks like swap.hiveswap.io",
          "label": "CONTAINED_STRING"
        }
      ]
    }
  ],
  "partners_analysis": [
    {
      "name": "DappRadar",
      "severity": "LOW",
      "findings": [
        {
          "description": "This address is not listed by DappRadar\nProceed with caution!",
          "label": "DAPPRADAR_NOT_VERIFIED"
        }
      ]
    }
  ]
}