Documentation

Introduction

all requests and responses to our API are formatted as JSON. therefor in the following documentation we assume that all requests are formatted as JSON objects. In addition to that, all requests must have Content-Type header set to 'application/json'
Authentication is done using embedding the authentication token in the X-ApiKey header within every request

Overview

This API call returns the analytics stats for a given domain specifying the following data items:

Exposed email addresses count
Exposed email related password-hash count
Exposed email weak hash count
Exposed email related cleartext password count

URL

POST https://cybertrace.online/api/breached_db/get_domain_stats

PARAMETERS

domain:

The requested domain

EXAMPLE

POST /api/breached_db/get_domain_stats HTTP/1.1
Host: cybertrace.online
X-apikey: 72f24123b685f8111b69549af44f0b460ea5d677532561b9d58b9fba9de7285a

{
    "domain": "wwww.google.com"
}

Response Types

The following are existing response types by their HTTP response codes -

200

Request has been successful, requested data should appear in the response body like the following example. use the get_report api call.

Example response body -

{
    "domain": "cybertrace.online",
    "exposed_emails_count": 7,
    "exposed_hashed_passwords_count": 3,
    "exposed_weak_hashed_passwords_count": 1,
    "exposed_passwords_count": 3
}

Overview

This API call returns a list of all the e-mail addresses that were exposed on breaches/leaks together with their stats belonging to the given domain address

URL

POST https://cybertrace.online/api/breached_db/get_email_stats

PARAMETERS

domain:

the target domain to be checked

EXAMPLE

POST /api/breached_db/get_email_stats HTTP/1.1
Host: cybertrace.online
X-apikey: 72f24123b685f8db8b61111af44f0b460ea5d677532561b9d58b9fba9de7285a

{
  "domain": "wwww.google.com"
}

Response Types

The following are existing response types by their HTTP response codes -

200

inspection request has been created and is being processed. in order to get the status and data of a successful request use the get_report api call.

Example response body -

{
    "exposed_credentials": [
        {
            "email": "sam.sammy@cybertrace.online",
            "has_hashed_password": false,
            "has_weak_hashed_password": false,
            "has_plain_password": true,
        },
        {
            "email": "leonardo.d@cybertrace.online",
            "has_hashed_password": false,
            "has_weak_hashed_password": false,
            "has_plain_password": true,
        }
    ]
}

Overview

This API is used to get the current quota consumption stats.

URL

GET https://cybertrace.online/api/get_quota

EXAMPLE

GET /api/get_quota HTTP/1.1
Host: cybertrace.online
X-apikey: 72f24123b685f8db8111149af44f0b460ea5d677532561b9d58b9fba9de7285a

Response Types

The following are existing response types by their HTTP response codes -

200

The response should contain the amount of consumed quota as well as the limit as set by the type of subscription

Example response body -

{
    "consumed_quota": 23,
    "quota_limit": 10000
}