VPN/Proxy/Threat Detection
check_securityCheck an IP address for security threats including VPN, proxy, Tor, and spam activity. Returns threat score and provider confidence details.
Instructions
Read-only security lookup via GET /v3/security. Paid only. Cost: 2 credits. Use only for security/threat data; use lookup_ip with include=security when the same request also needs location, ASN/company, network, timezone, currency, or abuse.
Returns { ip, security } with threat_score, VPN, proxy, residential proxy, Tor, relay, anonymity, bot, spam, known attacker, and cloud-provider fields; provider names, confidence scores, and last_seen dates appear when available.
fields/excludes use comma-separated security.* dot paths; ip is always returned. force_refresh bypasses cache only when the user asks. Call once per IP target and post-process locally.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ip | No | IPv4 or IPv6 address to check. Omit to check the caller's IP. | |
| fields | No | Comma-separated dot-path fields to return (e.g. security.threat_score,security.is_vpn). Reduces response size. | |
| excludes | No | Comma-separated dot-path fields to exclude (e.g. security.is_tor,security.is_cloud_provider). | |
| force_refresh | No | Default false. Set true only when the user asks to refresh cached security data; a successful refresh makes a new upstream request and can consume credits. |