Breach Lookup

GET

api

breach

curl "https://www.osintcat.net/api/breach?query=user%40example.com" \
     -H "X-API-KEY: YOUR_API_KEY"

import requests

url = "https://www.osintcat.net/api/breach"
params = {"query": "user@example.com"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers, timeout=60)
print(response.status_code, response.json())

const response = await fetch("https://www.osintcat.net/api/breach?query=user%40example.com", {
  headers: { "X-API-KEY": "YOUR_API_KEY" },
});
console.log(response.status, await response.json());

<?php
$curl = curl_init("https://www.osintcat.net/api/breach?query=user%40example.com");
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
echo $status . " " . $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/breach?query=user%40example.com", nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(resp.StatusCode, string(body))
}

{
  "api": "OsintCat",
  "elapsed_ms": 1843.27,
  "timestamp": "Oct 6th 09:41",
  "results_count": 1,
  "breach_data": [
    {
      "email": "user@example.com",
      "username": "user123",
      "password": "hunter2",
      "source_db": "EXAMPLE_COM_2019"
    }
  ],
  "_meta": {
    "plan": "investigator",
    "lookups_left": 741
  }
}

Searches the breach indexes (including Snusbase, LeakCheck and IntelX) for a value and returns every matching record. The search is case-insensitive.

Results for the same query may come from a cache for up to two days.

Parameters

string

required

What to search for: an e-mail address, username, domain, phone number, IP address, name or password.

Headers

string

required

Your API key.

Usage

Counts as one lookup against your plan’s daily allowance (Max: unlimited). When the allowance is used up, the lookup can continue at a per-lookup price charged to your balance (the module’s page in the dashboard shows the price); a lookup that finds nothing is not charged.

Example request

curl "https://www.osintcat.net/api/breach?query=user%40example.com" \
     -H "X-API-KEY: YOUR_API_KEY"

import requests

url = "https://www.osintcat.net/api/breach"
params = {"query": "user@example.com"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers, timeout=60)
print(response.status_code, response.json())

const response = await fetch("https://www.osintcat.net/api/breach?query=user%40example.com", {
  headers: { "X-API-KEY": "YOUR_API_KEY" },
});
console.log(response.status, await response.json());

<?php
$curl = curl_init("https://www.osintcat.net/api/breach?query=user%40example.com");
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
echo $status . " " . $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/breach?query=user%40example.com", nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(resp.StatusCode, string(body))
}

SDK example

The same request with the official SDKs. Each one reads your key from OSINTCAT_API_KEY.

import { OsintCatClient } from "osintcat";

const client = new OsintCatClient(); // reads OSINTCAT_API_KEY

const result = await client.breach.search({
    query: "user@example.com"
});
console.log(result);

from osintcat import OsintCat

client = OsintCat()  # reads OSINTCAT_API_KEY

result = client.breach.search(
    query="user@example.com",
)
print(result)

package main

import (
	"context"
	"fmt"

	osintcat "github.com/OsintCatHQ/osintcat-go"
	osintcatclient "github.com/OsintCatHQ/osintcat-go/client"
)

func main() {
	client := osintcatclient.NewClient() // reads OSINTCAT_API_KEY
	request := &osintcat.SearchBreachRequest{
		Query: "user@example.com",
	}
	result, err := client.Breach.Search(context.Background(), request)
	if err != nil {
		panic(err)
	}
	fmt.Printf("%+v\n", result)
}

<?php
require __DIR__ . '/vendor/autoload.php';

use OsintCat\OsintCatClient;
use OsintCat\Breach\Requests\SearchBreachRequest;

$client = new OsintCatClient(); // reads OSINTCAT_API_KEY

$result = $client->breach->search(
    new SearchBreachRequest([
        'query' => 'user@example.com',
    ]),
);
echo json_encode($result, JSON_PRETTY_PRINT), PHP_EOL;

Response

string

Always OsintCat.

number

Time the search took, in milliseconds.

string

When the search ran (UTC), e.g. Oct 6th 09:41.

number

Number of records in breach_data.

array

Matching records. The fields of a record depend on the breach it comes from (for example email, username, password, hash, ip, name, phone); source_db names the breach or index the record was found in.

object

Your usage after this request.

Show properties

string

Plan id.

number | string

Lookups left today, unlimited on Max, or charging when the allowance is used up and the lookup was charged to your balance.

{
  "api": "OsintCat",
  "elapsed_ms": 1843.27,
  "timestamp": "Oct 6th 09:41",
  "results_count": 1,
  "breach_data": [
    {
      "email": "user@example.com",
      "username": "user123",
      "password": "hunter2",
      "source_db": "EXAMPLE_COM_2019"
    }
  ],
  "_meta": {
    "plan": "investigator",
    "lookups_left": 741
  }
}

Errors

See Errors for the responses every endpoint can return.

curl "https://www.osintcat.net/api/breach?query=user%40example.com" \
     -H "X-API-KEY: YOUR_API_KEY"

import requests

url = "https://www.osintcat.net/api/breach"
params = {"query": "user@example.com"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers, timeout=60)
print(response.status_code, response.json())

const response = await fetch("https://www.osintcat.net/api/breach?query=user%40example.com", {
  headers: { "X-API-KEY": "YOUR_API_KEY" },
});
console.log(response.status, await response.json());

<?php
$curl = curl_init("https://www.osintcat.net/api/breach?query=user%40example.com");
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
echo $status . " " . $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/breach?query=user%40example.com", nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(resp.StatusCode, string(body))
}

{
  "api": "OsintCat",
  "elapsed_ms": 1843.27,
  "timestamp": "Oct 6th 09:41",
  "results_count": 1,
  "breach_data": [
    {
      "email": "user@example.com",
      "username": "user123",
      "password": "hunter2",
      "source_db": "EXAMPLE_COM_2019"
    }
  ],
  "_meta": {
    "plan": "investigator",
    "lookups_left": 741
  }
}

Overview

Account

Breach & Leak Data

Machine Viewer

E-mail, Phone & Network

Social & Developer Profiles

Gaming

Link Resolvers

Vehicles & Public Records

Currently Unavailable

Parameters

Headers

Usage

Example request

SDK example

Response

Errors

​Parameters

​Headers

​Usage

​Example request

​SDK example

​Response

​Errors

Parameters

Headers

Usage

Example request

SDK example

Response

Errors