API Documentation

Programmatically access verified mirror domains through our REST API. Perfect for wallets, browser extensions, and security tools.

✅ API v1 is live and ready for production use

Quick Start

Example Request

GETSearch API

https://mirrorscan.app/api/v1/search?q=stake

Example Response

JSONResponse

{
  "domains": [
    {
      "domain": "stake.com",
      "verified": true,
      "description": "Crypto casino"
    }
  ]
}

API Endpoints

GET/api/v1/search

Search for verified domains in the registry

Parameters

qstringrequired

Search query (domain name or partial match)

limitnumberoptional

Maximum results to return (default: 10, max: 50)

Example URL

https://mirrorscan.app/api/v1/search?q=stake&limit=5

Example Response

{
  "domains": [
    {
      "id": "44b8b2e6-054f-46f9-bdb1-3673f2e546d6",
      "domain": "stake.com",
      "verified": true,
      "description": "Crypto casino and sports betting platform",
      "created_at": "2025-11-23T06:24:40.608Z",
      "updated_at": "2025-11-23T06:24:40.608Z"
    }
  ]
}

GET/api/v1/domain/{domain}

Get detailed information about a specific verified domain and all its mirrors

Parameters

domainstringrequired

The exact domain name to lookup (e.g., "stake.com")

Example URL

https://mirrorscan.app/api/v1/domain/stake.com

Example Response

{
  "domain": {
    "id": "44b8b2e6-054f-46f9-bdb1-3673f2e546d6",
    "domain": "stake.com",
    "verified": true,
    "description": "Crypto casino and sports betting platform",
    "created_at": "2025-11-23T06:24:40.608Z",
    "updated_at": "2025-11-23T06:24:40.608Z",
    "mirrors": [
      {
        "id": "eb9990bf-6e0e-412e-9b80-3fbb604b0daa",
        "host": "stake.ac",
        "type": "main",
        "region": "global",
        "status": "up",
        "last_checked": "2025-11-23T06:24:40.608Z",
        "created_at": "2025-11-23T06:24:40.608Z"
      }
    ]
  }
}

POST/api/v1/mirrors/submit

Submit new mirrors for verification (requires domain ownership verification)

Parameters

domainstringrequired

Main domain to register

emailstringrequired

Contact email for verification

descriptionstringoptional

Website description

mirrorsarrayrequired

Array of mirror objects with domain, type, and region

Example URL

https://mirrorscan.app/api/v1/mirrors/submit

Example Response

{
  "success": true,
  "message": "Mirrors submitted successfully",
  "domain": "example.com",
  "status": "under_review",
  "mirrors_count": 3
}

Authentication

The MirrorScan API v1 is currently free and does not require authentication for read operations. Rate limiting is applied per IP address.

Base URL

https://mirrorscan.app/api/v1/

Rate Limits

Per Hour1,000 requests

Per Day10,000 requests

Burst Limit100 requests/min

Response Codes

200OK

Request successful

400Bad Request

Invalid parameters or malformed request

404Not Found

Domain not found in registry

409Conflict

Domain already exists in registry

429Too Many Requests

Rate limit exceeded - please slow down

500Internal Server Error

Server error - please try again later

Use Cases

Crypto Wallets

Automatically find working exchange mirrors when main sites are blocked

Browser Extensions

Redirect users to working mirrors when sites are inaccessible

Security Tools

Verify legitimate mirrors and detect phishing attempts

Monitoring Systems

Track mirror availability and performance across regions

Ready to Get Started?

Try our API endpoints directly or integrate them into your application.

Try Search Interface Test API Directly