API Reference

API endpoints and their associated responses.

Check liveliness - ping the API.

get

Returns OK to indicate that the API is reachable.

Responses
200
Ping successful
text/plain
ResponsestringExample: OK
get
GET /ping HTTP/1.1
Host: api.conblox.xyz
Accept: */*
200

Ping successful

OK

Performs basic API Key checks.

post

Returns the validity and credits of an API key.

Body
apiKeystringRequired

API key to check.

Example: YOUR_API_KEY
Responses
200
API key validation result
application/json
post
POST /checkKey HTTP/1.1
Host: api.conblox.xyz
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "apiKey": "YOUR_API_KEY"
}
{
  "apiKeyValid": true,
  "data": {
    "credits": 100
  }
}

Run an Ethereum address through our fraud detection model.

post

Returns probability that the input address belongs to a scammer/fraudster.

Authorizations
Body
addressstringRequired

Ethereum address to predict.

Example: 0x48eaafd2de4539702a5fd2d55890ca12cf97123e
Responses
200
Prediction successful
application/json
post
POST /predictAddressSingle HTTP/1.1
Host: api.conblox.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "address": "0x48eaafd2de4539702a5fd2d55890ca12cf97123e"
}
{
  "status": "success",
  "data": {
    "address": "0x48eaafd2de4539702a5fd2d55890ca12cf97123e",
    "avgPrediction": 0.9317,
    "module1": 0.9733,
    "module2": 0.89,
    "predictedClassId": 1,
    "predictedClassName": "scammer"
  }
}

/predictAddressSingle responses

HTTP Code
Response type
Data
Description / Resolution

200

Success

{

"status": "success",

"data": {

"address": "0xc7[...]5a36",

"avgPrediction": 0.0233,

"module1": 0,

"module2": 0.0467,

"predictedClassId": 0,

"predictedClassName": "nonScammer"

}

}

This is the standard response. The model output avgPrediction is the average of outputs from 2 modules. Each module is a different model than runs on the same data, in most cases their predictions will be very close.

200

Warning - Contract address

{

"status": "warning",

"data": {

"address": "0x00[...]600f",

"isContract": true

}

}

This is not an error per se. Our model only provides fraud assessments for EOA addresses and not smart contracts. Pass a non-smart contract to get the model results.

400

Low credits

{"error": "Not enough credits"}

Top-up your credits or reach out to us.

400

Missing Address

{"error": "Address argument was not passed"}

Pass an Ethereum address in the body of the request. Param name address

400

Invalid Address type

{"error": "Invalid address: address must be of string type"}

Don't pass an array of addresses but a single 42-character ethereum address only.

400

Invalid Address format

{"error": "Invalid address: address must be an EVM address"}

Make sure your address complies with the EVM address format: 0x followed by 40 hexadecimal characters.

400

Server error

{"error": "Request could not be processed, please retry"}

Retry the request. If the problem persists, please reach out to us.

401

Unauthorized

{"error": "API Key is missing"}

Pass your API key in the X-API-Key header of your request.

403

Forbidden

{"error": "Invalid API Key"}

Make sure the API Key you passed is correct. Check its validity in the checkKey endpoint. If your API Key should be valid but our systems say otherwise, please reach out to us.

PreviousAPI Keys and creditsNextCredits

Last updated