Documentação da API

Integre dados do Wallet Watch em suas aplicações com nossa API REST segura

Important: Importante: Wallet Watch se reserva o direito de revisar e aprovar todas as solicitações de acesso à API. O acesso é concedido a nosso critério baseado no caso de uso pretendido e requisitos de conformidade.

Níveis de Chave API
Dois níveis disponíveis baseados nas necessidades de uso
LIMITADO

20 solicitações/mês

Nível gratuito

Redefinição mensal

ILIMITADO

Sem limites mensais

Nível empresarial

Sujeito à aprovação

Segurança e Autenticação
Chaves com hash SHA-256 e validação segura
256-bit API keys with SHA-256 hashing
Monthly usage tracking and enforcement
Automatic rate limit reset cycle
Request logging and audit trail
URL Base e Autenticação
Primeiros passos com a API do Wallet Watch

Base URL

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

Authentication Header

x-api-key: your_api_key_here

Detalhes Técnicos

• 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

Obter Envios
Recuperar envios de carteira com opções de filtragem
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
}
Uso da API e Limites
Detalhes de implementação técnica

Implementação de Limitação de Taxa

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

Exemplos de Respostas de Erro

// 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"
}

Cabeçalhos de Solicitação

x-api-key: [your-64-char-api-key]Content-Type: application/jsonAccept: application/json
Endpoints de Dados de Referência
Recuperar categorias e criptomoedas para filtragem

Categorias

GET
/categories

Retorna todas as categorias de atividades ilícitas disponíveis com ID, nome, descrição e ícone

Criptomoedas

GET
/cryptocurrencies

Retorna todas as criptomoedas suportadas com ID, nome, símbolo e ícone

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
}
Processo de Solicitação de Acesso à API
Como obter acesso à API e requisitos de aprovação

Access Approval Required: Aprovação de Acesso Necessária: Wallet Watch se reserva o direito de revisar, aprovar ou negar todas as solicitações de acesso à API a nosso critério. Avaliamos solicitações baseadas no caso de uso pretendido, requisitos de conformidade e considerações de segurança da plataforma.

Processo de Solicitação

  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

Requisitos para Aprovação

• 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