6、Mainnet address risk screening api

Description: This API performs a preliminary risk check on an address (e.g., checking if it’s on a blacklist, if it has transacted directly or indirectly with blacklisted addresses, etc.).

Note: This api only screens for risks; it does not execute rule engine logic.

1、URL

GET /openapi/v2/risk/address/screening

2、Header Parameters

Parameter nameData typeRequiredDescription
timestampinttrueTimestamp (in seconds)
signstringtrueSignature sha256("timestamp=timestamp value&secret=secretkey value")

3、Request Parameters

Parameter nameData typeRequiredDescription
api_keystringtrueapikey
networkstringtrueMainnet name (Bitcoin、Ethereum..... details for "Support mainnet tokens")
addressstringtruewallet address
query_indirect_riskboolfalseWhether to query indirect risk transactions (default value is false)

4、Return Parameters

{
    "code": 200, //200:Represents success
    "msg": "success",
    "data": {
        "unique_id": "0140......8be5", //Unique ID (used to query history)
        "risk_level": "severe", //Risk level (severe, high, medium, low, unknown)
        "risk_code": 4444, //Risk code
        "risk_source": { //Risk source
            "is_private_whitelist": false, //Whether to hit private whitelist
            "is_private_blacklist": false, //Whether to hit private blacklist
            "black_address_type": "Blackmail Scam", //Blacklist type
            "black_address_label": [ //Blacklist label
                "attacker",
                "hacker"
            ],
            "direct_risk_list":[ //List of direct risk transactions
                {
                    "black_address": "1KHw......aGbX", //Blacklist addresses for direct transactions
                    "black_address_type": "Blackmail Scam", //Type of risk
                    "tx_hash": "2bc34......b693", //Transaction hash
                    "black_address_label": [ //Blacklist label
                        "attacker",
                        "hacker"
                    ],
                }, 
                ......
            ],
            "indirect_risk_list":[ //List of indirect risk transactions
                {
                    "indirect_level": 2, //Indirect level
                    "black_address":"0x99......4bE1", //Blacklist of indirect transactions
                    "black_address_type": "Blackmail Scam", //Type of risk
                    "indirect_tx_list":[ //Indirect transaction hash
                        "0x74......2a90"
                        "0x56......9d4b"
                    ],
                    "black_address_label": [ //Blacklist label
                        "attacker",
                        "hacker"
                    ],
                },
                ......
            ]
        }
    }
}
Parameter nameData typeDescription
codeInt

200: The request was successful

-2: The mainnet is not supported

messagestringInterface Request Status Description
unique_idstringUnique id (identifies the current request, used to query history)
risk_levelstring

Risk level(

severe

high

medium

low

none

risk_codeint

Risk code(

0: unknown

-1: Not found

4444: hit blacklist

details for "Risk_Code Instruction manual")

risk_sourcejsonRisk source
risk_source.is_private_whitelistbooleanWhether to hit private whitelist
risk_source.is_private_blacklistbooleanWhether to hit private blacklist
risk_source.black_address_typestringThe blacklist type of the query address
risk_source.black_address_labelstringCheck the blacklist label of the address
risk_source.direct_risk_listjsonArrayQuery address List of direct risk transactions involved
risk_source.indirect_risk_listjsonArrayQuery the list of indirect risk transactions that the address participates in