DocumentationWayhack API

Getting Started

Welcome to WayHack! This guide will walk you through everything you need to know to get started with the platform, from creating your account to generating your first API key and running your first URL reconnaissance.

Prerequisites

Before you begin, make sure you have:

  • A modern web browser (Chrome, Firefox, Safari, or Edge)

  • Basic understanding of domains and URLs

  • Command-line access (for CLI usage)

Step 1: Creating Your Account

1.1 Sign Up Process

  1. Visit the WayHack platform at https://wayhack.sh

  2. Click the "Sign Up" button in the top-right corner

  3. Choose your preferred registration method:

    • Email & Password: Enter your email and create a secure password

    • Google OAuth: Sign up using your Google account

    • GitHub OAuth: Sign up using your GitHub account

1.2 Account Verification

  1. Check your email for a verification link

  2. Click the verification link to activate your account

  3. Complete your profile setup with basic information

1.3 First Login

  1. Return to https://wayhack.sh

  2. Click "Sign In" and enter your credentials

  3. You'll be redirected to your dashboard

Step 2: Understanding the Dashboard

2.1 Dashboard Overview

When you first log in, you'll see the main dashboard with several sections:

  • Navigation Sidebar: Access different platform features

  • Quick Actions: Common tasks like starting new searches

  • Recent Activity: Your latest searches and results

  • Data Source Status: Which OSINT data sources are available

2.2 Main Navigation

The sidebar contains these key sections:

  • 🏠 Dashboard: Overview of your account and recent activity

  • 🔍 URL Search: Discover URLs using various OSINT sources

  • 📊 Results: Browse and analyze your search results

  • 🔧 Sources: Configure data sources and settings

  • ⚙️ Settings: Account settings and API key management

Step 3: Generate Your First API Key

API keys are essential for using WayHack's CLI tools and API endpoints. Here's how to create one:

3.1 Navigate to API Settings

  1. Click "Settings" in the sidebar

  2. Select "API Keys" from the settings menu

  3. You'll see your current API keys (if any) and usage statistics

3.2 Create a New API Key

  1. Click "Generate New API Key"

  2. Provide a descriptive name (e.g., "My Local Reconnaissance")

  3. Set permissions:

    • Read: View search results and account information

    • Write: Create and manage URL searches

    • Admin: Full account access (use carefully)

  4. Set expiration (optional but recommended)

  5. Click "Generate Key"

3.3 Save Your API Key

⚠️ Important: Copy and save your API key immediately. For security reasons, you won't be able to view it again.

# Example API key (yours will be different)
wh_1234567890abcdef1234567890abcdef

3.4 Test Your API Key

Verify your API key works by making a simple request:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://wayhack.sh/api/user/settings

Step 4: Installing the CLI Tool

The WayHack CLI provides powerful command-line access to all platform features for URL reconnaissance.

4.1 Download and Install 

# Linux/macOS
curl -L https://wayhack.sh/api/cli/download -o wayhack-cli
chmod +x wayhack-cli
sudo mv wayhack-cli /usr/local/bin/

# Windows (PowerShell)
Invoke-WebRequest -Uri "https://wayhack.sh/api/cli/download" -OutFile "wayhack-cli.exe"

4.2 Verify Installation 

wayhack-cli --version
# Should output: wayhack-cli version 1.x.x

4.3 Configure Authentication 

# Set your API key
wayhack-cli auth login --api-key YOUR_API_KEY

# Verify authentication
wayhack-cli auth status

Step 5: Your First URL Search

Let's run your first URL reconnaissance search using the web interface:

5.1 Navigate to URL Search

  1. Click "URL Search" in the sidebar

  2. You'll see the search interface with various OSINT data sources

5.2 Start Your First Search

  1. Enter a target domain: example.com

  2. Select data sources (we recommend starting with "All Sources")

  3. Choose search type: "Domain URLs"

  4. Optionally enable "Include Subdomains"

  5. Click "Start Search" to begin reconnaissance

5.3 Monitor Progress

  1. Watch the real-time progress as each data source is queried

  2. View discovered URLs as they appear in the results

  3. Check which sources are returning the most valuable data

Step 6: Using the CLI Tool

For advanced users, the CLI provides more flexibility:

6.1 Basic CLI Usage 

# Check available data sources
wayhack-cli sources list

# Search for URLs from a domain
wayhack-cli search --domain example.com

# Search specific data sources
wayhack-cli search --domain example.com --sources wayback,urlscan

# Include subdomains in search
wayhack-cli search --domain example.com --include-subdomains

6.2 Advanced CLI Features 

# Custom output formats
wayhack-cli search --domain example.com \
               --sources all \
               --output results.json \
               --format json

# Filter results
wayhack-cli search --domain example.com \
               --sources wayback \
               --filter "*.php" \
               --exclude "*.css,*.js"

Step 7: Configuring Tools

7.1 Tool Settings

  1. Go to "Settings" → "Tools"

  2. Configure default settings for each tool:

    • Wordlist directories

    • Output directories

    • Default thread counts

    • Timeout values

    • Custom flags

7.2 Custom Wordlists

  1. Upload your custom wordlists

  2. Set default wordlists for different tools

  3. Organize wordlists by category (directories, files, subdomains)

7.3 Nuclei Templates

  1. Configure template directories

  2. Add custom templates

  3. Set up template update schedules

Troubleshooting Common Issues

API Key Issues

  • "Invalid API Key": Check that you've copied the key correctly

  • "Expired API Key": Generate a new key if yours has expired

  • "Rate Limited": Wait a few minutes before making more requests

CLI Installation Issues

  • "Command not found": Ensure the CLI is in your PATH

  • "Permission denied": Make sure the file is executable (chmod +x wayhack-cli)

  • "Connection refused": Check your internet connection and firewall settings

Tool Configuration Issues

  • "Tool not found": Ensure the security tool is installed on your system

  • "Invalid wordlist": Check that wordlist files exist and are readable

  • "Timeout errors": Increase timeout values in tool settings

Next Steps

Congratulations! You've successfully:

  • ✅ Created your WayHack account

  • ✅ Generated your first API key

  • ✅ Installed the CLI tool

  • ✅ Run your first URL reconnaissance search

What's Next?

  1. Explore Data Sources: Try different OSINT sources to find the best data for your needs

  2. Read the User Guide: Check out our comprehensive User Guide

  3. Join the Community: Connect with other security researchers and OSINT practitioners

  4. API Integration: Learn how to integrate WayHack into your existing reconnaissance workflows

  5. Advanced Filtering: Explore custom search patterns and result filtering

Getting Help

If you need assistance:

  • 📚 Documentation: Browse our comprehensive guides

  • 💬 Community: Join our Discord server

  • 📧 Support: Email us at support@wayhack.sh

  • 🐛 Bug Reports: Submit issues on GitHub

Ready to dive deeper? Continue to the User Guide for advanced features and best practices.

Security Reminders

  • Keep your API keys secure and never share them

  • Only test targets you own or have explicit permission to test

  • Follow responsible disclosure if you find vulnerabilities

  • Respect rate limits and terms of service

  • Keep your tools updated for the latest security features