Wallet Watch

API Documentation

Integrate Wallet Watch data into your applications with our secure REST API

Important: Important: Wallet Watch reserves the right to review and approve all API access requests. Access is granted at our discretion based on intended use case and compliance requirements.

API Key Tiers
Two tiers available based on usage needs
LIMITED

20 requests/month

Free tier

Monthly reset

UNLIMITED

No monthly limits

Enterprise tier

Subject to approval

Security & Authentication
SHA-256 hashed keys with secure validation
256-bit API keys with SHA-256 hashing
Monthly usage tracking and enforcement
Automatic rate limit reset cycle
Request logging and audit trail
Base URL & Authentication
Getting started with the Wallet Watch API

Base URL

https://your-domain.com/api/public

Authentication Header

x-api-key: your_api_key_here

Technical Details

• API keys are 64-character hexadecimal strings (256-bit)

• Keys are hashed using SHA-256 before storage

• Limited tier: 20 requests per calendar month with automatic reset

• Unlimited tier: No monthly restrictions (enterprise only)

• All API responses use standard HTTP status codes

• Request/response content-type: application/json

Get Submissions
Retrieve wallet submissions with filtering options
GET
/submissions

Query Parameters

limitintegerResults limit (1-500, default: 100)
categoryIdstringFilter by category ID (optional)
cryptocurrencyIdstringFilter by cryptocurrency ID (optional)
searchTermstringSearch in wallet addresses (optional)

Example Request

GET /api/public/submissions?limit=10&searchTerm=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

Example Response

{
  "submissions": [
    {
      "id": "cm1234567890",
      "walletAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "category": {
        "id": "cat123",
        "name": "Phishing",
        "icon": "AlertTriangle"
      },
      "cryptocurrency": {
        "id": "btc",
        "name": "Bitcoin",
        "symbol": "BTC"
      },
      "reason": "Used in phishing attack targeting crypto users",
      "websiteUrl": "https://fake-exchange.scam",
      "reportedOwner": "Scammer Name",
      "status": "approved",
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "total": 1,
  "limit": 10
}
API Usage & Limits
Technical implementation details

Rate Limiting Implementation

• Limited Tier: 20 requests per calendar month

• Reset Mechanism: Monthly counter automatically resets on the first day of each month

• Usage Tracking: Each successful API call increments the usage counter

• Enforcement: Requests exceeding the limit receive HTTP 401 with error message

Error Response Examples

// Monthly limit exceeded (Limited tier)
{
  "message": "Monthly API limit exceeded (20 requests/month)"
}

// Invalid API key
{
  "message": "Invalid API key"
}

// Missing API key
{
  "message": "API Key is required"
}

Request Headers

x-api-key: [your-64-char-api-key]Content-Type: application/jsonAccept: application/json
Reference Data Endpoints
Retrieve categories and cryptocurrencies for filtering

Categories

GET
/categories

Returns all available illicit activity categories with ID, name, description, and icon

Cryptocurrencies

GET
/cryptocurrencies

Returns all supported cryptocurrencies with ID, name, symbol, and icon

Example Response Structure

// Categories endpoint
{
  "categories": [
    {
      "id": "cat123",
      "name": "Phishing",
      "description": "Fraudulent websites...",
      "icon": "AlertTriangle"
    }
  ]
}

// Cryptocurrencies endpoint
{
  "cryptocurrencies": [
    {
      "id": "btc",
      "name": "Bitcoin",
      "symbol": "BTC",
      "icon": "bitcoin-icon"
    }
  ]
}
Error Responses
Understanding API error codes
400Bad RequestInvalid or missing parameters
401UnauthorizedMissing or invalid API key
429Rate LimitedToo many requests
500Server ErrorInternal server error

Error Response Format

{
  "success": false,
  "error": "Invalid API key",
  "code": 401
}
API Access Request Process
How to obtain API access and approval requirements

Access Approval Required: Access Approval Required: Wallet Watch reserves the right to review, approve, or deny all API access requests at our sole discretion. We evaluate requests based on intended use case, compliance requirements, and platform security considerations.

Request Process

  1. Contact us through our Contact page with your API access request
  2. Provide detailed information about your intended use case and integration plans
  3. Include information about your organization, compliance requirements, and data handling practices
  4. Wait for our team to review your request (review process may take 5-10 business days)
  5. If approved, receive your API key and tier assignment
  6. Begin integration with proper authentication and rate limit compliance

Requirements for Approval

• Legitimate business use case for crypto fraud prevention or research

• Compliance with applicable data protection and privacy laws

• Commitment to responsible use of API data

• Technical capability to properly integrate and handle rate limits

• Agreement to our Terms of Use and API usage policies