---
canonical_url: "https://docs.composio.dev/toolkits/ip_registry"
markdown_url: "https://docs.composio.dev/toolkits/ip_registry.md"
product: "platform"
version: null
last_updated: null
---

# IPRegistry

IPRegistry provides IP geolocation, network, company, carrier, threat, autonomous-system, and user-agent intelligence.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `IP_REGISTRY`
- **Version:** 00000000_00

## Tools

### Batch Look Up ASNs

**Slug:** `IP_REGISTRY_BATCH_LOOKUP_ASNS`

Return ordered Autonomous System lookup results for 1 to 16 ASNs; an invalid item is returned as an inline error without failing successful items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asns` | array | Yes | Numeric Autonomous System Numbers to look up, for example [15169, 13335]. Do not include AS prefixes; results follow this order. |
| `fields` | array | No | Field paths relative to each ASN result, such as asn, name, prefixes.ipv4, and relationships.peers. Prefix a path with - to exclude it; do not add the provider's results prefix. |
| `unidecode` | boolean | No | Transliterate Unicode response values to ASCII. |

#### 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 |

### Batch Look Up IP Addresses

**Slug:** `IP_REGISTRY_BATCH_LOOKUP_IPS`

Return ordered lookup results for 1 to 1024 public IP addresses; an invalid item is returned as an inline error without failing successful items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Field paths relative to each IP result, such as ip, location.country.name, and security.is_vpn. Prefix a path with - to exclude it; do not add the provider's results prefix. |
| `unidecode` | boolean | No | Transliterate Unicode response values to ASCII. |
| `ip_addresses` | array | Yes | Public IPv4 and IPv6 addresses to look up. Results are returned in the same order. |
| `include_hostname` | boolean | No | Resolve and include fresh hostnames; enabling this may increase response latency. |

#### 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 |

### Look Up ASN

**Slug:** `IP_REGISTRY_LOOKUP_ASN`

Return organization, country, registry, network-prefix, and relationship data for one public Autonomous System Number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asn` | integer | Yes | Numeric Autonomous System Number. Do not include the AS prefix. |
| `fields` | array | No | Response field paths to include, such as asn, name, prefixes.ipv4, and relationships.peers. Prefix a path with - to exclude it. Omit to return all fields. |
| `unidecode` | boolean | No | Transliterate Unicode response values to ASCII. |

#### 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 |

### Look Up IP Address

**Slug:** `IP_REGISTRY_LOOKUP_IP`

Return geolocation, network, company, carrier, time-zone, currency, and threat data for one public IPv4 or IPv6 address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Response field paths to include, such as ip, location.country.name, and security.is_vpn. Prefix a path with - to exclude it. Omit to return all fields. |
| `unidecode` | boolean | No | Transliterate Unicode response values to ASCII. |
| `ip_address` | string | Yes | Public IPv4 or IPv6 address to look up, for example 1.1.1.1 or 2001:4860:4860::8888. |
| `include_hostname` | boolean | No | Resolve and include a fresh hostname; enabling this may increase response latency. |

#### 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 |

### Parse User Agents

**Slug:** `IP_REGISTRY_PARSE_USER_AGENTS`

Parse 1 to 256 raw User-Agent strings into browser or application, device, rendering-engine, and operating-system details in input order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Field paths relative to each parsed result, such as name, version_major, device, engine, and os. Prefix a path with - to exclude it; do not add the provider's results prefix. |
| `unidecode` | boolean | No | Transliterate Unicode response values to ASCII. |
| `user_agents` | array | Yes | Raw User-Agent header values to parse. Results are returned in the same order. |

#### 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 |