Username Footprint

GET

api

footprint

create-task

Username Footprint

curl --request GET \
  --url https://www.osintcat.net/api/footprint/create-task \
  --header 'X-API-KEY: <x-api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://www.osintcat.net/api/footprint/create-task', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/footprint/create-task",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.osintcat.net/api/footprint/create-task"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/footprint/create-task")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "task_id": "<string>",
  "status": "<string>",
  "_meta": {
    "plan": "<string>",
    "lookups_left": "<string>"
  },
  "stats": {
    "checked": 123,
    "total_modules": 123,
    "found": 123,
    "elapsed": "<string>"
  },
  "results": [
    {
      "domain": "<string>",
      "taken": true,
      "ExtraData": {}
    }
  ]
}

The Username Footprint API checks whether a given username is registered across social media, gaming, and community platforms. It returns a summary and a per-platform breakdown including secondary metadata like profile IDs or account status where available. The lookup backend is load-balanced, so footprint scans run as asynchronous tasks:

Create a task with GET /api/footprint/create-task (this is where one lookup is charged). You receive a task_id.
Poll the task with GET /api/footprint/get-task?id=<task_id> until status is no longer a running state. Polling is free.

Username and email footprints share the same task endpoints — only the type parameter differs (username vs email).

Step 1 — Create Task

GET https://www.osintcat.net/api/footprint/create-task

string

required

The username to scan (e.g., johndoe)

string

default:"email"

required

The footprint type. Use username for this endpoint.

string

required

Your API key

Creating a task consumes exactly one lookup from your daily quota. Polling get-task does not.

Response Body

string

The identifier used to poll for results.

string

The initial task status (e.g., running, queued, pending).

object

Show properties

string

Your current plan.

string

Remaining lookups for the day (unlimited on the Max plan).

{
  "task_id": "f3c8a1e2-9b44-4d51-bd0a-1c2e3f4a5b6c",
  "status": "running",
  "_meta": {
    "plan": "researcher",
    "lookups_left": 4821
  }
}

Step 2 — Poll Task

GET https://www.osintcat.net/api/footprint/get-task

string

required

The task_id returned by create-task.

string

required

Your API key

Poll roughly once per second until status is no longer one of the running states (running, queued, pending, processing, started). A scan typically completes within a few seconds and is capped at ~3 minutes. Response Body

string

Current task status. While running it is one of running, queued, pending, processing, started. Any other value (e.g., done, finished) means the scan is complete.

object

Live progress / summary counters (populated as the scan runs).

Show properties

number

Number of platforms checked so far.

number

Total number of platforms in the scan.

number

Number of platforms where the username was found.

string

Elapsed scan time.

array

List of platform results (grows as the scan progresses).

Show item properties

string

Platform domain (e.g., github.com)

boolean

True if the username is registered on this platform

object

Metadata retrieved from the platform (profile IDs, avatar URLs, follower counts, etc.)

Example

# 1. Create the task
curl "https://www.osintcat.net/api/footprint/create-task?query=johndoe&type=username" \
     -H "X-API-KEY: YOUR_API_KEY"

# 2. Poll until done (replace TASK_ID with the returned task_id)
curl "https://www.osintcat.net/api/footprint/get-task?id=TASK_ID" \
     -H "X-API-KEY: YOUR_API_KEY"

import time
import requests

BASE = "https://www.osintcat.net"
HEADERS = {"X-API-KEY": "YOUR_API_KEY"}
RUNNING = {"running", "queued", "pending", "processing", "started"}

# 1. Create the task (charges one lookup)
task = requests.get(
    f"{BASE}/api/footprint/create-task",
    params={"query": "johndoe", "type": "username"},
    headers=HEADERS,
).json()
task_id = task["task_id"]

# 2. Poll until the scan finishes
while True:
    data = requests.get(
        f"{BASE}/api/footprint/get-task",
        params={"id": task_id},
        headers=HEADERS,
    ).json()
    if str(data.get("status", "")).lower() not in RUNNING:
        break
    time.sleep(1)

print(data)

const BASE = 'https://www.osintcat.net';
const HEADERS = { 'X-API-KEY': 'YOUR_API_KEY' };
const RUNNING = ['running', 'queued', 'pending', 'processing', 'started'];
const sleep = ms => new Promise(r => setTimeout(r, ms));

(async () => {
  // 1. Create the task (charges one lookup)
  const task = await fetch(
    `${BASE}/api/footprint/create-task?query=johndoe&type=username`,
    { headers: HEADERS }
  ).then(r => r.json());

  // 2. Poll until the scan finishes
  let data;
  do {
    data = await fetch(
      `${BASE}/api/footprint/get-task?id=${encodeURIComponent(task.task_id)}`,
      { headers: HEADERS }
    ).then(r => r.json());
    if (!RUNNING.includes(String(data.status).toLowerCase())) break;
    await sleep(1000);
  } while (true);

  console.log(data);
})();

<?php

$base = "https://www.osintcat.net";
$headers = ["X-API-KEY: YOUR_API_KEY"];
$running = ["running", "queued", "pending", "processing", "started"];

function get_json($url, $headers) {
    $curl = curl_init();
    curl_setopt_array($curl, [
        CURLOPT_URL => $url,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => $headers,
    ]);
    $response = curl_exec($curl);
    curl_close($curl);
    return json_decode($response, true);
}

// 1. Create the task (charges one lookup)
$task = get_json("$base/api/footprint/create-task?query=johndoe&type=username", $headers);
$taskId = $task["task_id"];

// 2. Poll until the scan finishes
do {
    $data = get_json("$base/api/footprint/get-task?id=" . urlencode($taskId), $headers);
    if (!in_array(strtolower($data["status"]), $running)) break;
    sleep(1);
} while (true);

print_r($data);

package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "net/url"
    "strings"
    "time"
)

func getJSON(u string) map[string]interface{} {
    req, _ := http.NewRequest("GET", u, nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    var out map[string]interface{}
    json.Unmarshal(body, &out)
    return out
}

func main() {
    base := "https://www.osintcat.net"
    running := map[string]bool{"running": true, "queued": true, "pending": true, "processing": true, "started": true}

    // 1. Create the task (charges one lookup)
    params := url.Values{}
    params.Add("query", "johndoe")
    params.Add("type", "username")
    task := getJSON(base + "/api/footprint/create-task?" + params.Encode())
    taskID, _ := task["task_id"].(string)

    // 2. Poll until the scan finishes
    var data map[string]interface{}
    for {
        data = getJSON(base + "/api/footprint/get-task?id=" + url.QueryEscape(taskID))
        status, _ := data["status"].(string)
        if !running[strings.ToLower(status)] {
            break
        }
        time.Sleep(time.Second)
    }
    fmt.Printf("%+v\n", data)
}

Example Result (completed task)

{
  "status": "done",
  "stats": {
    "checked": 112,
    "total_modules": 112,
    "found": 34,
    "elapsed": "5.1s"
  },
  "results": [
    {
      "domain": "github.com",
      "taken": true,
      "ExtraData": {
        "ProfileURL": "https://github.com/johndoe",
        "PublicRepos": 17
      }
    },
    {
      "domain": "reddit.com",
      "taken": false,
      "ExtraData": {}
    }
  ]
}

Username Footprint

curl --request GET \
  --url https://www.osintcat.net/api/footprint/create-task \
  --header 'X-API-KEY: <x-api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://www.osintcat.net/api/footprint/create-task', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/footprint/create-task",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.osintcat.net/api/footprint/create-task"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/footprint/create-task")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "task_id": "<string>",
  "status": "<string>",
  "_meta": {
    "plan": "<string>",
    "lookups_left": "<string>"
  },
  "stats": {
    "checked": 123,
    "total_modules": 123,
    "found": 123,
    "elapsed": "<string>"
  },
  "results": [
    {
      "domain": "<string>",
      "taken": true,
      "ExtraData": {}
    }
  ]
}

Overview

Account

OSINT Lookups

Network & Domain

Public Records

Vehicle

Gaming

Resolvers

Machine Viewer

FootPrint Intel

Step 1 — Create Task

Step 2 — Poll Task

Example

​Step 1 — Create Task

​Step 2 — Poll Task

​Example

Step 1 — Create Task

Step 2 — Poll Task

Example