OsintCat API

https://www.osintcat.net
Admin
OsintCat API provides a powerful REST API for Open Source Intelligence (OSINT) lookups, including...
Tokens:120,072
Snippets:1,057
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get File Tree Implementation

Source: https://docs.osintcat.net/api-reference/endpoint/machine-viewer#content-area

Client-side implementation examples for fetching the file tree.

```bash
curl "https://www.osintcat.net/api/machine_viewer/machines/742e1f66-.../files/treeview" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

machine_id = "742e1f66-f449-4a6c-80d5-8f5eb8e9c2b5"
url = f"https://www.osintcat.net/api/machine_viewer/machines/{machine_id}/files/treeview"
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Get Machine Info Implementation

Source: https://docs.osintcat.net/api-reference/endpoint/machine-viewer#content-area

Client-side implementation examples for fetching machine information.

```bash
curl "https://www.osintcat.net/api/machine_viewer/machines/742e1f66-.../info" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

machine_id = "742e1f66-f449-4a6c-80d5-8f5eb8e9c2b5"
url = f"https://www.osintcat.net/api/machine_viewer/machines/{machine_id}/info"
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### DNS Resolver API Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/dns-resolver

Examples of how to perform a GET request to the DNS Resolver endpoint across multiple programming languages.

```curl
curl --request GET \
  --url https://www.osintcat.net/api/dns-resolver \
  --header 'X-API-KEY: <x-api-key>'
```

```python
import requests

url = "https://www.osintcat.net/api/dns-resolver"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

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

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/dns-resolver",
  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;
}
```

```go
package main

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

func main() {

	url := "https://www.osintcat.net/api/dns-resolver"

	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))

}
```

```java
HttpResponse<String> response = Unirest.get("https://www.osintcat.net/api/dns-resolver")
  .header("X-API-KEY", "<x-api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/dns-resolver")

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
```

--------------------------------

### Minecraft Lookup API Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/minecraft-osint

Examples for performing a GET request to the Minecraft lookup endpoint across multiple languages.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var client = new HttpClient())
        {
            try
            {
                string url = "https://www.osintcat.net/api/minecraft-lookup?query=Notch&type=username";
                client.DefaultRequestHeaders.Add("X-API-KEY", "YOUR_API_KEY");
                
                var response = await client.GetAsync(url);
                
                if (response.IsSuccessStatusCode)
                {
                    string content = await response.Content.ReadAsStringAsync();
                    Console.WriteLine(content);
                }
                else
                {
                    Console.WriteLine($"Error: {response.StatusCode}");
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error: {ex.Message}");
            }
        }
    }
}
```

```bash
curl --request GET \
  --url https://www.osintcat.net/api/minecraft-lookup \
  --header 'X-API-KEY: <x-api-key>'
```

```python
import requests

url = "https://www.osintcat.net/api/minecraft-lookup"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

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

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/minecraft-lookup",
  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;
}
```

```go
package main

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

func main() {

	url := "https://www.osintcat.net/api/minecraft-lookup"

	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))

}
```

```java
HttpResponse<String> response = Unirest.get("https://www.osintcat.net/api/minecraft-lookup")
  .header("X-API-KEY", "<x-api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/minecraft-lookup")

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
```

--------------------------------

### Create Task Response Example

Source: https://docs.osintcat.net/api-reference/endpoint/email-footprint

Example JSON response body returned after successfully creating a task.

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

--------------------------------

### Get File Tree Response

Source: https://docs.osintcat.net/api-reference/endpoint/machine-viewer#content-area

Example JSON response showing the hierarchical file structure.

```json
{
  "machine": "ZAEZBCAOHJNF",
  "total_files": 15,
  "tree": [
    {
      "name": "passwords",
      "type": "directory",
      "children": [
        { "name": "chrome.txt", "type": "file", "id": "abc123", "size": 1024 }
      ]
    }
  ]
}
```

--------------------------------

### Breach Lookup Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/breach#param-api

Examples of how to perform a GET request to the breach lookup endpoint using various programming languages.

```bash
curl --request GET \
  --url https://www.osintcat.net/api/breach \
  --header 'X-API-KEY: <x-api-key>'
```

```python
import requests

url = "https://www.osintcat.net/api/breach"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

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

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/breach",
  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;
}
```

```go
package main

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

func main() {

	url := "https://www.osintcat.net/api/breach"

	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))

}
```

```java
HttpResponse<String> response = Unirest.get("https://www.osintcat.net/api/breach")
  .header("X-API-KEY", "<x-api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/breach")

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
```

--------------------------------

### Domain Lookup Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/domain

Examples for querying domain information across multiple programming languages.

```bash
curl "https://www.osintcat.net/api/domain?query=example.com" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

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

response = requests.get(url, params=params, headers=headers)

if response.ok:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

```javascript
const url = 'https://www.osintcat.net/api/domain?query=example.com';

fetch(url, {
    headers: {
        'X-API-KEY': 'YOUR_API_KEY'
    }
})
    .then(res => res.json())
    .then(json => console.log(json))
    .catch(err => console.error('error:' + err));
```

```php
<?php

$curl = curl_init();

$url = "https://www.osintcat.net/api/domain?query=example.com";

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "X-API-KEY: YOUR_API_KEY"
    ],
]);

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

curl_close($curl);

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

```go
package main

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

func main() {
    baseURL := "https://www.osintcat.net/api/domain"
    params := url.Values{}
    params.Add("query", "example.com")
    
    fullURL := baseURL + "?" + params.Encode()
    
    req, _ := http.NewRequest("GET", fullURL, nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Error: %v\n", err)
        return
    }
    defer resp.Body.Close()
    
    body, _ := io.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    fmt.Printf("%+v\n", result)
}
```

```ruby
require 'net/http'
require 'json'
require 'uri'

uri = URI('https://www.osintcat.net/api/domain')
uri.query = URI.encode_www_form({ query: 'example.com' })

request = Net::HTTP::Get.new(uri)
request['X-API-KEY'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
end

if response.is_a?(Net::HTTPSuccess)
    data = JSON.parse(response.body)
    puts JSON.pretty_generate(data)
else
    puts "Error: #{response.code}"
end
```

```java
import java.net.HttpURLConnection;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class OsintCatAPI {
    public static void main(String[] args) {
        try {
            String apiUrl = "https://www.osintcat.net/api/domain?query=example.com";
            URL url = new URL(apiUrl);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("GET");
            conn.setRequestProperty("X-API-KEY", "YOUR_API_KEY");
            
            int responseCode = conn.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
                String inputLine;
                StringBuilder response = new StringBuilder();
                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }
                in.close();
                System.out.println(response.toString());
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var client = new HttpClient())
        {
            try
            {
                string url = "https://www.osintcat.net/api/domain?query=example.com";
                client.DefaultRequestHeaders.Add("X-API-KEY", "YOUR_API_KEY");
                
                var response = await client.GetAsync(url);
                
                if (response.IsSuccessStatusCode)
                {
                    string content = await response.Content.ReadAsStringAsync();
                    Console.WriteLine(content);
                }
                else
                {
                    Console.WriteLine($"Error: {response.StatusCode}");
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error: {ex.Message}");
            }
        }
    }
}
```

--------------------------------

### Get File Info & Content Response

Source: https://docs.osintcat.net/api-reference/endpoint/machine-viewer#get-file-info-%26-content

Example JSON response containing file metadata and content.

```json
{
  "id": "abc123",
  "filename": "chrome.txt",
  "path": "passwords/chrome.txt",
  "size": 1024,
  "content": "URL: https://example.com\nUsername: user@gmail.com\nPassword: ..."
}
```

--------------------------------

### Chilean Name API Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/chilean-name#example-request

Examples of how to perform a GET request to the Chilean Name endpoint using different programming languages and libraries. Replace <x-api-key> with your actual API key.

```curl
curl --request GET \
  --url https://www.osintcat.net/api/chilean-name \
  --header 'X-API-KEY: <x-api-key>'
```

```python
import requests

url = "https://www.osintcat.net/api/chilean-name"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

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

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/chilean-name",
  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;
}
```

```go
package main

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

func main() {

	url := "https://www.osintcat.net/api/chilean-name"

	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))

}
```

```java
HttpResponse<String> response = Unirest.get("https://www.osintcat.net/api/chilean-name")
  .header("X-API-KEY", "<x-api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/chilean-name")

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
```

--------------------------------

### Chilean Name API Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/chilean-name#example-request

Examples demonstrating how to query the Chilean name endpoint across various programming languages.

```bash
curl "https://www.osintcat.net/api/chilean-name?query=Juan%20Perez" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

url = "https://www.osintcat.net/api/chilean-name"
params = {"query": "Juan Perez"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers)

if response.ok:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

```javascript
const url = 'https://www.osintcat.net/api/chilean-name?query=Juan%20Perez';

fetch(url, {
    headers: {
        'X-API-KEY': 'YOUR_API_KEY'
    }
})
    .then(res => res.json())
    .then(json => console.log(json))
    .catch(err => console.error('error:' + err));
```

```php
<?php

$curl = curl_init();

$url = "https://www.osintcat.net/api/chilean-name?query=Juan%20Perez";

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "X-API-KEY: YOUR_API_KEY"
    ],
]);

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

curl_close($curl);

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

```go
package main

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

func main() {
    baseURL := "https://www.osintcat.net/api/chilean-name"
    params := url.Values{}
    params.Add("query", "Juan Perez")
    
    fullURL := baseURL + "?" + params.Encode()
    
    req, _ := http.NewRequest("GET", fullURL, nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Error: %v\n", err)
        return
    }
    defer resp.Body.Close()
    
    body, _ := io.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    fmt.Printf("%+v\n", result)
}
```

```ruby
require 'net/http'
require 'json'
require 'uri'

uri = URI('https://www.osintcat.net/api/chilean-name')
uri.query = URI.encode_www_form({ query: 'Juan Perez' })

request = Net::HTTP::Get.new(uri)
request['X-API-KEY'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
end

if response.is_a?(Net::HTTPSuccess)
    data = JSON.parse(response.body)
    puts JSON.pretty_generate(data)
else
    puts "Error: #{response.code}"
end
```

```java
import java.net.HttpURLConnection;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class OsintCatAPI {
    public static void main(String[] args) {
        try {
            String apiUrl = "https://www.osintcat.net/api/chilean-name?query=Juan%20Perez";
            URL url = new URL(apiUrl);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("GET");
            conn.setRequestProperty("X-API-KEY", "YOUR_API_KEY");
            
            int responseCode = conn.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
                String inputLine;
                StringBuilder response = new StringBuilder();
                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }
                in.close();
                System.out.println(response.toString());
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var client = new HttpClient())
        {
            try
            {
                string url = "https://www.osintcat.net/api/chilean-name?query=Juan%20Perez";
                client.DefaultRequestHeaders.Add("X-API-KEY", "YOUR_API_KEY");
                
                var response = await client.GetAsync(url);
                
                if (response.IsSuccessStatusCode)
                {
                    string content = await response.Content.ReadAsStringAsync();
                    Console.WriteLine(content);
                }
                else
                {
                    Console.WriteLine($"Error: {response.StatusCode}");
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error: {ex.Message}");
            }
        }
    }
}
```

--------------------------------

### Retrieve domain data via API

Source: https://docs.osintcat.net/api-reference/endpoint/domain#headers

Examples of how to perform a GET request to the domain endpoint with the required API key header across various programming languages.

```python
import requests

url = "https://www.osintcat.net/api/domain"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

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

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/domain",
  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;
}
```

```go
package main

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

func main() {

	url := "https://www.osintcat.net/api/domain"

	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))

}
```

```java
HttpResponse<String> response = Unirest.get("https://www.osintcat.net/api/domain")
  .header("X-API-KEY", "<x-api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/domain")

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
```

--------------------------------

### API Response Examples

Source: https://docs.osintcat.net/api-reference/endpoint/roblox

Examples of successful and error responses from the API.

```json
{
  "query": "demon*",
  "count": 2,
  "results": [
    {
      "roblox_name": "demonboy",
      "discord_id": "123456789012345678",
      "discord_username": "demon",
      "discord_avatar": "https://cdn.discordapp.com/avatars/123456789012345678/abc123.png?size=128"
    },
    {
      "roblox_name": "demon123",
      "discord_id": null
    }
  ]
}
```

```json
{ "error": "No matches found in database." }
```

--------------------------------

### Email OSINT Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/email-osint#check-credit-balance

Examples demonstrating how to query the Email OSINT endpoint across various programming languages. Ensure the X-API-KEY header is set to your valid API key.

```bash
# Using header for API Key and X-Purpose for reason
curl "https://www.osintcat.net/api/email-osint?query=test@example.com" \
     -H "X-API-KEY: YOUR_API_KEY" \
     -H "X-Purpose: Security Research"
```

```python
import requests

url = "https://www.osintcat.net/api/email-osint"
params = {
    "query": "test@example.com",
    "purpose": "Security Research"
}
headers = {
    "X-API-KEY": "YOUR_API_KEY"
}

response = requests.get(url, params=params, headers=headers)

if response.ok:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

```javascript
const url = 'https://www.osintcat.net/api/email-osint?query=test@example.com&purpose=Security%20Research';

fetch(url, {
    headers: {
        'X-API-KEY': 'YOUR_API_KEY'
    }
})
    .then(res => res.json())
    .then(json => console.log(json))
    .catch(err => console.error('error:' + err));
```

```php
<?php

$curl = curl_init();

$url = "https://www.osintcat.net/api/email-osint?query=test@example.com&purpose=Security%20Research";

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "X-API-KEY: YOUR_API_KEY"
    ],
]);

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

curl_close($curl);

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

```go
package main

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

func main() {
    baseURL := "https://www.osintcat.net/api/email-osint"
    params := url.Values{}
    params.Add("query", "test@example.com")
    params.Add("purpose", "Security Research")
    
    fullURL := baseURL + "?" + params.Encode()
    
    req, _ := http.NewRequest("GET", fullURL, nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Error: %v\n", err)
        return
    }
    defer resp.Body.Close()
    
    body, _ := io.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    fmt.Printf("%+v\n", result)
}
```

```ruby
require 'net/http'
require 'json'
require 'uri'

uri = URI('https://www.osintcat.net/api/email-osint')
uri.query = URI.encode_www_form({ 
    query: 'test@example.com', 
    purpose: 'Security Research' 
})

request = Net::HTTP::Get.new(uri)
request['X-API-KEY'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
end

if response.is_a?(Net::HTTPSuccess)
    data = JSON.parse(response.body)
    puts JSON.pretty_generate(data)
else
    puts "Error: #{response.code}"
end
```

```java
import java.net.HttpURLConnection;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class OsintCatAPI {
    public static void main(String[] args) {
        try {
            String apiUrl = "https://www.osintcat.net/api/email-osint?query=test@example.com&purpose=Security%20Research";
            URL url = new URL(apiUrl);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("GET");
            conn.setRequestProperty("X-API-KEY", "YOUR_API_KEY");
            
            int responseCode = conn.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
                String inputLine;
                StringBuilder response = new StringBuilder();
                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }
                in.close();
                System.out.println(response.toString());
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### GET /api/footprint/create-task

Source: https://docs.osintcat.net/api-reference/endpoint/email-footprint#param-domain

Initiates a new footprint task via a GET request.

```APIDOC
## GET /api/footprint/create-task

### Description
Initiates a new footprint task. This endpoint requires an API key for authentication.

### Method
GET

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

### Parameters
#### Headers
- **X-API-KEY** (string) - Required - Your API authentication key.

### Response
#### Success Response (200)
- **task_id** (string) - The unique identifier for the created task.
- **status** (string) - The current status of the task.
- **_meta** (object) - Metadata regarding the user's plan and remaining lookups.
- **stats** (object) - Statistics regarding the task execution.
- **results** (array) - A list of domain results found during the footprint process.

#### Response Example
{
  "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": {}
    }
  ]
}
```

--------------------------------

### Minecraft Lookup API Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/minecraft-osint

Examples demonstrating how to query the Minecraft OSINT lookup endpoint across various programming languages.

```bash
curl "https://www.osintcat.net/api/minecraft-lookup?query=Notch&type=username" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

url = "https://www.osintcat.net/api/minecraft-lookup"
params = {
    "query": "Notch",
    "type": "username"
}
headers = {
    "X-API-KEY": "YOUR_API_KEY"
}

response = requests.get(url, params=params, headers=headers)

if response.ok:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

```javascript
const url = 'https://www.osintcat.net/api/minecraft-lookup?query=Notch&type=username';

fetch(url, {
    headers: {
        'X-API-KEY': 'YOUR_API_KEY'
    }
})
    .then(res => res.json())
    .then(json => console.log(json))
    .catch(err => console.error('error:' + err));
```

```php
<?php

$curl = curl_init();

$url = "https://www.osintcat.net/api/minecraft-lookup?query=Notch&type=username";

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "X-API-KEY: YOUR_API_KEY"
    ],
]);

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

curl_close($curl);

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

```go
package main

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

func main() {
    baseURL := "https://www.osintcat.net/api/minecraft-lookup"
    params := url.Values{}
    params.Add("query", "Notch")
    params.Add("type", "username")
    
    fullURL := baseURL + "?" + params.Encode()
    
    req, _ := http.NewRequest("GET", fullURL, nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Error: %v\n", err)
        return
    }
    defer resp.Body.Close()
    
    body, _ := io.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    fmt.Printf("%+v\n", result)
}
```

```ruby
require 'net/http'
require 'json'
require 'uri'

uri = URI('https://www.osintcat.net/api/minecraft-lookup')
uri.query = URI.encode_www_form({ query: 'Notch', type: 'username' })

request = Net::HTTP::Get.new(uri)
request['X-API-KEY'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
end

if response.is_a?(Net::HTTPSuccess)
    data = JSON.parse(response.body)
    puts JSON.pretty_generate(data)
else
    puts "Error: #{response.code}"
end
```

```java
import java.net.HttpURLConnection;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class OsintCatAPI {
    public static void main(String[] args) {
        try {
            String apiUrl = "https://www.osintcat.net/api/minecraft-lookup?query=Notch&type=username";
            URL url = new URL(apiUrl);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("GET");
            conn.setRequestProperty("X-API-KEY", "YOUR_API_KEY");
            
            int responseCode = conn.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
                String inputLine;
                StringBuilder response = new StringBuilder();
                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }
                in.close();
                System.out.println(response.toString());
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Discord to Roblox API Request Examples

Source: https://docs.osintcat.net/api-reference/endpoint/discord-to-roblox

Implementation examples for querying the Discord to Roblox endpoint across various programming languages.

```bash
curl "https://www.osintcat.net/api/discord-to-roblox?query=123456789012345678" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

url = "https://www.osintcat.net/api/discord-to-roblox"
params = {"query": "123456789012345678"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers)

if response.ok:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

```javascript
const url = 'https://www.osintcat.net/api/discord-to-roblox?query=123456789012345678';

fetch(url, {
    headers: {
        'X-API-KEY': 'YOUR_API_KEY'
    }
})
    .then(res => res.json())
    .then(json => console.log(json))
    .catch(err => console.error('error:' + err));
```

```php
<?php

$curl = curl_init();

$url = "https://www.osintcat.net/api/discord-to-roblox?query=123456789012345678";

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "X-API-KEY: YOUR_API_KEY"
    ],
]);

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

curl_close($curl);

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

```go
package main

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

func main() {
    baseURL := "https://www.osintcat.net/api/discord-to-roblox"
    params := url.Values{}
    params.Add("query", "123456789012345678")
    
    fullURL := baseURL + "?" + params.Encode()
    
    req, _ := http.NewRequest("GET", fullURL, nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Error: %v\n", err)
        return
    }
    defer resp.Body.Close()
    
    body, _ := io.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    fmt.Printf("%+v\n", result)
}
```

```ruby
require 'net/http'
require 'json'
require 'uri'

uri = URI('https://www.osintcat.net/api/discord-to-roblox')
uri.query = URI.encode_www_form({ query: '123456789012345678' })

request = Net::HTTP::Get.new(uri)
request['X-API-KEY'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
end

if response.is_a?(Net::HTTPSuccess)
    data = JSON.parse(response.body)
    puts JSON.pretty_generate(data)
else
    puts "Error: #{response.code}"
end
```

```java
import java.net.HttpURLConnection;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class OsintCatAPI {
    public static void main(String[] args) {
        try {
            String apiUrl = "https://www.osintcat.net/api/discord-to-roblox?query=123456789012345678";
            URL url = new URL(apiUrl);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("GET");
            conn.setRequestProperty("X-API-KEY", "YOUR_API_KEY");
            
            int responseCode = conn.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
                String inputLine;
                StringBuilder response = new StringBuilder();
                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }
                in.close();
                System.out.println(response.toString());
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using (var client = new HttpClient())
        {
            try
            {
                string url = "https://www.osintcat.net/api/discord-to-roblox?query=123456789012345678";
                client.DefaultRequestHeaders.Add("X-API-KEY", "YOUR_API_KEY");
                
                var response = await client.GetAsync(url);
                
                if (response.IsSuccessStatusCode)
                {
                    string content = await response.Content.ReadAsStringAsync();
                    Console.WriteLine(content);
                }
                else
                {
                    Console.WriteLine($"Error: {response.StatusCode}");
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error: {ex.Message}");
            }
        }
    }
}
```

--------------------------------

### VIN Lookup API Requests

Source: https://docs.osintcat.net/api-reference/endpoint/vin#example-decode-vin

Examples of how to perform a GET request to the VIN lookup endpoint using various programming languages. Ensure the X-API-KEY header is replaced with your valid API key.

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

```python
import requests

url = "https://www.osintcat.net/api/vin"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

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

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.osintcat.net/api/vin",
  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;
}
```

```go
package main

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

func main() {

	url := "https://www.osintcat.net/api/vin"

	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))

}
```

```java
HttpResponse<String> response = Unirest.get("https://www.osintcat.net/api/vin")
  .header("X-API-KEY", "<x-api-key>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://www.osintcat.net/api/vin")

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
```
Tokens:
Raw