NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
BigDataCloud connects to a Nagent workspace with an API key. Once it is connected, agents can call 17 BigDataCloud actions, such as "Am I Roaming API", "ASN Extended Receiving From Info API" and "ASN Extended Transit To Info API". 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 BigDataCloud, with input parameters and output schema.
BIG_DATA_CLOUD_AM_I_ROAMING_APITool to determine if the user is roaming based on their IP address and GPS coordinates. Use after obtaining device location to verify roaming status before mobile actions.
Input parameters
Latitude value as per WGS 84 reference system, must be between -90 and 90.
Longitude value as per WGS 84 reference system, must be between -180 and 180.
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
BIG_DATA_CLOUD_ASN_EXTENDED_RECEIVING_FROM_INFO_APITool to return upstream providers (receivingFrom) for a given ASN. Use when you need a paginated list of ASes feeding traffic for the specified ASN.
Input parameters
Autonomous System Number, either numeric (e.g., '123'), 'AS123', or 'ASN123'.
Number of receivingFrom entries to skip for pagination.
Number of receivingFrom entries to retrieve; hard limit is 50.
Preferred language for locality names in ISO 639-1 format (default: 'en'); falls back to English or native names if unavailable.
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
BIG_DATA_CLOUD_ASN_EXTENDED_TRANSIT_TO_INFO_APITool to return downstream customers (transitTo) for a given ASN. Use when you need a paginated list of ASes receiving traffic from a specific ASN.
Input parameters
Autonomous System Number as numeric or ASN format (e.g. '123', 'AS123', 'ASN123')
Number of transitTo entries to skip
Number of transitTo entries to retrieve (max 50)
Preferred language for locality names in ISO 639-1 format, default 'en'. Falls back to English or native name if unavailable.
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
BIG_DATA_CLOUD_ASN_RANK_LIST_APIRetrieves a ranked list of Autonomous Systems (ASNs) sorted by IPv4 address announcement volumes. Use cases: - Find the largest ASNs by IP address count (DoD, Amazon, Microsoft, etc.) - Look up ASN rankings for network analysis - Paginate through the global ASN database (79,000+ entries) - Sort ASNs by various criteria (rank, name, organisation, country) Returns paginated results with total count for navigation.
Input parameters
Field to sort results by. Options: 'rank' (by IPv4 count), 'asn' (AS number string), 'asnNumeric' (AS number integer), 'organisation', 'countryCode'. Default: 'rank'.
Sort order: 'asc' (ascending) or 'desc' (descending). Default: 'asc'. For rank, 'asc' returns largest ASNs first (rank 1, 2, 3...).
Number of entries to skip for pagination. Default: 0. Use with batchSize to paginate through results.
Number of ASN entries to return per request. Default: 10. Max: 1000.
ISO 639-1 language code for country names (e.g., 'en', 'es', 'fr', 'de', 'zh'). Default: 'en'.
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
BIG_DATA_CLOUD_BGP_ACTIVE_PREFIXES_APITool to retrieve IPv4 or IPv6 prefixes currently announced on BGP. Use when inspecting BGP routing announcements for a given ASN.
Input parameters
Autonomous System Number as numeric or ASN format (e.g., '123', 'AS123', or 'ASN123')
True for IPv4 prefixes only, False for IPv6 prefixes
Field to sort by
Sort order
Offset, number of entries to skip
Requested batch size (max 1000)
Limit to bogon routes only or not
Preferred language for locality names (ISO 639-1 code)
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
BIG_DATA_CLOUD_COUNTRY_BY_IP_ADDRESS_APITool to geolocate an IP address and retrieve country details and demographics. Use when you need country-level data after obtaining the target IP address.
Input parameters
IPv4 or IPv6 address. If omitted, caller's IP is assumed.
Preferred language for locality names in ISO 639-1 format, e.g., 'en'; use 'default' to select the first administrative language.
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
BIG_DATA_CLOUD_COUNTRY_INFO_APITool to fetch detailed country information by ISO code. Use when you need localized names, currencies, regions, and other metadata for a country.
Input parameters
Country code in ISO 3166-1 Alpha-2 (e.g., 'US'), Alpha-3 (e.g., 'USA'), or numeric (e.g., '840') format.
Preferred language for locality names in ISO 639-1 format, such as 'en', 'es'. Defaults to 'en' and falls back to native names if unavailable.
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
BIG_DATA_CLOUD_EMAIL_ADDRESS_VERIFICATION_APITool to verify email addresses for syntax, domain validity, and disposability. Use after obtaining the email input.
Input parameters
The email address to verify. Must be a valid email format.
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
BIG_DATA_CLOUD_HAZARD_REPORT_APITool to fetch a cybersecurity hazard report for a specified IP address. Use when assessing an IP's threat profile (VPN, proxy, blacklists, hosting risk).
Input parameters
IPv4 or IPv6 address. If omitted, the caller's IP address is assumed.
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
BIG_DATA_CLOUD_NETWORK_BY_CIDRTool to retrieve BGP-announced networks within a specified CIDR range. Use when you need to analyze network announcements within a particular CIDR after confirming the range format.
Input parameters
CIDR range in 'x.x.x.x/y' format. x: 0-255, y: 0-32.
If true, returns only bogon networks.
How many hierarchical levels down to include in the response.
Number of subnetwork entries to skip.
Preferred language for locality names in ISO 639-1 format, e.g., 'en', 'es'.
Number of subnetwork entries to retrieve (max 20).
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
BIG_DATA_CLOUD_NETWORK_BY_IP_ADDRESS_APITool to retrieve registry, ASN, and BGP details for a given IP address’s network. Use when you need detailed network information (e.g., ASNs, prefixes) after confirming the target IP.
Input parameters
IPv4 IP address in a string or numeric format, or IPv6 address. If omitted, the caller's IP address is assumed.
Preferred language for locality names in ISO 639-1 format, such as 'en', 'es'; defaults to 'en'.
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
BIG_DATA_CLOUD_PHONE_NUMBER_VALIDATION_BY_IPTool to validate phone numbers by inferring country from client IP. Use when you want to validate a number without specifying country.
Input parameters
IPv4 or IPv6 address. If omitted, uses caller's IP
Phone number to validate
Preferred language for locality names in ISO 639-1 format
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
BIG_DATA_CLOUD_REVERSE_GEOCODING_TIMEZONE_APITool to return reverse geocoding and time zone info for given coordinates. Use when you need both locality details and timezone data in one call.
Input parameters
Latitude value as per WGS 84 reference system (GPS). Range: -90 to 90.
Longitude value as per WGS 84 reference system (GPS). Range: -180 to 180.
Preferred language for locality names in ISO 639-1 format, such as 'en', 'es'. Defaults to 'en'. Use 'default' to adjust to first administrative language.
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
BIG_DATA_CLOUD_TIME_ZONE_BY_IP_ADDRESS_APITool to retrieve time zone information for a given IP address. Use when you need DST status, UTC offsets, and local/UTC time for a specific IP.
Input parameters
IPv4 or IPv6 address. Defaults to caller's IP if omitted.
UTC time reference in Unix time (seconds). Defaults to current time if omitted or invalid.
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
BIG_DATA_CLOUD_TOR_EXIT_NODES_GEOLOCATED_APIRetrieve a paginated list of active TOR exit node IP addresses with geolocation and carrier (ASN) details. Use this tool to: - Get a list of known TOR exit node IPs to detect/block anonymous traffic - Analyze geographic distribution of TOR exit nodes by country - Look up carrier/ASN information for TOR nodes - Build IP blocklists or allowlists for TOR traffic Returns nodes with IP address, country info (when available), and detailed carrier/ASN data including BGP prefix counts and global ranking.
Input parameters
Field to sort results by: 'ip' (IP address), 'countryCode' (2-letter country code), 'countryName' (localized country name), or 'carriers' (carrier info).
Sort order: 'asc' for ascending (A-Z, lowest-highest) or 'desc' for descending (Z-A, highest-lowest).
Number of entries to skip for pagination. Use with batchSize to iterate through all nodes.
Number of TOR exit node entries to return per request (1-1000). Use smaller values for quick checks, larger for bulk analysis.
ISO 639-1 language code for localized country names (e.g., 'en' for English, 'de' for German, 'fr' for French, 'ja' for Japanese).
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
BIG_DATA_CLOUD_USER_AGENT_PARSER_APITool to parse a User-Agent string into device, OS, browser, and bot details. Use when you have a raw User-Agent header and need structured client info.
Input parameters
Raw User-Agent string to parse (from HTTP request header).
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
BIG_DATA_CLOUD_USER_RISK_APITool to return a risk assessment for a user based on IP signals for fraud prevention. Use after initial IP checks to decide whether to bypass or require captcha challenges.
Input parameters
IPv4 or IPv6 address to assess. If omitted, defaults to the caller's IP 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
Agents can call 17 BigDataCloud actions on Nagent, including "Am I Roaming API", "ASN Extended Receiving From Info API" and "ASN Extended Transit To Info API". Am I Roaming API: Determine if the user is roaming based on their IP address and GPS coordinates. Each action is listed on this page with its input parameters and its output.
BigDataCloud 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.
Am I Roaming API takes 2 required inputs: latitude and longitude. It returns data, error and successful.