API Reference

API endpoints and their associated responses.

Check liveliness - ping the API.

Returns OK to indicate that the API is reachable.

GEThttps://api.conblox.xyz/ping

Response

200

Ping successful

Body

text/plain

string

Example: "OK"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.conblox.xyz/ping', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

OK

Performs basic API Key checks.

Returns the validity and credits of an API key.

POSThttps://api.conblox.xyz/checkKey

Body

application/json

apiKey*string

API key to check.

Example: "YOUR_API_KEY"

Response

200400

API key validation result

Body

application/json

apiKeyValidboolean

Example: true

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.conblox.xyz/checkKey', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "apiKey": "YOUR_API_KEY"
    }),
});
const data = await response.json();

Response

200400

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

Run an Ethereum address through our fraud detection model.

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

POSThttps://api.conblox.xyz/predictAddressSingle

Authorization

ApiKeyAuth

Body

application/json

address*string

Ethereum address to predict.

Example: "0x48eaafd2de4539702a5fd2d55890ca12cf97123e"

Response

200400401403

Prediction successful

Body

application/json

statusstring

Example: "success"

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.conblox.xyz/predictAddressSingle', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "0x48eaafd2de4539702a5fd2d55890ca12cf97123e"
    }),
});
const data = await response.json();

Response

200400401403

{
  "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.