> ## Documentation Index
> Fetch the complete documentation index at: https://docs.osintcat.net/llms.txt
> Use this file to discover all available pages before exploring further.

# API Introduction

> OsintCat API documentation - Comprehensive OSINT and data lookup services

## Welcome to OsintCat API

OsintCat provides a powerful REST API for OSINT (Open Source Intelligence) lookups, breach data searches, and public record queries. Our API enables developers to integrate comprehensive data lookup capabilities into their applications.

## Base URL

All API requests should be made to:

```
https://www.osintcat.net/api
```

## Authentication

All API endpoints require authentication using an API key. Include your API key in the header as "X-API-KEY"

<Warning>
  Keep your API key secure and never expose it in client-side code or public repositories.
</Warning>

### Example Request

```bash theme={null}
curl "https://www.osintcat.net/api/user" -H "X-API-KEY: YOUR_API_KEY"
```

## Rate Limits

Our API has a soft rate limit of **3 requests per second**. If you exceed this limit, you will receive a 30-minute timeout.

<Warning>
  **Rate Limit Warning**: Exceeding 3 requests per second will result in a 30-minute timeout. Please implement proper rate limiting in your application.
</Warning>

## Response Format

All API responses are returned in JSON format with proper HTTP status codes:

* `200` - Success
* `400` - Bad Request (missing or invalid parameters)
* `401` - Unauthorized (missing API key)
* `403` - Forbidden (invalid API key)
* `429` - Too Many Requests (rate limit exceeded)
* `500` - Internal Server Error

## API Plans

Different API plans have different request limits:

### Free Plan

* **API Requests**: 0 requests/day
* **Dashboard Requests**: 10 requests/day

### Premium Plan

* **API Requests**: 50 requests/day
* **Dashboard Requests**: Unlimited

### Enterprise Plan

* **API Requests**: Unlimited
* **Dashboard Requests**: Unlimited

<Note>
  Daily limits reset at midnight UTC. You can check your current usage and limits using the `/api/user` endpoint.
</Note>

## Available Endpoints

Our API provides the following endpoints:

### Account Management

* **[User Info](/api-reference/endpoint/user)** - Get account information, usage statistics, and email OSINT credit information

### OSINT Lookups

* **[Breach Lookup](/api-reference/endpoint/breach)** - Search for records in data breaches
* **[Discord Lookup](/api-reference/endpoint/discord)** - Find Discord user information
* **[Roblox to Discord](/api-reference/endpoint/roblox)** - Find Discord accounts linked to a Roblox username (wildcard supported)
* **[Discord to Roblox](/api-reference/endpoint/discord-to-roblox)** - Find linked Roblox accounts
* **[Email OSINT](/api-reference/endpoint/email-osint)** - Discover websites an email is registered on
* **[Phone OSINT](/api-reference/endpoint/phone-osint)** - Gather intelligence on phone numbers
* **[GitHub OSINT](/api-reference/endpoint/github-osint)** - Find GitHub accounts by email
* **[GitHub User Info](/api-reference/endpoint/github-userinfo)** - Get GitHub user information and email from commits
* **[Username Lookup](/api-reference/endpoint/username)** - Find stealer logs and site information
* **[Minecraft Lookup](/api-reference/endpoint/minecraft)** - Minecraft breach data lookup
* **[Minecraft OSINT](/api-reference/endpoint/minecraft-osint)** - Minecraft OSINT lookup with caching

### Network & Domain

* **[IP Info](/api-reference/endpoint/ip)** - Get IP information and stealer logs
* **[DNS Resolver](/api-reference/endpoint/dns-resolver)** - Resolve domain names to IP addresses
* **[Domain Lookup](/api-reference/endpoint/domain)** - Domain stealer lookup

### Public Records

* **[Chilean Name](/api-reference/endpoint/chilean-name)** - Find information about Chilean persons

## Getting Started

1. **[Sign up](https://www.osintcat.net/register)** for an account
2. **[Get your API key](https://www.osintcat.net/dashboard)** from the dashboard
3. Start making requests to our endpoints
4. Check your usage with the `/api/user` endpoint

## Code Examples

We provide code examples in multiple languages for each endpoint. You can find examples in:

* cURL
* Python
* Node.js
* PHP

## Support

If you need help or have questions:

* Check the endpoint-specific documentation
* Review the [Quickstart Guide](/quickstart)
* Contact support through your dashboard