NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Ip2Location connects to a Nagent workspace with an API key. Once it is connected, agents can call 8 Ip2Location actions, such as "Bulk IP Geolocation", "Check IP2Location API Credits" and "IP2Location Distance Calculator". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Ip2Location, with input parameters and output schema.
IP2LOCATION_BULK_IP_GEOLOCATIONRetrieve geolocation information for multiple IP addresses in a single request. Supports batch processing of 1-1000 IPv4 or IPv6 addresses with flexible output formats (JSON or CSV) and customizable field selection. Returns comprehensive data including country, region, city, coordinates, timezone, ASN, and proxy detection. Note: Automatically falls back to individual lookups if bulk endpoint is unavailable.
Input parameters
List of IPv4 or IPv6 addresses to look up (1 to 1000 entries).
Optional subset of fields to return; if omitted, all fields are returned.
Response format: 'json' for structured data or 'csv' for raw CSV text.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IP2LOCATION_CHECK_CREDITSTool to check remaining IP2Location API credits. Use after setting up authentication to monitor usage.
Input parameters
API key for IP2Location; if omitted, uses the metadata-configured key.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IP2LOCATION_DISTANCECalculate the great-circle distance between two IP addresses based on their geographic locations. This tool looks up the geolocation (latitude/longitude) for each IP address and calculates the shortest distance between them over the Earth's surface using the Haversine formula. Supports both IPv4 and IPv6 addresses. Returns the distance in kilometers along with the coordinates of both IPs. Use when you need to determine geographic separation between two IP addresses, such as for latency estimation, geographic analysis, or network optimization.
Input parameters
First IPv4 or IPv6 address
Second IPv4 or IPv6 address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IP2LOCATION_GET_HOSTED_DOMAINSRetrieves a list of domain names hosted on a specific IP address (IPv4 or IPv6). Use this tool when you need to: - Discover which domains are hosted on a particular IP - Investigate shared hosting environments - Analyze domain-to-IP relationships The API supports pagination for IPs with many hosted domains.
Input parameters
IPv4 or IPv6 address to query. Returns a list of domain names that are hosted on this IP address.
IP2WHOIS API key for accessing the Hosted Domains API. Required for authentication.
Page number for pagination (must be >= 1). Use with 'total_pages' in response to retrieve all results. Defaults to 1.
Response format. Accepts 'json' or 'xml'. Defaults to 'json'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IP2LOCATION_GET_IP_GEOLOCATIONTool to retrieve geolocation data for an IP address. Use when detailed IP location info is needed.
Input parameters
IPv4 or IPv6 address to look up
Translation language for certain addon fields; valid values as ISO language codes
Extra data to include; valid values: continent, country, region, city, geotargeting, country_groupings, time_zone_info
Response format; default is json
Web service package controlling which fields are returned; valid values WS1–WS25
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IP2LOCATION_GET_PROXY_DETECTIONTool to detect if an IP is a proxy, VPN, or TOR exit node. Use when verifying anonymizing services.
Input parameters
IPv4 or IPv6 address to check for proxy/VPN/TOR usage
Set to 1 to return only remaining credits instead of lookup data
Level of detail/package (PX1=basic to PX11=full)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IP2LOCATION_IP2_WHOIS_DOMAIN_WHOISTool to retrieve WHOIS information for a domain. Use when you need domain registration details.
Input parameters
Domain name to query, e.g. 'example.com'
Response format; either 'json' or 'xml'. Defaults to 'json'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
IP2LOCATION_LIST_IPSTool to list a curated set of test IPv4 and IPv6 addresses. Use when sample IPs are needed for IP2Location or IP2Proxy lookups during development or testing.
Input parameters
IP version filter: 'ipv4', 'ipv6', or 'all' to return both.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 8 Ip2Location actions on Nagent, including "Bulk IP Geolocation", "Check IP2Location API Credits" and "IP2Location Distance Calculator". Bulk IP Geolocation: Retrieve geolocation information for multiple IP addresses in a single request. Each action is listed on this page with its input parameters and its output.
Ip2Location connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Bulk IP Geolocation takes 1 required input: ips. It also takes 2 optional inputs: fields and format. It returns data, error and successful.