KYT API Integration

Before initiating the request to obtain the status, please visit zkMe OpenAPI

Get API Status

https://openapi.zk.me/kyt/v1/status

Sample Response

{
  "code": 200,
  "message": "success",
  "data": {
    "support_api": [
      "status",
      "address_labels",
      "risk_score",
      "transactions_investigation",
      "address_overview",
      "address_action",
      "address_trace"
    ],
    "support_coin": [
      "ETH",
      "USDT-ERC20",
      "USDC-ERC20",
      "USDT-TRC20",
      "WETH-ERC20",
      "BNB-ERC20",
      "UNI-ERC20",
      "BUSD-ERC20",
      "DAI-ERC20",
      "GRT-ERC20",
      "ENS-ERC20",
      "UST-ERC20",
      "BNB",
      "BUSD-BEP20",
      "USDT-BEP20",
      "WBNB-BEP20",
      "ETH-BEP20",
      "BTCB-BEP20",
      "DOGE-BEP20",
      "USDC-BEP20",
      "SHIB-BEP20",
      "UST-BEP20",
      "MATIC-Polygon",
      "WMATIC-Polygon",
      "WETH-Polygon",
      "USDC-Polygon",
      "USDT-Polygon",
      "DAI-Polygon",
      "WBTC-Polygon",
      "AAVE-Polygon",
      "LINK-Polygon",
      "UNI-Polygon",
      "UST-Polygon",
      "SUSHI-Polygon",
      "renBTC-ERC20",
      "WBTC-ERC20",
      "TUSD-ERC20",
      "SHIB-ERC20",
      "LINK-ERC20",
      "BAT-ERC20",
      "CRO-ERC20",
      "SUSHI-ERC20",
      "stETH-ERC20",
      "CRV-ERC20",
      "CVX-ERC20",
      "cvxCRV-ERC20",
      "3Crv-ERC20",
      "LOOKS-ERC20",
      "USDC-TRC20",
      "IOTX-ERC20",
      "IOTX",
      "VITA-IoTeX",
      "USDT-IoTeX",
      "BUSD_b-IoTeX",
      "WIOTX-IoTeX",
      "CIOTX-IoTeX",
      "CYC-IoTeX",
      "BNB-IoTeX",
      "USDC-IoTeX",
      "ETH-IoTeX",
      "GFT-IoTeX",
      "AVAX-Avalanche",
      "WAVAX-Avalanche",
      "BTC.b-Avalanche",
      "USDT-Avalanche",
      "USDT.e-Avalanche",
      "USDC-Avalanche",
      "USDC.e-Avalanche",
      "WETH.e-Avalanche",
      "DAI.e-Avalanche",
      "WBTC.e-Avalanche",
      "ETH-Arbitrum",
      "USDT-Arbitrum",
      "USDC.e-Arbitrum",
      "WETH-Arbitrum",
      "DAI-Arbitrum",
      "WBTC-Arbitrum",
      "LINK-Arbitrum",
      "GMX-Arbitrum",
      "sbfGMX-Arbitrum",
      "STG-Arbitrum",
      "MAGIC-Arbitrum",
      "USDC-Arbitrum",
      "BTC",
      "DAI-BEP20",
      "Cake-BEP20",
      "APE-ERC20",
      "ETH-Optimism",
      "USDT-Optimism",
      "USDC-Optimism",
      "OP-Optimism",
      "DAI-Optimism",
      "WBTC-Optimism",
      "WETH-Optimism",
      "SNX-Optimism",
      "sUSD-Optimism",
      "VELO-Optimism",
      "USDC.e-Optimism",
      "PYUSD-ERC20",
      "ETH-Base",
      "TRX"
    ]
  }
}

Get Address Labels

Returns a list of labels for a given address #

https://openapi.zk.me/kyt/v1/address/labels
   ?coin=ETH
   &address={address}
   &api_key=YourApiKey

Name	Type	Description
coin	string	The coin to check for address labels, all optional values can be found here
address	string	The address to check for address labels
api_key	string	Your API key

Sample response

{
  "code": 200,
  "message": "success",
  "data": {
    "label_list": ["Binance", "hot"],
    "label_type": "exchange"
  }
}

Get Address Overview

Returns the balance and statistics for a given address.

https://openapi.zk.me/kyt/v1/address/overview
   ?coin=ETH
   &address={address}
   &api_key=YourApiKey

Name	Type	Description
coin	string	The coin to check for address overview, all optional values can be found here
address	string	The address to check for overview datas
api_key	string	Your API key

Sample response

{
  "code": 200,
  "message": "success",
  "data": {
    "balance": 73.2255,
    "first_seen": 1441800674,
    "last_seen": 1700958983,
    "received_txs_count": 1540,
    "spent_txs_count": 236,
    "total_received": 916288.2006,
    "total_spent": 916210.9499,
    "txs_count": 1776
  }
}

Fields

Name	Type	Description
balance	float(4)	The balance of the query address
first_seen	int	The first transaction time of the query address, in unix timestamp format
last_seen	int	The last transaction time of the query address, in unix timestamp format
received_txs_count	int	Total number of incoming transactions of the query address
spent_txs_count	int	Total number of outgoing transactions of the query address
total_received	float(4)	The total received amount of the query address
total_spent	float(4)	The total spent amount of the query address
txs_count	int	Total number of transactions of the query address

Name

Type

Description

balance

float(4)

The balance of the query address

first_seen

int

The first transaction time of the query address, in unix timestamp format

last_seen

int

The last transaction time of the query address, in unix timestamp format

received_txs_count

int

Total number of incoming transactions of the query address

spent_txs_count

int

Total number of outgoing transactions of the query address

total_received

float(4)

The total received amount of the query address

total_spent

float(4)

The total spent amount of the query address

txs_count

int

Total number of transactions of the query address

Get Risk Score

https://openapi.zk.me/kyt/v1/risk/score
   ?coin=ETH
   &address={address}
   &txid={txn hash}
   &api_key=YourApiKey

Parameters

Name	Type	Description
coin	string	The coin to check for risk score, all optional values can be found here
address	string	The address to check for risk score, one of address and txid must be passed.
txid	string	The address to check for risk score, one of address and txid must be passed. If you are unsure of its value, please ignore it directly and do not pass any non-existent or fictional values.
api_key	string	Your API key

Name

Type

Description

coin

string

The coin to check for risk score, all optional values can be found here

address

string

The address to check for risk score, one of address and txid must be passed.

txid

string

The address to check for risk score, one of address and txid must be passed. If you are unsure of its value, please ignore it directly and do not pass any non-existent or fictional values.

api_key

string

Your API key

Sample response

{
  "code": 200,
  "message": "success",
  "data": {
    "score": 3,
    "hacking_event": "",
    "detail_list": [
      "Interact With Malicious Address",
      "Interact With High-risk Tag Address",
      "Interact With Medium-risk Tag Addresses"
    ],
    "risk_level": "Low",
    "risk_detail": [
      {
        "label": "Tornado.Cash: Router",
        "type": "high_risk",
        "volume": 1338984,
        "address": "0xd90e2f925da726b50c4ed8d0fb90ad053324f31b",
        "percent": 0.453
      },
      {
        "label": "Tornado.Cash: L1 Helper",
        "type": "high_risk",
        "volume": 1859.7,
        "address": "0xca0840578f57fe71599d29375e16783424023357",
        "percent": 0.001
      },
      {
        "label": "Tornado.Cash: Proxy",
        "type": "high_risk",
        "volume": 1487760,
        "address": "0x722122df12d4e14e13ac3b6895a86e84145b6967",
        "percent": 0.503
      },
      {
        "label": "Tornado.Cash: 10 ETH",
        "type": "high_risk",
        "volume": 167204.511,
        "address": "0x910cbd523d972eb0a6f4cae4618ad62622b39dbf",
        "percent": 0.057
      },
      {
        "label": "HitBTC",
        "type": "medium_risk",
        "volume": 76090.41,
        "address": "0x9c67e141c0472115aa1b98bd0088418be68fd249",
        "percent": 0.026
      }
    ]
  }
}

Fields

Name	Type	Description
score	int	Risk Score for the query address, range: 3 ~ 100
hacking_event	string	Related security event/incident name for the query address
detail_list	string[]	Risk description for the query address
risk_level	string	Risk level, Low / Moderate / High / Severe
risk_detail	object[]	Data for the risk score calculation process

Name

Type

Description

score

int

Risk Score for the query address, range: 3 ~ 100

hacking_event

string

Related security event/incident name for the query address

detail_list

string[]

Risk description for the query address

risk_level

string

Risk level, Low / Moderate / High / Severe

risk_detail

object[]

Data for the risk score calculation process

Risk Descriptions for Detail_list

Risk Item	Risk Item
Malicious Address	Address directly involved in malicious events, Example: DeFi protocol exploiters, centralized exchange hackers, sanctioned addresses, etc.
Suspected Malicious Address	Address associated with malicious events
High-risk Tag Address	High-risk entity address, Example: Mixers, some nested exchanges, etc.
Medium-risk Tag Address	High-risk entity address, Example: Mixers, some nested exchanges, etc.
Mixer	Mixer entity address, Example: Tornado Cash, etc.
Risk Exchange	Exchanges that do not require KYC
Gambling	Gambling entity address
Involved Theft Activity	Address involved in theft events
Involved Ransom Activity	Address involved in ransom events
Involved Phishing Activity	Address involved in phishing events
Interact With Malicious Address	Interactions with malicious address
Interact With Suspected Malicious Address	Interactions with suspected malicious address
Interact With High-risk Tag Address	Interactions with high-risk address
Interact With Medium-risk Tag Addresses	Interactions with medium-risk address

Risk Item

Malicious Address

Address directly involved in malicious events, Example: DeFi protocol exploiters, centralized exchange hackers, sanctioned addresses, etc.

Suspected Malicious Address

Address associated with malicious events

High-risk Tag Address

High-risk entity address, Example: Mixers, some nested exchanges, etc.

Medium-risk Tag Address

High-risk entity address, Example: Mixers, some nested exchanges, etc.

Mixer

Mixer entity address, Example: Tornado Cash, etc.

Risk Exchange

Exchanges that do not require KYC

Gambling

Gambling entity address

Involved Theft Activity

Address involved in theft events

Involved Ransom Activity

Address involved in ransom events

Involved Phishing Activity

Address involved in phishing events

Interact With Malicious Address

Interactions with malicious address

Interact With Suspected Malicious Address

Interactions with suspected malicious address

Interact With High-risk Tag Address

Interactions with high-risk address

Interact With Medium-risk Tag Addresses

Interactions with medium-risk address

Risk Level Guide

Risk Level	Risk Score	Suggested Operations
Severe	91 ~ 100	Prohit withdrawals & trade, and report address immediately
High	71 ~ 90	Maintain high level surveillance, and analyze via zkMe KYT AML platform or kytopenapi to conduct transaction analysis
Moderate	31 ~ 70	Moderate supervision required
Low	0 ~ 30	Minimal supervision required

Risk Level

Risk Score

Suggested Operations

Severe

91 ~ 100

Prohit withdrawals & trade, and report address immediately

High

71 ~ 90

Maintain high level surveillance, and analyze via zkMe KYT AML platform or kytopenapi to conduct transaction analysis

Moderate

31 ~ 70

Moderate supervision required

Low

0 ~ 30

Minimal supervision required

Get Transactions Investigation

https://openapi.zk.me/kyt/v1/transactions/investigation
   ?coin=ETH
   &address={address}
   &api_key=YourApiKey

Parameters

Name	Type	Description
coin	string	The coin to check for transaction investigation, all optional values can be found here
address	string	The address to check for transaction investigation
api_key	string	Your API key
start_timestamp	int	The start timestamp to check for transaction investigation (optional, default is 0)
end_timestamp	int	The end timestamp to check for transaction investigation (optional, default is current timestamp)
type	string	The type to check for transaction investigation (optional value “in”, “out” and “all”, default is “all”)
page	int	Page number (optional, default is 1)

Name

Type

Description

coin

string

The coin to check for transaction investigation, all optional values can be found here

address

string

The address to check for transaction investigation

api_key

string

Your API key

start_timestamp

int

The start timestamp to check for transaction investigation (optional, default is 0)

end_timestamp

int

The end timestamp to check for transaction investigation (optional, default is current timestamp)

type

string

The type to check for transaction investigation (optional value “in”, “out” and “all”, default is “all”)

page

int

Page number (optional, default is 1)

Sample Response

  "code": 200,
  "message": "success",
  "data": {
    "in": [
      {
        "address": "0xcdd37ada79f589c15bd4f8fd2083dc88e34a2af2",
        "amount": 0.3615,
        "label": "sideshift.ai",
        "tx_hash_list": [
          "0x5cc3de8969e2642f6562fe3c0d32f0136a046e53f95ca1f40fe0b7e069f6646c"
        ],
        "type": 3
      },
      {
        "address": "0x68b3465833fb72a70ecdf485e0e4c7bd8665fc45",
        "amount": 735.5724,
        "label": "Uniswap V3: Router 2",
        "tx_hash_list": [
          "0x127fcdb6f30228045d07525940b628e9d1c2d343d4d2d79a41f078eecf67d869",
          "0x7f14257482969941aaa6fef9b27bbd48cae828c5df7c6246c8b2d9f7cfa8acbe",
          "0x5e6cad442ee522055512514616cb9465f551d81096c09b183175609db177e8da",
          "0x87032b673fa3264e491e6770209a2457ae4d765c0f504d87b4467e7e907fafaa",
          "0x33cdf3daee948390200254e8a0a0580a6b12ca813f45788c359bd389ed3bcce0",
          "0xac1139c366727e434de7ae3334d5acb95d2f0dcf3bfc43544dd768491e2e2890",
          "0x24952d8c3ec6dbf4c468518e9ff67f9d97ac9963ceb71ecab9ff58014a914ec8"
        ],
        "type": 3
      },
      {
        "address": "0xd9e1ce17f2641f24ae83637ab66a2cca9c378b9f",
        "amount": 0.4158,
        "label": "SushiSwap: Router",
        "tx_hash_list": [
          "0xcbb552f4929b9ab891884189be2d885468de774d7644b53c54c21ef810b4a01d"
        ],
        "type": 3
      },
      {
        "address": "0xb3065fe2125c413e973829108f23e872e1db9a6b",
        "amount": 0.0098,
        "label": "Malicious address, Theft, MMFinance Exploiter",
        "tx_hash_list": [
          "0x24dcf60c17a2c068549e3cfcfce8e131ff65ec0ef414218feb2c2b198b3a6280"
        ],
        "type": 2
      },
      {
        "address": "0x910cbd523d972eb0a6f4cae4618ad62622b39dbf",
        "amount": 9.9364,
        "label": "Tornado.Cash: 10 ETH",
        "tx_hash_list": [
          "0x113be3df8e1e95cacd51d57ad1022fb7181bd19650648a346c29c540801a45a0"
        ],
        "type": 3
      }
    ],
    "out": [
      {
        "address": "0xd90e2f925da726b50c4ed8d0fb90ad053324f31b",
        "amount": 743,
        "label": "Tornado.Cash: Router",
        "tx_hash_list": [
          "0x48c2601bcb2f3cc5a4b047d0151322d74b525c79fc68a052ba6e7faf1231017c",
          "0x7e87c61d423a3ea98937c16e4519069410212b16b6614daa9a84110a7422a12a",
          "0x9b8b6c6a141476fd7727a3e89fab94bd14638149430cb2512d7f0c6e731ab4ad",
          "0x6cba946ea79e77592a5a2dda2cd2a0806f568fae4f5f129624a621c7b36b8698",
          "0x8c558551d9b56e5643235d9dfe3865ce78b77630f789b1b7b02f7927ffd4b5b6",
          "0x5a2a96e722ce113fd22a919b08f51b2d49ab7b90784c2b11386380093e6c4d99",
          "0xaec81680d2bb4c8dbfbf150edb92abb618ef345c3325e62c0472b14f84e3a4ae",
          "0xf1b495be2beb828b88d6b60afd613bc9c7eadd9a7b51b98f03d48809f1136bfb",
          "0xefe8a14dfca2394b5ef914e9e0c3f83a07c83dc4eaf3187769384744d746cdf3",
          "0x0e4be586fe14b3aa2585fe3af0fa69cc5f3092c11d1e398987df46b28daa7ab3",
          "0xb2c5dcb6c2af88b2d139c575f7e575e8fd70bc225de72c99a142c9540a406635",
          "0x979711c7760844ca0cc5c04436676e12c0c3d9d8f4abe429fa2b5b8b21c685dc",
          "0x91cca8652cd00559fd0ff63557a967a14c13507d90e35acb4e71d8aed9fa65b8",
          "0x2acf21485518c305d40da718a415519c8c4fecf43323f45a2a945f400083d9fe"
        ],
        "type": 3
      },
      {
        "address": "0x7e46480d8e28c1d6c55be1b782084dd2c902f99f",
        "amount": 0.0845,
        "label": "Suspected malicious address, Theft",
        "tx_hash_list": [
          "0xf3ba8038e1e22017a91efa5d87685891b90f081a1da4f5098c8c7c8d97519e85"
        ],
        "type": 2
      },
      {
        "address": "0x259838b05d61717e37fc7b6bf0758d25644ee930",
        "amount": 0.0795,
        "label": "binance",
        "tx_hash_list": [
          "0xaa5eccb2fa452770e5a4026d8b335c8a292e7166832116c3e6494c384dc3ec87"
        ],
        "type": 3
      },
      {
        "address": "0xf8dfe4da86f8e73fec7383784f96752255d50fdc",
        "amount": 0.0428,
        "label": "Suspected malicious address, Theft",
        "tx_hash_list": [
          "0x5e58958244228e3954550f5dea9065b1622a29ad77821e4a1a669a01fd3e60b0"
        ],
        "type": 2
      },
      {
        "address": "0x68b3465833fb72a70ecdf485e0e4c7bd8665fc45",
        "amount": 0.65,
        "label": "Uniswap V3: Router 2",
        "tx_hash_list": [
          "0x1854e70f60ca81ada0d842242cfc34fbb2a107e825389cb24485733d1a3bda5c",
          "0xf620d29dd717035ed94e6c325b28d5ed2ac173022a0577463a9c9d4c1ce1a10a"
        ],
        "type": 3
      },
      {
        "address": "0xd32998321e43fcdb0482101a7aed9496813e06d0",
        "amount": 1.4668,
        "label": "Suspected malicious address, Theft",
        "tx_hash_list": [
          "0x2e565664bb8b29a3930207a2df2f46045c4c0eba8882c8b57cab67c35437992b",
          "0xf4b19bde3035c0a1a4bef62132b8c1f1577b3910d32718bad9e5261f60194833",
          "0x6a939a4dbf30a1f291e4fa9ba010294226acdad7a4fd8a6010b94ca1694515f4",
          "0x8eba59c2632d55a99324b2a2d218dba64b40e6a2ed32f0aac75c29f53203dfcd",
          "0x264e5295660cc469165cb26de5e6ac2257e9f15920c6d0d5ddb8a0ca4d15a45a",
          "0xad604f2e3ba83c4dadc540919ad86077cf8d589f08f70ab1482144a5f5bb46ef"
        ],
        "type": 2
      }
    ],
    "page": 1,
    "total_pages": 1,
    "transactions_on_page": 36
  }
}

Response Data Parameters

Name	Type	Description
in	array	The transfer-in transaction list of the querying address
out	array	The transfer-out transaction list of the querying address
page	int	The current page number
total_pages	int	The total page number
transactions_on_page	int	The number of transactions investigated on the current page (maximum is 1000)

Name

Type

Description

array

The transfer-in transaction list of the querying address

out

array

The transfer-out transaction list of the querying address

page

int

The current page number

total_pages

int

The total page number

transactions_on_page

int

The number of transactions investigated on the current page (maximum is 1000)

Response Data Unit Parameters

Name	Type	Description
address	array	The transfer-in transaction list of the querying address
amount	array	The transfer-out transaction list of the querying address
label	string	Address label detail
tx_hash_list	array	Transfer transaction hash list
type	int	1: EOA address / bitcoin address; 2: malicious address; 3: entity label address; 4: contract address

Name

Type

Description

address

array

The transfer-in transaction list of the querying address

amount

array

The transfer-out transaction list of the querying address

label

string

Address label detail

tx_hash_list

array

Transfer transaction hash list

type

int

1: EOA address / bitcoin address; 2: malicious address; 3: entity label address; 4: contract address

PreviousWidget UI Design NextBest Practices

Last updated 1 month ago