action threatjammer_geolocate_ip_v1_geo_ip_address_get {
  label: "Get the geo location data of the IP address."
  description: "### What\nGet the geo location data of the IP address passed as argument. This information includes:\n- Latitude and longitude\n- Time zone\n- Accuracy radius\n- Postal code\n- City name\n- Region\n- Country\n- Country of the service provider\n- Continent\n- Reverse PTR hostnames\n\n\n### Parameters\nThe only argument accepted in the query string is a public IPv4 or IPv6 addresses.\n\n### Result\nThe result contains the following set of data:\n\nThe result is a JSON object with the following structure:\n- ``self``: the URI of the API call\n- ``accuracy_radius``:  The radius in kilometers around the specified location where the IP address is likely to be.\n- ``asn_country_iso_code``: The ISO code of the country of the Autonomous System (AS) owner of the IP address.\n- ``city_geoname_code``:``: City geoname code. The geoname code by [GeoNames](https://en.wikipedia.org/wiki/GeoNames) is a unique identifier assigned to each geographical point on the globe.\n- ``city_name``:``: City name, in english. The developer can use the geoname code to localize the name of the city.\n- ``continent_code``: The continent code. It can be any of the following: AF, AN, AS, EU, NA, OC, SA.\n- ``country_iso_code``: The country ISO 3166-1 alpha-2 code.\n- ``hostnames``: The list of hostnames associated with the IP address obtained from the reverse DNS lookup.\n- ``latitude``: The latitude of the geolocation.\n- ``longitude``: The longitude of the geolocation.\n- ``postal_code``:``: The postal code of the city.\n- ``region_geoname_code``:``: The geoname code of the region.\n- ``region_name``:``: The region name, in english. The developer can use the geoname code to localize the name of the region.\n- ``time_zone``: The name of the time zone.\n\n\n### Errors\nThe endpoint will return the following errors:\n- a `400 Bad Request` error if the IP address is not public.\n- a `422 Unprocessable Entity` error if the IP address is malformed.\n\nIt will also return the API Global errors described in the API description."
  provider: threatjammer
  method: GET
  path: "/v1/geo/{ip_address}"
  encoding: json
  input: {
    type: "object"
    properties: {
      ip_address: {
        type: "string"
        format: "ipvanyaddress"
      }
    }
    required: ["ip_address"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["accuracy_radius", "asn_country_iso_code", "city_geoname_code", "city_name", "continent_code", "country_iso_code", "hostnames", "latitude", "longitude", "postal_code", "region_geoname_code", "region_name", "time_zone"]
    properties: {
      accuracy_radius: {
        type: "number"
      }
      asn_country_iso_code: {
        type: "string"
      }
      city_geoname_code: {
        type: "integer"
      }
      city_name: {
        type: "string"
      }
      continent_code: {
        type: "string"
      }
      country_iso_code: {
        type: "string"
      }
      hostnames: {
        type: "array"
        items: {
          type: "string"
        }
      }
      latitude: {
        type: "number"
      }
      longitude: {
        type: "number"
      }
      postal_code: {
        type: "string"
      }
      region_geoname_code: {
        type: "integer"
      }
      region_name: {
        type: "string"
      }
      self: {
        type: "string"
      }
      time_zone: {
        type: "string"
      }
    }
  }
}