Developer Documentation

Last updated: September 2025

Welcome to the comprehensive developer documentation for WhatsMyName.io. This guide covers everything from basic web usage to advanced API integration for OSINT investigations.

New to OSINT? Check out our OSINT Guide for investigation methodologies and best practices.

🚀 Quick Start Guide

Getting Started in 3 Steps

1

Enter Username

Type the target username in the search bar on our homepage

2

Review Results

Analyze findings across 1000+ platforms with real-time verification

3

Export Data

Download results in CSV or JSON format for further analysis

🖥️ Web Interface Usage

Advanced Filtering & Analysis

Category Filters

  • • Social Media (Facebook, Twitter, Instagram)
  • • Professional (LinkedIn, GitHub, Behance)
  • • Gaming (Steam, Xbox, PlayStation)
  • • Forums & Communities

Export Options

  • CSV: Spreadsheet-compatible format
  • JSON: Developer-friendly structured data
  • PDF Report: Professional investigation reports

🔌 API Documentation

Integrate WhatsMyName.io's powerful search capabilities directly into your applications, scripts, and automated workflows.

Base URL: https://api.whatsmyname.io

API Version: v1

Authentication

All API requests require authentication using your personal API key. Get your free API key by creating an account.

Request Headers

X-API-KEY: your_api_key_here
Content-Type: application/json

Primary Endpoints

Search Username

Perform comprehensive username search across all platforms

GET /api/v1/search/{username}

Batch Search

Search multiple usernames in a single request

POST /api/v1/search/batch

Platform List

Get list of all supported platforms and their status

GET /api/v1/platforms

Example Request & Response

cURL Request

curl --request GET \
  --url 'https://api.whatsmyname.io/api/v1/search/johndoe?sites=github,twitter' \
  --header 'X-API-KEY: your_api_key_here' \
  --header 'Content-Type: application/json'

JSON Response

{
  "success": true,
  "username": "johndoe",
  "search_time": "2.34s",
  "total_platforms": 2,
  "found_count": 1,
  "results": [
    {
      "platform": "github",
      "found": true,
      "url": "https://github.com/johndoe",
      "status_code": 200,
      "response_time": "0.89s"
    },
    {
      "platform": "twitter",
      "found": false,
      "url": "https://twitter.com/johndoe",
      "status_code": 404,
      "response_time": "1.12s"
    }
  ]
}

Rate Limits & Usage

Free Tier

  • • 100 searches per day
  • • 10 requests per minute
  • • All platforms included
  • • Standard support

Pro Tier

  • • 10,000 searches per day
  • • 100 requests per minute
  • • Priority processing
  • • Premium support

Error Handling

200Success - Request completed successfully
401Unauthorized - Invalid or missing API key
429Rate Limited - Too many requests, slow down
500Server Error - Something went wrong on our end

💡 Best Practices

Performance Tips

  • • Use specific platform filters to reduce search time
  • • Implement proper retry logic for failed requests
  • • Cache results locally to avoid duplicate searches
  • • Use batch endpoints for multiple usernames

Security & Ethics

  • • Always comply with local privacy laws
  • • Respect platform terms of service
  • • Use data responsibly for legitimate purposes
  • • Implement proper data retention policies

Ready to Start Your Investigation?

Try our free web tool or get your API key to integrate with your applications.