Skip to main content

​
Prerequisites

  • A Bitrace AML API key (get one here)
  • Basic knowledge of making HTTP requests

​
Your First API Call

Let’s make your first API call to retrieve entity information for an address.

​
Step 1: Set your API key

export BITRACE_API_KEY="your_api_key_here"

​
Step 2: Make a request

curl -X GET 'https://api.bitrace.io/api/v1/tracker/kya/entities?address=TZ1noC2vbh8HRjt2icUbM1E6pKbSZ83Lfc&network=tron' \
  --header "X-Access-Key: $BITRACE_API_KEY" \
  --header 'Accept: application/json'

​
Step 3: View the response

You’ll receive a JSON response like this: 
{
  "success":true,
  "code":1,
  "msg":"SUCCESS",
  "data":{
    "time":1714052957650,
    "address":"TZ1noC2vbh8HRjt2icUbM1E6pKbSZ83Lfc",
    "network":"tron",
    "whitelist": false,
    "contract": false,
    "entity":{
      "entityName":"Bybit User",
      "entityCode":"bybit-user",
      "entityCategory":"cex",
      "entityCategoryCode":"cex"
    }
  }
}

​
Next Steps

​
Explore KYA Endpoints

​
Explore KYT Endpoints

​
Common Use Cases

​
1. Address Entity Analysis

Identify the entity behind an address: 
curl -X GET 'https://api.bitrace.io/api/v1/tracker/kya/entities?address=TZ1noC2vbh8HRjt2icUbM1E6pKbSZ83Lfc&network=tron' \
  --header "X-Access-Key: $BITRACE_API_KEY"

​
2. Address Risk Screening

Check if an address has any risk indicators: 
curl -X GET 'https://api.bitrace.io/api/v1/tracker/kya/risks?address=TNk8zE9iHPj8LExnLhRi8Ufs9zYbvgRc7n&network=tron' \
  --header "X-Access-Key: $BITRACE_API_KEY"

​
3. Transaction Risk Screening

Screen transactions for risks: 
curl -X POST 'https://api.bitrace.io/api/v1/tracker/kyt/transfers/risk-screening' \
  --header "X-Access-Key: $BITRACE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "network": "eth",
    "hash": "0xddeb5d1e29a88ac9e0a304f415628ff45f53c7278127de7f47c75b43bebcce8f",
    "tokenContractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "outputAddress": "0xa023319e8ed4302f7d05587ce3c7066aa97200c1",
    "direction": "received"
  }'

​
4. Batch Analysis

Retrieve information for multiple addresses at once: 
curl -X POST 'https://api.bitrace.io/api/v1/tracker/kya/entities' \
  --header "X-Access-Key: $BITRACE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "addresses": [
      "TZ1noC2vbh8HRjt2icUbM1E6pKbSZ83Lfc",
      "TFskN28dBDqv8tLKtM2GwroGx7bKDUSnBW"
    ],
    "network": "tron"
  }'

​
Need Help?