# BigDataCloud

BigDataCloud offers a suite of APIs providing geolocation, reverse geocoding, and data validation services.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `BIG_DATA_CLOUD`
- **Version:** 20260211_00

## Tools

### Am I Roaming API

**Slug:** `BIG_DATA_CLOUD_AM_I_ROAMING_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `latitude` | number | Yes | Latitude value as per WGS 84 reference system, must be between -90 and 90. |
| `longitude` | number | Yes | Longitude value as per WGS 84 reference system, must be between -180 and 180. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ASN Extended Receiving From Info API

**Slug:** `BIG_DATA_CLOUD_ASN_EXTENDED_RECEIVING_FROM_INFO_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asn` | string | Yes | Autonomous System Number, either numeric (e.g., '123'), 'AS123', or 'ASN123'. |
| `offset` | integer | Yes | Number of receivingFrom entries to skip for pagination. |
| `batchSize` | integer | Yes | Number of receivingFrom entries to retrieve; hard limit is 50. |
| `localityLanguage` | string | No | Preferred language for locality names in ISO 639-1 format (default: 'en'); falls back to English or native names if unavailable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ASN Extended Transit To Info API

**Slug:** `BIG_DATA_CLOUD_ASN_EXTENDED_TRANSIT_TO_INFO_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asn` | string | Yes | Autonomous System Number as numeric or ASN format (e.g. '123', 'AS123', 'ASN123') |
| `offset` | integer | Yes | Number of transitTo entries to skip |
| `batchSize` | integer | Yes | Number of transitTo entries to retrieve (max 50) |
| `localityLanguage` | string | No | Preferred language for locality names in ISO 639-1 format, default 'en'. Falls back to English or native name if unavailable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### ASN Rank List API

**Slug:** `BIG_DATA_CLOUD_ASN_RANK_LIST_API`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("rank" | "asn" | "asnNumeric" | "organisation" | "countryCode") | No | Field to sort results by. Options: 'rank' (by IPv4 count), 'asn' (AS number string), 'asnNumeric' (AS number integer), 'organisation', 'countryCode'. Default: 'rank'. |
| `order` | string ("asc" | "desc") | No | Sort order: 'asc' (ascending) or 'desc' (descending). Default: 'asc'. For rank, 'asc' returns largest ASNs first (rank 1, 2, 3...). |
| `offset` | integer | No | Number of entries to skip for pagination. Default: 0. Use with batchSize to paginate through results. |
| `batchSize` | integer | No | Number of ASN entries to return per request. Default: 10. Max: 1000. |
| `localityLanguage` | string | No | ISO 639-1 language code for country names (e.g., 'en', 'es', 'fr', 'de', 'zh'). Default: 'en'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BGP Active Prefixes API

**Slug:** `BIG_DATA_CLOUD_BGP_ACTIVE_PREFIXES_API`

Tool to retrieve IPv4 or IPv6 prefixes currently announced on BGP. Use when inspecting BGP routing announcements for a given ASN.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asn` | string | Yes | Autonomous System Number as numeric or ASN format (e.g., '123', 'AS123', or 'ASN123') |
| `isv4` | boolean | No | True for IPv4 prefixes only, False for IPv6 prefixes |
| `sort` | string ("bgpPrefix" | "bgpPrefixNetworkAddress" | "bgpPrefixLastAddress" | "registryStatus" | "isBogon" | "isAnnounced" | "carriers") | No | Field to sort by |
| `order` | string ("asc" | "desc") | No | Sort order |
| `offset` | integer | No | Offset, number of entries to skip |
| `batchSize` | integer | No | Requested batch size (max 1000) |
| `bogonsOnly` | boolean | No | Limit to bogon routes only or not |
| `localityLanguage` | string | No | Preferred language for locality names (ISO 639-1 code) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Country by IP Address API

**Slug:** `BIG_DATA_CLOUD_COUNTRY_BY_IP_ADDRESS_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | IPv4 or IPv6 address. If omitted, caller's IP is assumed. |
| `localityLanguage` | string | No | Preferred language for locality names in ISO 639-1 format, e.g., 'en'; use 'default' to select the first administrative language. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Country Info API

**Slug:** `BIG_DATA_CLOUD_COUNTRY_INFO_API`

Tool to fetch detailed country information by ISO code. Use when you need localized names, currencies, regions, and other metadata for a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Country code in ISO 3166-1 Alpha-2 (e.g., 'US'), Alpha-3 (e.g., 'USA'), or numeric (e.g., '840') format. |
| `localityLanguage` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Email Address Verification API

**Slug:** `BIG_DATA_CLOUD_EMAIL_ADDRESS_VERIFICATION_API`

Tool to verify email addresses for syntax, domain validity, and disposability. Use after obtaining the email input.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emailAddress` | string | Yes | The email address to verify. Must be a valid email format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Hazard Report API

**Slug:** `BIG_DATA_CLOUD_HAZARD_REPORT_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | IPv4 or IPv6 address. If omitted, the caller's IP address is assumed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Networks by CIDR

**Slug:** `BIG_DATA_CLOUD_NETWORK_BY_CIDR`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cidr` | string | Yes | CIDR range in 'x.x.x.x/y' format. x: 0-255, y: 0-32. |
| `bogonsOnly` | boolean | No | If true, returns only bogon networks. |
| `depthLimit` | integer | No | How many hierarchical levels down to include in the response. |
| `subnetsOffset` | integer | No | Number of subnetwork entries to skip. |
| `localityLanguage` | string | No | Preferred language for locality names in ISO 639-1 format, e.g., 'en', 'es'. |
| `subnetsBatchSize` | integer | No | Number of subnetwork entries to retrieve (max 20). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Network by IP Address API

**Slug:** `BIG_DATA_CLOUD_NETWORK_BY_IP_ADDRESS_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | IPv4 IP address in a string or numeric format, or IPv6 address. If omitted, the caller's IP address is assumed. |
| `localityLanguage` | string | No | Preferred language for locality names in ISO 639-1 format, such as 'en', 'es'; defaults to 'en'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Phone Number Validation by IP

**Slug:** `BIG_DATA_CLOUD_PHONE_NUMBER_VALIDATION_BY_IP`

Tool to validate phone numbers by inferring country from client IP. Use when you want to validate a number without specifying country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | IPv4 or IPv6 address. If omitted, uses caller's IP |
| `number` | string | Yes | Phone number to validate |
| `localityLanguage` | string | No | Preferred language for locality names in ISO 639-1 format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Geocoding With Timezone API

**Slug:** `BIG_DATA_CLOUD_REVERSE_GEOCODING_TIMEZONE_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `latitude` | number | Yes | Latitude value as per WGS 84 reference system (GPS). Range: -90 to 90. |
| `longitude` | number | Yes | Longitude value as per WGS 84 reference system (GPS). Range: -180 to 180. |
| `localityLanguage` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Time Zone by IP Address API

**Slug:** `BIG_DATA_CLOUD_TIME_ZONE_BY_IP_ADDRESS_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | IPv4 or IPv6 address. Defaults to caller's IP if omitted. |
| `utcReference` | integer | No | UTC time reference in Unix time (seconds). Defaults to current time if omitted or invalid. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tor Exit Nodes Geolocated API

**Slug:** `BIG_DATA_CLOUD_TOR_EXIT_NODES_GEOLOCATED_API`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("ip" | "countryCode" | "countryName" | "carriers") | No | Field to sort results by: 'ip' (IP address), 'countryCode' (2-letter country code), 'countryName' (localized country name), or 'carriers' (carrier info). |
| `order` | string ("asc" | "desc") | No | Sort order: 'asc' for ascending (A-Z, lowest-highest) or 'desc' for descending (Z-A, highest-lowest). |
| `offset` | integer | No | Number of entries to skip for pagination. Use with batchSize to iterate through all nodes. |
| `batchSize` | integer | No | Number of TOR exit node entries to return per request (1-1000). Use smaller values for quick checks, larger for bulk analysis. |
| `localityLanguage` | string | No | ISO 639-1 language code for localized country names (e.g., 'en' for English, 'de' for German, 'fr' for French, 'ja' for Japanese). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### User Agent Parser API

**Slug:** `BIG_DATA_CLOUD_USER_AGENT_PARSER_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `userAgentRaw` | string | Yes | Raw User-Agent string to parse (from HTTP request header). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### User Risk API

**Slug:** `BIG_DATA_CLOUD_USER_RISK_API`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | IPv4 or IPv6 address to assess. If omitted, defaults to the caller's IP address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |