Skip to content

Check Endpoint

The /check endpoint analyzes domains and IP addresses for potential threats.

Request

http
GET /api/v1/check?domain={domain}&ip={ip}

Base URL

https://threats.cyberapi.io

Query Parameters

ParameterTypeRequiredDescription
domainstringNo*Domain name to check (e.g., example.com)
ipstringNo*IP address to check (e.g., 192.0.2.1)

*Either domain or ip is required

Headers

HeaderRequiredDescription
X-API-KeyYesYour API authentication key
AcceptNoResponse format (default: application/json)

Response

Success Response

json
{
  "domain": "example.com",
  "risk_score": 15,
  "verdict": "clean",
  "signals": [],
  "dns_security": {
    "has_mx": true,
    "spf_record": "v=spf1 include:_spf.google.com ~all",
    "dmarc_record": "v=DMARC1; p=reject;",
    "valid_config": true
  },
  "ssl_info": {
    "valid": true,
    "issuer": "DigiCert",
    "expires_at": "2025-12-31T23:59:59",
    "days_to_expire": 365,
    "is_self_signed": false,
    "protocol": "TLSv1.3"
  },
  "seo_health": {
    "score": 90,
    "issues": []
  },
  "content_analysis": {
    "title": "Example Domain",
    "description": "This domain is established to be used for illustrative examples in documents.",
    "social_links": [],
    "emails": []
  },
  "geo_location": {
    "country": "US",
    "city": "Mountain View",
    "asn": 15169,
    "isp": "Google LLC"
  },
  "tech_stack": {
    "server": "ECS",
    "framework": null
  },
  "cached": true
}

Response Fields

FieldTypeDescription
domainstringAnalyzed domain name
risk_scoreintegerRisk score from 0-100 (higher = riskier)
verdictstringOverall verdict: safe, suspicious, or malicious
signalsarrayList of detected threat signals
dns_securityobjectMX, SPF, DMARC configuration status
ssl_infoobjectSSL certificate validity, issuer, and expiration
seo_healthobjectBasic SEO checks (Robots.txt, Sitemap)
site_contentobjectContent analysis (Title, Description, Contacts)
tech_stackobjectDetected Server and Framework
security_headersobjectAnalysis of HSTS, CSP, and X-Frame-Options
cookiesobjectAnalysis of cookies (Secure, HttpOnly, SameSite)
geo_locationobjectPhysical location and ASN/ISP data
carbon_footprintobjectGreen hosting status
cachedbooleanWhether result was served from cache

Response Headers

HeaderDescription
X-CacheCache status: HIT or MISS
X-RateLimit-RemainingRemaining requests in current period
X-RateLimit-ResetUnix timestamp when limit resets

Examples

Check a Domain

bash
curl "https://threats.cyberapi.io/api/v1/check?domain=example.com" \
  -H "X-API-Key: your_key"
python
from cyberapi import CyberAPI

client = CyberAPI(api_key="your_key")
result = client.check(domain="example.com")
javascript
const client = new CyberAPI('your_key');
const result = await client.check({ domain: 'example.com' });

Check an IP Address

bash
curl "https://threats.cyberapi.io/api/v1/check?ip=192.0.2.1" \
  -H "X-API-Key: your_key"
python
result = client.check(ip="192.0.2.1")
javascript
const result = await client.check({ ip: '192.0.2.1' });

Risk Score Interpretation

Score RangeVerdictRecommended Action
0-30SafeAllow
31-70SuspiciousReview manually or add extra verification
71-100MaliciousBlock immediately

Rate Limiting

See Rate Limiting for details on quotas and handling limits.

Error Responses

See Error Codes for complete error reference.

Built with ❤️ for security teams