Link to the API documentation: https://bei.anchainai.com/docs
Every request needs an API key. Please visit this page if you need one.
Get started with our demo domain to experience our BEI API with API key: demo_api_key.
import requests
def get_risk_score(address): # get address risk score and detail from BEI API demo domain
url = 'https://demo.anchainai.com/api/address_risk_score'
payload = {
'proto': 'btc',
'address': address,
'apikey': 'demo_api_key'
}
res = requests.get(url=url, params=payload)
info = res.json()
detail = info['data'][address]['self']['detail']
risk_score = info['data'][address]['risk']['score']
return (detail, risk_score)
receiver_addr = '12t9YDPgwueZ9NyMgw519p7AA8isjr6SMw' #Ransomware WannaCry
(detail, risk_score) = get_risk_score(receiver_addr)
if risk_score > 50:
print(f'Do not transact, the receiver is a high-risk address with risk score: {risk_score}')
print(f'You are trying to transact with {detail}')
# Block the transaction
else:
print('Receiver is not high-risk')import requests
def get_risk_score(address): # get address risk score and detail from BEI API demo domain
url = 'https://demo.anchainai.com/api/address_risk_score'
payload = {
'proto': 'btc',
'address': address,
'apikey': 'demo_api_key'
}
res = requests.get(url=url, params=payload)
info = res.json()
detail = info['data'][address]['self']['detail']
risk_score = info['data'][address]['risk']['score']
return (detail, risk_score)
sender_addr = '12t9YDPgwueZ9NyMgw519p7AA8isjr6SMw' #Ransomware WannaCry
(detail, risk_score) = get_risk_score(sender_addr)
if risk_score > 50:
print(f'Alert, you received a transaction from a high-risk address with risk score: {risk_score}')
print(f'You are trying to transact with {detail}')
# Send alert
else:
print('Sender is not high-risk')| Protocol | Address |
|---|---|
| BTC | 12QtD5BFwRsdNsAZY76UVE1xyCGNTojH9h |
| BTC | 1H2zrVQxU3ymunr9CunjoActooLW2ryQK7 |
| BTC | 12t9YDPgwueZ9NyMgw519p7AA8isjr6SMw |
| BTC | 1Lud76Q98VRHCUiyK7XUs7AgFofrqXeP78 |
| BTC | 1NDyJtNTjmwk5xPNhjgAMu4HDHigtobu1s |
| BTC | 185TLkMZYwgcGjGMcWpYukdVd1b6HRs7kA |
| ETH | 0xd882cfc20f52f2599d84b8e8d58c7fb62cfe344b |
| ETH | 0x6e1db9836521977ee93651027768f7e0d5722a33 |
| ETH | 0xf4a2eff88a408ff4c4550148151c33c93442619e |
| ETH | 0xab5c66752a9e8167967685f1450532fb96d5d24f |
| ETH | 0x05f51aab068caa6ab7eeb672f88c180f67f17ec7 |
| XRPL | rfapBqj7rUkGju7oHTwBwhEyXgwkEM4yby |
| XRPL | rUzWJkXyEtT8ekSSxkBYPqCvHpngcy6Fks |
| XRPL | rwggnsfxvCmDb3YP9Hs1TaGvrPR7ngrn7Z |
| XRPL | rJb5KsHsDHF1YS5B5DU6QCkH5NsPaKQTcy |
| XRPL | r97KeayHuEsDwyU1yPBVtMLLoQr79QcRFe |
| XRPL | rhxRteLqGZrzTyZyPkAVnqrWFXT7r2cgnY |
| XRPL | rDHRqKE6kBqrTr4Ks3ACv7fHHVRf71RY6U |
| XRPL | rnXyVQzgxZe7TR1EPzTkGj2jxH4LMJYh66 |
- 200: api successfully retrieves information and returns
- 4xx: api finds no information or the usage is forbidden
- 5xx: api path or input parameters are invalid or internal error
- is_address_valid: input address is valid or not
- self
- category: address category
- detail: address details including entity name
- risk
- level: risk level classification from 1 to 4 ascendingly
- score: risk score in range 0-100
- verdict_time: timestamp for querying risk info
- activity
- suspicious_activity
- aggr_type: type of activity aggregation
- category: activity category
- description: activity summary
- entity: related entity
- txn_count: count of suspicious transactions
- txn_direct: direction of transaction
- txn_hashes: list of transaction hashes
- txn_vol: transaction volume
- suspicious_activity_declare: declaration
- verdict_time: timestamp for querying risk info
- suspicious_activity
curl -XGET 'https://demo.anchainai.com/api/address_label?proto=<PROTO>&address=<ADDR>&apikey=<APIKEY>'import requests
url = 'https://demo.anchainai.com/api/address_label'
payload = {
'proto': '<PROTO>',
'address': '<ADDR>',
'apikey': '<APIKEY>'
}
res = requests.get(url=url, params=payload)- proto(required): blockchain protocol, current available options: btc, eth
- address(required): blockchain address
- apikey(required): get your free BEI API key today!
{
"data": {
"12t9YDPgwueZ9NyMgw519p7AA8isjr6SMw": {
"is_address_valid": true,
"self": {
"category": [
"ransomware",
"abuse"
],
"detail": [
"ransomware:WannaCry"
]
}
}
},
"err_msg": "",
"status": 200
}curl -XGET 'https://demo.anchainai.com/api/address_risk_score?proto=<PROTO>&address=<ADDR>&apikey=<APIKEY>'import requests
url = 'https://demo.anchainai.com/api/address_risk_score'
payload = {
'proto': '<PROTO>',
'address': '<ADDR>',
'apikey': '<APIKEY>'
}
res = requests.get(url=url, params=payload)- proto(required): blockchain protocol, current available options: btc, eth
- address(required): blockchain address
- apikey(required): get your free BEI API key today!
{
"data": {
"12t9YDPgwueZ9NyMgw519p7AA8isjr6SMw": {
"is_address_valid": true,
"risk": {
"level": 4,
"score": 100,
"verdict_time": 1605920588
},
"self": {
"category": [
"abuse",
"ransomware"
],
"detail": [
"ransomware:WannaCry"
]
}
}
},
"err_msg": "",
"status": 200
}curl -XGET 'https://demo.anchainai.com/api/address_risk_activity?proto=<PROTO>&address=<ADDR>&apikey=<APIKEY>'import requests
url = 'https://demo.anchainai.com/api/address_risk_activity'
payload = {
'proto': '<PROTO>',
'address': '<ADDR>',
'apikey': '<APIKEY>'
}
res = requests.get(url=url, params=payload)- proto(required): blockchain protocol, current available options: btc, eth
- address(required): blockchain address
- apikey(required): get your free BEI API key today!
{
"data": {
"37pfy4LbsNhjz7myQoZpHWD4TVvSCnioBi": {
"activity": {
"suspicious_activity": [],
"suspicious_activity_declare": "Suspicious Activity is summarized based on all historical transaction",
"verdict_time": 1605920819
},
"is_address_valid": true,
"risk": {
"level": 2,
"score": 50,
"verdict_time": 1605920819
},
"self": {
"category": [
"unaffiliated"
],
"detail": []
}
}
},
"err_msg": "",
"status": 200
}