ip.halowerk.com

{
  "description": "Batch result with one record per submitted address and the payment receipt.",
  "properties": {
    "cache": {
      "description": "hit or mixed_or_miss.",
      "type": "string"
    },
    "invalid": {
      "description": "Number of unparseable addresses.",
      "type": "integer"
    },
    "payment": {
      "description": "Settlement receipt for the paid call.",
      "properties": {
        "amount_usdc": {
          "type": "number"
        },
        "channel": {
          "type": "string"
        },
        "endpoint": {
          "type": "string"
        },
        "facilitator": {
          "type": [
            "string",
            "null"
          ]
        },
        "payer_address": {
          "type": [
            "string",
            "null"
          ]
        },
        "tx_hash": {
          "type": [
            "string",
            "null"
          ]
        },
        "verified": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "requested": {
      "description": "Number of submitted addresses.",
      "type": "integer"
    },
    "results": {
      "items": {
        "description": "Intelligence record for one IP address. Unknown or unavailable source data is returned as null and explained in unavailable_fields. The risk score is a heuristic signal, not proof.",
        "properties": {
          "as_operator": {
            "description": "Autonomous system operator.",
            "type": [
              "string",
              "null"
            ]
          },
          "asn": {
            "description": "Autonomous system number.",
            "type": [
              "integer",
              "null"
            ]
          },
          "blocklists": {
            "description": "Open DNS blocklist results.",
            "properties": {
              "available_count": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "checks": {
                "items": {
                  "type": "object"
                },
                "type": "array"
              },
              "listed": {
                "description": "Null when every list was unavailable.",
                "type": [
                  "boolean",
                  "null"
                ]
              },
              "listed_on": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "cache": {
            "description": "hit or miss.",
            "type": [
              "string",
              "null"
            ]
          },
          "cached_at": {
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "checked_at": {
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "country": {
            "description": "ISO 3166-1 alpha-2 country code.",
            "type": [
              "string",
              "null"
            ]
          },
          "error": {
            "description": "Set to ip_invalid when the address could not be parsed.",
            "type": [
              "string",
              "null"
            ]
          },
          "ip": {
            "description": "The inspected address as submitted.",
            "type": "string"
          },
          "known_vpn_or_proxy_range": {
            "description": "Listed in the cached anonymous proxy range set.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "network_evidence": {
            "description": "Why the network type was assigned.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "network_provider": {
            "description": "Hosting or access provider when identified.",
            "type": [
              "string",
              "null"
            ]
          },
          "network_type": {
            "description": "datacenter, access or unknown.",
            "type": [
              "string",
              "null"
            ]
          },
          "region": {
            "description": "Region or state.",
            "type": [
              "string",
              "null"
            ]
          },
          "reserved": {
            "description": "True for private, loopback or otherwise reserved ranges.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "reserved_type": {
            "description": "Kind of reserved range when reserved is true.",
            "type": [
              "string",
              "null"
            ]
          },
          "reverse_dns": {
            "description": "First PTR record.",
            "type": [
              "string",
              "null"
            ]
          },
          "reverse_dns_status": {
            "description": "found, not_found or unavailable.",
            "type": [
              "string",
              "null"
            ]
          },
          "risk_factors": {
            "description": "Codes and points that produced the score.",
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "risk_label": {
            "description": "low, moderate, elevated or high.",
            "type": [
              "string",
              "null"
            ]
          },
          "risk_score": {
            "description": "Heuristic abuse and access risk signal.",
            "maximum": 100,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "score_meaning": {
            "type": [
              "string",
              "null"
            ]
          },
          "source_status": {
            "description": "Freshness and availability per dataset.",
            "type": "object"
          },
          "tor_exit": {
            "description": "Listed in the cached Tor exit list. Null when the source is unavailable.",
            "type": [
              "boolean",
              "null"
            ]
          },
          "unavailable_fields": {
            "description": "Fields left empty and why.",
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "valid": {
            "description": "False when the input was not a usable IP address.",
            "type": "boolean"
          },
          "version": {
            "description": "IP version, 4 or 6.",
            "type": [
              "integer",
              "null"
            ]
          },
          "vpn_or_proxy_sources": {
            "description": "Sources that carry the address.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "valid": {
      "description": "Number of parseable addresses.",
      "type": "integer"
    }
  },
  "type": "object"
}