### Common Use Cases

Source: https://docs.osintcat.net/quickstart

Examples of how the OSINTCAT API can be utilized for various research and verification purposes.

```APIDOC
## Common Use Cases

### Security Research

Use breach lookups and email OSINT to investigate security incidents and data leaks.

### Account Verification

Verify user information across multiple platforms using username and email lookups.

### Network Analysis

Analyze IP addresses and domains to understand network infrastructure and potential threats.

### Social Media Intelligence

Gather information from Discord, Reddit, and other platforms for legitimate research purposes.

### Legal and Ethical Considerations

Always ensure you have proper authorization and comply with applicable laws when using OSINT tools.
```

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

### Example API Request using cURL

Source: https://docs.osintcat.net/api-reference/introduction

Demonstrates how to make an authenticated API request using cURL. It includes the base URL, the user endpoint, and the required 'X-API-KEY' header for authentication.

```bash
curl "https://www.osintcat.net/api/user" -H "X-API-KEY: YOUR_API_KEY"
```

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

### GET /api/vin?type=variables&search_type=list

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

Retrieves a list of all available variable types that can be queried.

```APIDOC
## GET /api/vin

### Description
Retrieves a list of all available variable types that can be queried.

### Method
GET

### Endpoint
/api/vin

### Query Parameters
- **type** (string) - Required - Specifies the data type to retrieve. Use 'variables'.
- **search_type** (string) - Required - Specifies the search type. Use 'list' to get a list of variables.

### Request Example
```bash
curl "https://www.osintcat.net/api/vin?type=variables&search_type=list" \
     -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **variables** (array) - A list of available variable names.

#### Response Example
```json
{
  "variables": [
    "Vehicle Type",
    "Engine",
    "Transmission",
    "Body Style"
  ]
}
```
```

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

### Fetch OSINTCAT User Info (Java)

Source: https://docs.osintcat.net/quickstart

This Java code snippet demonstrates how to make a GET request to the OSINTCAT API to retrieve user account information and daily API request limits. It handles potential exceptions and prints the response status code or remaining requests.

```java
System.out.println("API Requests Remaining: " + apiUsage.get("requests_remaining_today"));
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

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

### GET /user/info

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

Retrieves detailed information about the authenticated user's account, including their plan, daily usage limits, remaining requests, and email OSINT credit balance.

```APIDOC
## GET /user/info

### Description
Retrieves detailed information about the authenticated user's account, including their plan, daily usage limits, remaining requests, and email OSINT credit balance.

### Method
GET

### Endpoint
/user/info

### Parameters
#### Header Parameters
- **X-API-KEY** (string) - Required - Your API key

### Response
#### Success Response (200)
- **account_info** (object) - Account information object
  - **username** (string) - Your username
  - **email** (string) - Your email address
  - **plan** (string) - Your current plan (Free, Starter, Researcher, Investigator, or Enterprise)
- **usage** (object) - Usage statistics object
  - **request_limit_daily** (number) - Daily request limit
  - **requests_remaining_today** (number) - Remaining requests today
  - **api_access** (boolean) - Whether API access is enabled
  - **intelx_access** (boolean) - Whether IntelX access is enabled
  - **max_ips** (number) - Maximum number of IP addresses allowed
- **email_osint_credits** (object) - Email OSINT credit information
  - **current_balance** (number) - Current credit balance in EUR (2 decimal places)
  - **price_per_search** (number) - Cost per search based on your plan in EUR (2 decimal places)
  - **has_sufficient_credits** (boolean) - Whether you have enough credits for at least one search
  - **searches_available** (number) - Estimated number of searches available with current balance (integer)

#### Response Example
```json
{
  "account_info": {
    "username": "example_user",
    "email": "user@example.com",
    "plan": "Researcher"
  },
  "usage": {
    "request_limit_daily": 1000,
    "requests_remaining_today": 750,
    "api_access": true,
    "intelx_access": true,
    "max_ips": 50
  },
  "email_osint_credits": {
    "current_balance": 15.75,
    "price_per_search": 0.10,
    "has_sufficient_credits": true,
    "searches_available": 157
  }
}
```
```

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

### GET /api/github-userinfo

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

Retrieves information about a GitHub user. Requires an API key for authentication.

```APIDOC
## GET /api/github-userinfo

### Description
Retrieves information about a GitHub user by their username. This endpoint requires an API key for authentication.

### Method
GET

### Endpoint
/api/github-userinfo

### Parameters
#### Query Parameters
- **query** (string) - Required - The GitHub username to search for.

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

### Request Example
```bash
curl "https://www.osintcat.net/api/github-userinfo?query=octocat" \
     -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **data** (object) - Contains the GitHub user information.
  - **login** (string) - The GitHub username.
  - **id** (integer) - The GitHub user ID.
  - **name** (string) - The user's full name.
  - **public_repos** (integer) - The number of public repositories.
  - **followers** (integer) - The number of followers.
  - **following** (integer) - The number of users the user is following.
  - **created_at** (string) - The date and time the account was created.
  - **bio** (string) - The user's biography.
  - **location** (string) - The user's location.
  - **email** (string) - The user's email address (if public).

#### Response Example
```json
{
  "data": {
    "login": "octocat",
    "id": 583231,
    "name": "The Octocat",
    "public_repos": 8,
    "followers": 1000,
    "following": 5,
    "created_at": "2011-01-25T18:44:36Z",
    "bio": "The Octocat lives in the cloud.",
    "location": "San Francisco",
    "email": "octocat@github.com"
  }
}
```

#### Error Response (401)
- **message** (string) - Error message indicating unauthorized access.

#### Error Response Example
```json
{
  "message": "Invalid API Key"
}
```
```

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

### GET /api/vin?type=variables&search_type=values&query=Vehicle%20Type

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

Retrieves a list of possible values for a specified variable type.

```APIDOC
## GET /api/vin

### Description
Retrieves a list of possible values for a specified variable type.

### Method
GET

### Endpoint
/api/vin

### Query Parameters
- **type** (string) - Required - Specifies the data type to retrieve. Use 'variables'.
- **search_type** (string) - Required - Specifies the search type. Use 'values' to get values for a variable.
- **query** (string) - Required - The name of the variable to get values for (e.g., 'Vehicle Type').

### Request Example
```bash
curl "https://www.osintcat.net/api/vin?type=variables&search_type=values&query=Vehicle%20Type" \
     -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **values** (array) - A list of possible values for the specified variable.

#### Response Example
```json
{
  "values": [
    "Sedan",
    "SUV",
    "Coupe",
    "Truck"
  ]
}
```
```

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

### Get All Makes using cURL

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

Retrieves a list of all vehicle makes using the OSINTCAT API. The `search_type` parameter is set to `all`. An empty or dummy query may be used.

```bash
curl "https://www.osintcat.net/api/vin?type=makes&search_type=all&query=" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```bash
curl "https://www.osintcat.net/api/vin?type=makes&search_type=all" \
     -H "X-API-KEY: YOUR_API_KEY"
```

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

### Roblox Lookup API

Source: https://docs.osintcat.net/api-reference/introduction

Get Roblox user details.

```APIDOC
## GET /api/roblox

### Description
Retrieves details about a Roblox user based on their username or user ID.

### Method
GET

### Endpoint
/api/roblox

### Parameters
#### Query Parameters
- **username** (string) - Optional - The Roblox username.
- **user_id** (string) - Optional - The Roblox user ID.

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

### Request Example
```bash
curl "https://www.osintcat.net/api/roblox?username=ExampleRobloxUser" \
  -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **user_id** (string) - The Roblox user ID.
- **username** (string) - The Roblox username.
- **display_name** (string) - The user's display name.
- **description** (string) - The user's profile description.
- **created_at** (string) - The timestamp when the account was created.
- **profile_url** (string) - The URL to the user's Roblox profile.

#### Response Example
```json
{
  "user_id": "9876543210",
  "username": "ExampleRobloxUser",
  "display_name": "Example Display",
  "description": "Welcome to my profile!",
  "created_at": "2010-05-15T10:30:00.000000+00:00",
  "profile_url": "https://www.roblox.com/users/9876543210/profile"
}
```
```

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

### IP Info API

Source: https://docs.osintcat.net/api-reference/introduction

Get IP information and stealer logs.

```APIDOC
## GET /api/ip

### Description
Retrieves information about an IP address, including geolocation, ISP details, and any associated stealer logs.

### Method
GET

### Endpoint
/api/ip

### Parameters
#### Query Parameters
- **ip_address** (string) - Required - The IP address to investigate.

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

### Request Example
```bash
curl "https://www.osintcat.net/api/ip?ip_address=8.8.8.8" \
  -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **ip_address** (string) - The investigated IP address.
- **country** (string) - The country of the IP address.
- **region** (string) - The region/state of the IP address.
- **city** (string) - The city of the IP address.
- **isp** (string) - The Internet Service Provider.
- **organization** (string) - The organization associated with the IP block.
- **stealer_logs_found** (boolean) - Indicates if stealer logs were found for this IP.

#### Response Example
```json
{
  "ip_address": "8.8.8.8",
  "country": "United States",
  "region": "California",
  "city": "Mountain View",
  "isp": "Google LLC",
  "organization": "Google LLC",
  "stealer_logs_found": false
}
```
```

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

### Get Canadian Vehicle Specifications (Bash)

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

Retrieves detailed vehicle specifications for Canadian models using the OSINTCAT API. Requires a valid API key and parameters for year, make, model, and units.

```bash
curl "https://www.osintcat.net/api/vin?type=canadian&year=2022&make=Honda&model=Civic&units=Metric" \
     -H "X-API-KEY: YOUR_API_KEY"
```

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

### Fetch GitHub User Info via OSINTCAT API

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

This snippet shows how to make an API request to OSINTCAT to get GitHub user information. It requires an API key and a GitHub username as a query parameter. The API returns user details in JSON format.

```bash
curl "https://www.osintcat.net/api/github-userinfo?query=octocat" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

url = "https://www.osintcat.net/api/github-userinfo"
params = {"query": "octocat"}
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/github-userinfo?query=octocat';

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/github-userinfo?query=octocat";

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/github-userinfo"
    params := url.Values{}
    params.Add("query", "octocat")
    
    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/github-userinfo')
uri.query = URI.encode_www_form({ query: 'octocat' })

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/github-userinfo?query=octocat";
            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/github-userinfo?query=octocat";
                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($"An error occurred: {ex.Message}");
            }
        }
    }
}
```

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

### GET /api/vin?type=makes&search_type=models&query=Tesla&year=2023

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

Retrieves a list of vehicle models for a specified make and year.

```APIDOC
## GET /api/vin

### Description
Retrieves a list of vehicle models for a specified make and year.

### Method
GET

### Endpoint
/api/vin

### Query Parameters
- **type** (string) - Required - Specifies the data type to retrieve. Use 'makes' for models.
- **search_type** (string) - Required - Specifies the search type. Use 'models' to get models by make.
- **query** (string) - Required - The make of the vehicle (e.g., 'Tesla').
- **year** (integer) - Required - The manufacturing year of the vehicle (e.g., 2023).

### Request Example
```bash
curl "https://www.osintcat.net/api/vin?type=makes&search_type=models&query=Tesla&year=2023" \
     -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **models** (array) - A list of available models for the specified make and year.

#### Response Example
```json
{
  "models": [
    "Model S",
    "Model 3",
    "Model X",
    "Model Y"
  ]
}
```
```

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

### GitHub User Info API

Source: https://docs.osintcat.net/api-reference/introduction

Get GitHub user information and email from commits.

```APIDOC
## GET /api/github-userinfo

### Description
Retrieves detailed information about a GitHub user, including their public email address and commit history.

### Method
GET

### Endpoint
/api/github-userinfo

### Parameters
#### Query Parameters
- **username** (string) - Required - The GitHub username.

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

### Request Example
```bash
curl "https://www.osintcat.net/api/github-userinfo?username=octocat" \
  -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **username** (string) - The GitHub username.
- **name** (string) - The user's full name (if provided).
- **email** (string) - The user's public email address (if available).
- **public_repos** (integer) - The number of public repositories.
- **followers** (integer) - The number of followers.
- **following** (integer) - The number of users the user is following.
- **created_at** (string) - The timestamp when the account was created.
- **profile_url** (string) - The URL to the user's GitHub profile.

#### Response Example
```json
{
  "username": "octocat",
  "name": "The Octocat",
  "email": "octocat@github.com",
  "public_repos": 8,
  "followers": 1000,
  "following": 5,
  "created_at": "2011-01-25T18:44:36Z",
  "profile_url": "https://github.com/octocat"
}
```
```

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

### GET /api/discord

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

This endpoint retrieves Discord information based on a provided query. It requires an API key for authentication.

```APIDOC
## GET /api/discord

### Description
This endpoint retrieves Discord information based on a provided query. It requires an API key for authentication.

### Method
GET

### Endpoint
/api/discord

### Query Parameters
- **query** (string) - Required - The Discord identifier to query.
- **X-API-KEY** (string) - Required - Your API key for authentication.

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

### Response
#### Success Response (200)
- **data** (object) - Contains the retrieved Discord information.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Query OSINT Cat API DNS Resolver (cURL, Python, Node.js, PHP, Go, Ruby, Java, C#)

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

This code snippet demonstrates how to query the OSINT Cat API's DNS resolver endpoint using various programming languages and tools. It sends a GET request to the API, including a query parameter and an API key in the header. The response, which is expected to be in JSON format, is then processed and printed to the console.

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

```python
import requests

url = "https://www.osintcat.net/api/dns-resolver"
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/dns-resolver?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/dns-resolver?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/dns-resolver"
    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/dns-resolver')
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/dns-resolver?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/dns-resolver?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}");
                }
            }

```

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

### Example OSINT CAT API JSON Response

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

This JSON object represents a typical response from the OSINT CAT API. It includes details about the user's account, daily API usage limits, and the current balance of email OSINT search credits. The structure provides a clear overview of available resources and user status.

```json
{
  "account_info": {
    "username": "user123",
    "email": "user@example.com",
    "plan": "Starter"
  },
  "usage": {
    "request_limit_daily": 100,
    "requests_remaining_today": 85,
    "api_access": true,
    "intelx_access": false,
    "max_ips": 3
  },
  "email_osint_credits": {
    "current_balance": 10.50,
    "price_per_search": 0.40,
    "has_sufficient_credits": true,
    "searches_available": 26
  }
}
```

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

### User Info API

Source: https://docs.osintcat.net/api-reference/introduction

Get account information, usage statistics, and email OSINT credit information.

```APIDOC
## GET /api/user

### Description
Retrieves account information, including usage statistics and email OSINT credit details.

### Method
GET

### Endpoint
/api/user

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

### Request Example
```bash
curl "https://www.osintcat.net/api/user" \
  -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **username** (string) - The username of the account.
- **api_requests_remaining** (integer) - The number of API requests remaining for the current period.
- **dashboard_requests_remaining** (integer) - The number of dashboard requests remaining for the current period.
- **email_osint_credits** (integer) - The number of available email OSINT credits.

#### Response Example
```json
{
  "username": "example_user",
  "api_requests_remaining": 45,
  "dashboard_requests_remaining": 10,
  "email_osint_credits": 50
}
```
```

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

### Get IP Information

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

Fetches comprehensive data for a given IP address, including its geographical location, the Internet Service Provider (ISP) it belongs to, and any associated stealer log information.

```APIDOC
## GET /ip

### Description
Retrieves detailed information for a given IP address, including geolocation, ISP, and stealer log data.

### Method
GET

### Endpoint
/ip

### Parameters
#### Query Parameters
- **query** (string) - Required - An IP address to look up.

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

### Response
#### Success Response (200)
- **ip_address** (string) - The IP address queried.
- **geolocation** (object) - Information about the IP address's location.
  - **country** (string) - The country the IP address is located in.
  - **city** (string) - The city the IP address is located in.
- **isp** (string) - The Internet Service Provider associated with the IP address.
- **stealer_logs** (array) - A list of any stealer logs associated with the IP address.
  - **log_id** (string) - The unique identifier for the stealer log.
  - **timestamp** (string) - The time the log was recorded.

#### Response Example
```json
{
  "ip_address": "8.8.8.8",
  "geolocation": {
    "country": "United States",
    "city": "Mountain View"
  },
  "isp": "Google LLC",
  "stealer_logs": [
    {
      "log_id": "log123",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

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

### GET /api/discord-stalker

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

Retrieve information about a Discord user by providing their User ID.

```APIDOC
## GET /api/discord-stalker

### Description
This endpoint allows you to retrieve information about a Discord user by providing their unique User ID.

### Method
GET

### Endpoint
`/api/discord-stalker`

### Query Parameters
- **query** (string) - Required - The Discord User ID to look up.

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

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

### Response
#### Success Response (200)
- **user_info** (object) - Contains detailed information about the Discord user.
  - **id** (string) - The Discord User ID.
  - **username** (string) - The Discord username.
  - **discriminator** (string) - The Discord discriminator.
  - **avatar** (string) - The Discord avatar hash.
  - **public_flags** (integer) - Public flags associated with the user.
  - **flags** (integer) - Flags associated with the user.
  - **banner** (string) - The Discord banner hash.
  - **banner_color** (string) - The color of the Discord banner.
  - **accent_color** (string) - The accent color of the Discord profile.
  - **bio** (string) - The user's biography.
  - **created_at** (string) - The timestamp when the user account was created.
  - **mutual_guilds** (array) - A list of guilds the user shares with the requester.
  - **premium_type** (integer) - The type of Nitro subscription the user has.
  - **badges** (array) - A list of badges the user possesses.

#### Response Example
```json
{
  "user_info": {
    "id": "123456789012345678",
    "username": "ExampleUser",
    "discriminator": "1234",
    "avatar": "a_hash_string",
    "public_flags": 1,
    "flags": 0,
    "banner": null,
    "banner_color": null,
    "accent_color": null,
    "bio": "This is an example bio.",
    "created_at": "2020-01-01T12:00:00.000Z",
    "mutual_guilds": [],
    "premium_type": 2,
    "badges": ["STAFF", "PARTNER"]
  }
}
```

#### Error Response (400)
- **error** (string) - A message indicating the error, e.g., "Invalid User ID."

#### Error Response (401)
- **error** (string) - A message indicating the error, e.g., "Invalid API Key."
```

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

### Request User Info from OSINTCAT API (Multiple Languages)

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

Demonstrates how to fetch user information from the OSINTCAT API using an API key. This functionality is shown across multiple programming languages, including cURL, Python, Node.js, PHP, Go, Ruby, Java, and C#. Ensure you replace 'YOUR_API_KEY' with your actual API key.

```bash
curl "https://www.osintcat.net/api/user" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python
import requests

url = "https://www.osintcat.net/api/user"
headers = {"X-API-KEY": "YOUR_API_KEY"}

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

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

```javascript
const url = 'https://www.osintcat.net/api/user';

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/user";

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

func main() {
    fullURL := "https://www.osintcat.net/api/user"
    
    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/user')

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/user";
            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/user";
                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}");
            }
        }
    }
}
```

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

### List Available Variables (Bash)

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

Retrieves a list of all available variables that can be queried from the OSINTCAT API. This is useful for understanding the data points you can request. Requires a valid API key.

```bash
curl "https://www.osintcat.net/api/vin?type=variables&search_type=list" \
     -H "X-API-KEY: YOUR_API_KEY"
```

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

### Retrieve Vehicle Models by Make (Bash)

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

Fetches a list of vehicle models for a specific make and year using the OSINTCAT API. Requires a valid API key. The 'query' parameter specifies the make, and 'year' specifies the model year.

```bash
curl "https://www.osintcat.net/api/vin?type=makes&search_type=models&query=Tesla&year=2023" \
     -H "X-API-KEY: YOUR_API_KEY"
```

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

### Canadian Specifications API

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

Get Canadian Vehicle Specifications (1971+). Requires `year` and `make`.

```APIDOC
## GET /api/vin

### Description
Get Canadian Vehicle Specifications (1971+). Requires `year` and `make`.

### Method
GET

### Endpoint
/api/vin

### Parameters
#### Query Parameters
- **type** (string) - Required - Must be `canadian`.
- **year** (int) - Required - Model year (1971+).
- **make** (string) - Required - Make (e.g. `Honda`, `Toyota`).
- **model** (string) - Optional - Model name.
- **units** (string) - Optional - `Metric` or `Imperial`. Default: `Metric`.

### Request Example
```bash
curl "https://www.osintcat.net/api/vin?type=canadian&year=2022&make=Toyota&model=Camry&units=Imperial" \
     -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **Object** - Contains Canadian vehicle specifications.

#### Response Example
```json
{
  "year": 2022,
  "make": "Toyota",
  "model": "Camry",
  "specifications": {
    "engine": "2.5L 4-Cylinder",
    "transmission": "8-Speed Automatic"
  }
}
```
```

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

### Fetch OSINTCAT User Info (C#)

Source: https://docs.osintcat.net/quickstart

This C# code snippet shows how to asynchronously fetch user account details and API usage statistics from the OSINTCAT API using HttpClient. It parses the JSON response to display the user's plan and remaining daily API requests. Remember to include your API key.

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

class Program
{
    static async Task Main(string[] args)
    {
        using (var client = new HttpClient())
        {
            try
            {
                string url = "https://www.osintcat.net/api/user";
                client.DefaultRequestHeaders.Add("X-API-KEY", "YOUR_API_KEY");

                var response = await client.GetAsync(url);

                if (response.IsSuccessStatusCode)
                {
                    string content = await response.Content.ReadAsStringAsync();
                    var json = JsonDocument.Parse(content);
                    var root = json.RootElement;

                    Console.WriteLine($"Plan: {root.GetProperty("account_info").GetProperty("plan").GetString()}");
                    Console.WriteLine($"API Requests Remaining: {root.GetProperty("usage").GetProperty("api").GetProperty("requests_remaining_today")}");
                }
                else
                {
                    Console.WriteLine($"Error: {response.StatusCode}");
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error: {ex.Message}");
            }
        }
    }
}
```

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

### GET /api/roblox

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

Retrieves information about a Roblox user based on their username. Requires an API key for authentication.

```APIDOC
## GET /api/roblox

### Description
This endpoint allows you to query information about a Roblox user by providing their username. An API key is required for authentication.

### Method
GET

### Endpoint
/api/roblox

### Query Parameters
- **query** (string) - Required - The Roblox username to search for.

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

### Request Example
```bash
curl "https://www.osintcat.net/api/roblox?query=RobloxUsername" \
     -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **[dynamic fields]** (object) - Contains the retrieved Roblox user information. The exact fields may vary.

#### Response Example
```json
{
  "username": "RobloxUsername",
  "userId": 123456789,
  "displayName": "Roblox User",
  "profileUrl": "https://www.roblox.com/users/123456789/profile",
  "avatarUrl": "https://www.roblox.com/headshot-thumbnail/image?userId=123456789&width=90&height=90&format=png"
}
```
```

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

### Documentation Index

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

Fetch the complete documentation index to discover all available pages.

```APIDOC
## GET /llms.txt

### Description
Fetch the complete documentation index. Use this file to discover all available pages before exploring further.

### Method
GET

### Endpoint
/llms.txt

### Response
#### Success Response (200)
- **documentation_index** (string) - A text file containing links to all documentation pages.

#### Response Example
```
https://docs.osintcat.net/page1.md
https://docs.osintcat.net/page2.md
```
```

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

### GET /api/breach

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

Retrieves breach data for a specified email address. Requires an API key for authentication.

```APIDOC
## GET /api/breach

### Description
This endpoint allows you to query for breach data associated with a specific email address. It is essential to include your API key in the request headers for authentication.

### Method
GET

### Endpoint
/api/breach

### Query Parameters
- **query** (string) - Required - The email address to query for breach data.

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

### Request Example
```bash
curl "https://www.osintcat.net/api/breach?query=user@example.com" \
     -H "X-API-KEY: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **data** (object) - Contains breach information if found.
- **message** (string) - A message indicating the status of the request.

#### Response Example
```json
{
  "data": {
    "email": "user@example.com",
    "breaches": [
      {
        "name": "example_breach",
        "domain": "example.com",
        "date": "2023-01-01"
      }
    ]
  },
  "message": "Breach data retrieved successfully."
}
```
```