Domain Analysis

Analyze a Domain

All requests require an API key. Add "x-api-key" to your request header as shown in the example below.

Don't have an API key? Contact us to get one.

post

Analyze a URL

Body

application/json

urlstringOptionalExample: https://app.aave.com/

Responses

200

Successful operation

application/json

403

Forbidden

500

Internal Server Error

post

/v2/analyze_url

HTTPcURLJavaScriptPython

POST /api/v2/analyze_url HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "url": "https://app.aave.com/"
}

{
  "severity": "Low",
  "bf_web_analysis": [
    {
      "name": "URL Similarity Verification",
      "findings": [
        {
          "description": "No similarity found"
        }
      ],
      "severity": "Low"
    }
  ],
  "partners_analysis": [
    {
      "name": "URL Similarity Verification",
      "findings": [
        {
          "description": "No similarity found"
        }
      ],
      "severity": "Low"
    }
  ]
}

Request Body Parameters

Parameter Name	Parameter Type	Comments
url	string	Domain / URL

Usage Example

Request

curl https://api.blockfence.io/api/v2/analyze_url -X POST -H "Content-Type: application/json" -H "x-api-key: <YOUR API KEY>" -d '
{
    "url": "https://app.aave.coin/"
}
'

Response

Response Fields

Field	Type	Contents
severity	string	Indicates the severity level of the analysis result. Possible values: "High", "Medium", "Low".
analysis_score	number	A floating-point score quantifying the analysis outcome. Score is from 1 to 10.
is_contract	boolean	Specifies whether the analyzed address is a contract.
bf_web_analysis	array	An array of APIAnalyzerResult objects containing web analysis results, if any.
bf_blockchain_analysis	array	An array of APIAnalyzerResult objects containing blockchain analysis results, if any.
partners_analysis	array	An array of APIAnalyzerResult objects containing analysis results from partners.

APIAnalyzerResult

Field	Type	Contents
name	string	The name of the analyzer that produced the findings.
findings	array	An array of Risk objects detailing specific analysis findings.
severity	string	The severity level of the findings from this analyzer. Possible values: "High", "Medium". Low severity risks will not be returned.

Risk

Field	Type	Contents
description	string	A description of the risk identified.
label	string	An optional label categorizing the risk.