Get a risk assessment using BitRank

POST 
/kyt/bitrankAnalysis

Get a risk assessment for a given wallet address using BitRank. Requires the BitRank provider.

Request

application/json

Body

required

crypto stringnullable

Possible values: [btc, eth, ltc, bch, xrp, xlm, sys, xdc, doge, dash, zec, trx, etc, bsc]

Default value: eth

address stringnullable

String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet.

properties object[]nullable
Optional query parameter to specify properties to include in the response.
Array [
property stringrequired
Possible values: [score, entities, flags, currency, new_address, flags_with_category, cluster, first_seen_receiving, first_seen_sending, last_seen_receiving, last_seen_sending, received_amount, sent_amount, number_of_transactions, received_transactions, sent_transactions, balance, balance_fiat, bitrank_counterparty_exposure, entity_counterparty_exposure, flag_counterparty_exposure]
]
label stringnullable

Possible values: <= 255 characters

Optional string of up to 255 characters for labeling the search.

transactionsPerPage numbernullable

Optional parameter to specify the number of transactions per page in the response.

customerId stringrequired

Responses

200

Successful response

application/json

Schema

Schema

anyOf
MOD1
error object required
anyOf
MOD1
statusCode numberrequired
Possible values: [400]
errorCode stringrequired
Possible values: [INVALID_ADDRESS]
message stringrequired
Possible values: [The address provided isn't a valid address.]
MOD2
statusCode numberrequired
Possible values: [401]
errorCode stringrequired
Possible values: [API_KEY_NOT_FOUND]
message stringrequired
Possible values: [Your API key is not found.]
MOD3
statusCode numberrequired
Possible values: [403]
errorCode stringrequired
Possible values: [API_KEY_ARCHIVED]
message stringrequired
Possible values: [Your API key is archived.]
MOD4
statusCode numberrequired
Possible values: [403]
errorCode stringrequired
Possible values: [API_KEY_DISABLED]
message stringrequired
Possible values: [Your API key is disabled.]
MOD5
statusCode numberrequired
Possible values: [403]
errorCode stringrequired
Possible values: [SOURCE_IP_NOT_EQ_API_KEY_IPS]
message stringrequired
Possible values: [Your source IP does not match the IPs for your API key.]
MOD6
statusCode numberrequired
Possible values: [500]
errorCode stringrequired
Possible values: [INTERNAL_SERVER_ERROR]
message stringrequired
Possible values: [INTERNAL SERVER ERROR]
MOD7
statusCode numberrequired
Possible values: [500]
errorCode stringrequired
Possible values: [UNKNOWN_ERROR]
message stringrequired
MOD8
statusCode numberrequired
Possible values: [500]
errorCode stringrequired
Possible values: [RESULT_PARSER_ERROR]
message stringrequired
data stringrequired
MOD2
label string
currency string
new_address boolean
score number
entities object[]
Array [
label stringrequired
type stringrequired
]
flags string[]
flags_with_category object[]
Array [
name stringrequired
category stringrequired
]
cluster object
cluster_name stringrequired
cluster_identifier numberrequired
number_of_addresses_in_cluster numberrequired
first_seen_receiving number
first_seen_sending number
last_seen_receiving number
last_seen_sending number
received_amount number
sent_amount number
number_of_transactions number
received_transactions number
sent_transactions number
balance number
balance_fiat object
jpy numberrequired
eur numberrequired
usd numberrequired
cad numberrequired
bitrank_counterparty_exposure object
in objectrequired
updatedAt numberrequired
totalVolume numberrequired
exposure object[]required
Array [
min numberrequired
max numberrequired
count numberrequired
volume numberrequired
]
out objectrequired
updatedAt numberrequired
totalVolume numberrequired
exposure object[]required
Array [
min numberrequired
max numberrequired
count numberrequired
volume numberrequired
]
entity_counterparty_exposure object
in objectrequired
updatedAt numberrequired
totalVolume numberrequired
exposure object[]required
Array [
name stringrequired
count numberrequired
volume numberrequired
]
out objectrequired
updatedAt numberrequired
totalVolume numberrequired
exposure object[]required
Array [
name stringrequired
count numberrequired
volume numberrequired
]
flag_counterparty_exposure object
in objectrequired
updatedAt numberrequired
totalVolume numberrequired
exposure object[]required
Array [
name stringrequired
count numberrequired
volume numberrequired
]
out objectrequired
updatedAt numberrequired
totalVolume numberrequired
exposure object[]required
Array [
name stringrequired
count numberrequired
volume numberrequired
]
transactions object[]
Array [
hash stringrequired
amount numberrequired
fees numberrequired
]

Example (from schema)

{}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...