OsintCat JavaScript Client

Official JavaScript/TypeScript client library for the OsintCat API. Powerful OSINT (Open Source Intelligence) tools for investigations, data collection, and security research.

Features

• 🔍 Comprehensive OSINT Tools: Search across multiple platforms and databases
• 🛡️ Data Breach Search: Find compromised accounts and leaked credentials
• 🎮 Gaming Platforms: Discord, Reddit, Roblox, GitHub investigations
• 🌐 Network Intelligence: IP lookups, DNS resolution, domain analysis
• 📱 Contact Intelligence: Phone and email validation and enrichment
• 📊 NPD Records Search: National Public Data records investigation
• 🔐 TypeScript Support: Full type definitions included
• ⚡ Promise-based: Modern async/await support
• 🚀 Easy Integration: Simple and intuitive API

Installation

npm install osintcat

yarn add osintcat

pnpm add osintcat

Quick Start

const OsintCat = require ('osintcat');

// Initialize the client
const client = new OsintCat({
    apiKey: 'your-api-key-here'
});

// Search for data breaches
const breaches = await client.searchBreaches('email@example.com');
console.log(breaches.data);

// Discord investigation  
const discordData = await client.getDiscordInfo('Discord_ID');
console.log(discordData.data);

// Get IP information
const ipInfo = await client.getIPInfo('8.8.8.8');
console.log(ipInfo.data);

Authentication

Get your API key from the OsintCat Dashboard. The API supports different subscription tiers:

• Free: Dashboard access only, API access not included
• Premium: 50 API requests per day + unlimited dashboard access
• Enterprise: Unlimited API requests + priority support

API Methods

Data Breach Search

const result = await client.searchBreaches('email@example.com');

Search multiple breach databases for compromised accounts including:

• LeakCheck, SnusBase, HackCheck
• IntelVault, Inf0Sec, BreachBase

Social Platform Investigation

Discord

const discord = await client.getDiscordInfo('userId');

Reddit

const reddit = await client.searchReddit('username');

GitHub

const github = await client.searchGitHub('email@example.com');

Roblox

const roblox = await client.searchRoblox('username');

Network Intelligence

IP Information

const ip = await client.getIPInfo('192.168.1.1');

DNS Resolution

const dns = await client.resolveDNS('example.com');

Domain Analysis

const domain = await client.searchDomain('example.com');

Contact Intelligence

Phone Information

const phone = await client.getPhoneInfo('+1234567890');

Email Validation

const email = await client.getEmailInfo('test@example.com');

Advanced Features

NPD Records Search

const npd = await client.searchNPD({
    firstname: 'John',
    lastname: 'Doe', 
    phone: '+1234567890'
});

Search National Public Data records using various criteria.

Discord to Roblox Conversion

const conversion = await client.discordToRoblox('discord_user_id');

Configuration Options

const client = new OsintCat({
    apiKey: 'your-api-key',
    timeout: 90000 // Optional: request timeout in milliseconds (default: 90s)
});

Response Format

All methods return a standardized response:

{
    "success": true,
    "data": {},
    "error": null,
    "_meta": {
        "plan": "premium",
        "lookups_left": 45
    }
}

Error Handling

try {
    const result = await client.searchBreaches('email@example.com');

    if (result.success) {
        console.log('Data:', result.data);
        console.log('Remaining requests:', result._meta?.lookups_left);
    } else {
        console.error('Error:', result.error);
    }
} catch (error) {
    console.error('Request failed:', error.message);
}

TypeScript Support

The package includes full TypeScript definitions:

import OsintCat, { OSINTResponse, BreachResult } from 'osintcat';

const client = new OsintCat({ apiKey: 'your-key' });

const breaches: OSINTResponse<BreachResult> = await client.searchBreaches('email@example.com');

Rate Limiting

API requests are subject to rate limits based on your subscription:

• Premium: 50 requests/day
• Enterprise: Unlimited requests

Monitor your usage via the _meta.lookups_left field in responses.

Legal & Ethical Use

This tool is intended for:

• ✅ Security research and penetration testing
• ✅ Investigating your own accounts and data
• ✅ Academic research and education
• ✅ Cybersecurity and threat intelligence
• ✅ Authorized OSINT investigations

Please ensure responsible usage and comply with:

• Applicable laws and regulations
• Terms of service of investigated platforms
• Privacy rights and data protection laws
• Ethical guidelines for security research

Support

• 📖 API Documentation
• 💬 Telegram Community
• 🐛 Report Issues
• 📧 Contact Support
• 🌐 Website

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Changelog

See CHANGELOG.md for version history and updates.

License

MIT License - see LICENSE file for details.

---

Disclaimer: This tool is for authorized security testing and research only. Users are responsible for ensuring compliance with applicable laws and regulations. The developers are not responsible for any misuse of this tool.