API Method for retrieving address information.

When sending a request to the API, you need to include the following header:

X-Api-Key: {API Key} - This header is used for authentication. You need to pass your unique API key, which you received during registration, in the X-Api-Key header. Without this key, the request will not be authorized, and you will not be able to access the API data.

Example of a request:

curl -X 'GET' \\
  '<https://app.matchsystems.com/api/v4/btc/risk/address/{address}>' \\
  -H 'accept: application/json' \\
  -H 'X-Api-Key: {API Key}'

Address Query

Parameter Name Description
network Network, values: btc, eth, tron, bsc, polygon, ton
address Address hash

Response Format

{
  "risk": 0,
  "category": {
    "additionalProp1": {
      "number": 0,
      "percent": 0,
      "name": "string"
    },
    "additionalProp2": {
      "number": 0,
      "percent": 0,
      "name": "string"
    },
    "additionalProp3": {
      "number": 0,
      "percent": 0,
      "name": "string"
    }
  },
  "cluster": "string"
}

Parameter Descriptions

№ Name Description
1 risk Overall risk is filled according to the following priorities:
Risk for the address marked manually based on evidence (Reported);
Cluster risk (Cluster);
Algorithmic risk (Calculated).
More detailed information about risks can be viewed in the Risk Definition document.
2 category Overall category is filled according to the following priorities:
  1. Risk category for the address marked manually based on evidence (Reported);
  2. Cluster category;
  3. Algorithmic risk category with the highest risk percentage. The complete list of all categories can be retrieved using the method: ‣ | | 2.1 | category/additionalProp1 | In blocks items/additionalProp1, items/additionalProp2, etc., the risk value for each separate category present at the current address is described. | | 2.2 | items/additionalProp1/number | Category number according to the Category Directory. | | 2.3 | category/additionalProp1/percent | Calculated risk for the specified category. | | 2.4 | category/additionalProp1/name | Category name. | | 3 | cluster | Name of the cluster owner. |

Error Codes

Code Description
200 Successful request. The response depends on the request method.
400 Invalid request. The request was formulated incorrectly.
401 Unauthorized. The client did not provide a token, its action has expired, or the token is not valid. The client should renew the access token (if previously authorized) or undergo authorization.
402 Payment Required. Reserved for future use.
403 Forbidden. No rights to access the requested resource.
404 Not Found. The requested resource cannot be found.

Messages

Message Description
{ 
   "error": "not found"

} | At the specified address in the blockchain, there are no transactions; therefore, risk information in the system is unavailable. |