WarpCheck API

WarpCheck API provides DNS, email, security and blacklist intelligence in a unified interface. Detect silent failures, automate diagnostics and protect your users — programmatically.

Authentication

All API requests require an API key passed via the X-API-Key header.

curl -H "X-API-Key: tw_live_YOUR_API_KEY" \
  "https://api.warpcheck.com/api/v1/dns/lookup?domain=example.com"

Quick Start

Get a complete domain health report with a single request:

curl -X POST \
  -H "X-API-Key: tw_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target": "example.com"}' \
  "https://api.warpcheck.com/api/v1/report/full"

This returns DNS, email authentication, SSL, and blacklist analysis in a single response.

Endpoints

curl -H "X-API-Key: tw_live_YOUR_KEY" \
  "https://api.warpcheck.com/api/v1/dns/lookup?domain=example.com"

{
  "ok": true,
  "data": {
    "a": ["93.184.216.34"],
    "mx": [{"priority": 10, "exchange": "mail.example.com"}],
    "txt": ["v=spf1 -all"],
    "ns": ["ns1.example.com", "ns2.example.com"]
  },
  "meta": {
    "query": "example.com",
    "request_id": "req_abc123",
    "cached": false,
    "elapsed_ms": 245
  }
}

curl -H "X-API-Key: tw_live_YOUR_KEY" \
  "https://api.warpcheck.com/api/v1/domains/whois?domain=example.com"

{
  "ok": true,
  "data": {
    "domain_name": "example.com",
    "registrar": "RESERVED-Internet Assigned Numbers Authority",
    "creation_date": "1995-08-14",
    "expiration_date": "2025-08-13",
    "name_servers": ["ns1.example.com"]
  },
  "meta": { "request_id": "req_def456", "elapsed_ms": 820 }
}

curl -H "X-API-Key: tw_live_YOUR_KEY" \
  "https://api.warpcheck.com/api/v1/email/spf?domain=example.com"

{
  "ok": true,
  "data": {
    "record": "v=spf1 include:_spf.google.com -all",
    "valid": true,
    "dns_lookups": 3,
    "mechanisms": ["include:_spf.google.com", "-all"]
  },
  "meta": { "request_id": "req_ghi789" }
}

curl -H "X-API-Key: tw_live_YOUR_KEY" \
  "https://api.warpcheck.com/api/v1/email/dmarc?domain=example.com"

{
  "ok": true,
  "data": {
    "record": "v=DMARC1; p=reject; rua=mailto:[email protected]",
    "policy": "reject",
    "has_rua": true,
    "valid": true
  },
  "meta": { "request_id": "req_jkl012" }
}

curl -H "X-API-Key: tw_live_YOUR_KEY" \
  "https://api.warpcheck.com/api/v1/security/ssl?domain=example.com"

{
  "ok": true,
  "data": {
    "valid": true,
    "issuer": "Let's Encrypt Authority X3",
    "expires": "2025-06-15T00:00:00Z",
    "days_remaining": 73,
    "protocol": "TLSv1.3",
    "grade": "A+"
  },
  "meta": { "request_id": "req_mno345" }
}

curl -H "X-API-Key: tw_live_YOUR_KEY" \
  "https://api.warpcheck.com/api/v1/blacklist/ip?ip=1.2.3.4"

{
  "ok": true,
  "data": {
    "status": "clean",
    "risk_score": 0.02,
    "false_positive_likely": false,
    "providers_checked": 32,
    "providers_listed": 0
  },
  "meta": { "request_id": "req_pqr678", "confidence": "high" }
}

curl -H "X-API-Key: tw_live_YOUR_KEY" \
  "https://api.warpcheck.com/api/v1/blacklist/domain?domain=example.com"

{
  "ok": true,
  "data": {
    "status": "clean",
    "risk_score": 0.0,
    "false_positive_likely": false,
    "providers_checked": 28,
    "providers_listed": 0
  },
  "meta": { "request_id": "req_stu901", "confidence": "high" }
}

curl -X POST -H "X-API-Key: tw_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target": "example.com"}' \
  "https://api.warpcheck.com/api/v1/report/full"

{
  "ok": true,
  "data": {
    "target": "example.com",
    "score": 87,
    "sections": {
      "dns": { "score": 95, "status": "healthy" },
      "email": { "score": 82, "status": "warning" },
      "security": { "score": 90, "status": "healthy" },
      "blacklist": { "score": 100, "status": "clean" }
    }
  },
  "meta": {
    "request_id": "req_vwx234",
    "elapsed_ms": 1840,
    "confidence": "high"
  }
}

Response Format

All responses follow a consistent envelope format:

{
  "ok": true,           // boolean — request succeeded
  "data": { ... },      // object — endpoint-specific result
  "meta": {
    "request_id": "req_...",  // unique request identifier
    "elapsed_ms": 245,        // processing time
    "cached": false,          // whether result was cached
    "confidence": "high"      // data quality (high | medium | low)
  },
  "errors": []          // array — populated only on failure
}

Error Handling

Errors return standard HTTP status codes with descriptive messages:

{
  "ok": false,
  "data": null,
  "meta": { "request_id": "req_err001" },
  "errors": [
    { "code": "INVALID_DOMAIN", "message": "The domain format is invalid." }
  ]
}

Rate Limits

API rate limits depend on your plan. Limits are applied per API key on a monthly basis.

Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset.