> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# ipdata

> IP Geolocation API

**Server path:** `/ipdata` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                        | Description                                                   |
| ------------------------------------------- | ------------------------------------------------------------- |
| [`ipdata_bulk_lookup`](#ipdata_bulk_lookup) | Look up geolocation and threat data for multiple IP addresses |
| [`ipdata_lookup_asn`](#ipdata_lookup_asn)   | Look up detailed information for an Autonomous System Number  |
| [`ipdata_lookup_ip`](#ipdata_lookup_ip)     | Look up geolocation and threat data for an IP address         |

***

## ipdata\_bulk\_lookup

Look up geolocation and threat data for multiple IP addresses

**Parameters:**

| Parameter | Type      | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                      |
| --------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fields`  | string    | No       | —       | Comma-separated list of fields to return for each IP. Available fields: ip, is\_eu, city, region, region\_code, country\_name, country\_code, continent\_name, continent\_code, latitude, longitude, postal, calling\_code, flag, emoji\_flag, emoji\_unicode, asn, carrier, languages, currency, time\_zone, threat, company, count. Omit to return all fields. |
| `body`    | string\[] | Yes      | —       | JSON array of IPv4 or IPv6 addresses to look up (max 100)                                                                                                                                                                                                                                                                                                        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of fields to return for each IP. Available fields: ip, is_eu, city, region, region_code, country_name, country_code, continent_name, continent_code, latitude, longitude, postal, calling_code, flag, emoji_flag, emoji_unicode, asn, carrier, languages, currency, time_zone, threat, company, count. Omit to return all fields."
      },
      "body": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "JSON array of IPv4 or IPv6 addresses to look up (max 100)"
      }
    },
    "required": [
      "PCID",
      "body"
    ]
  }
  ```
</Expandable>

***

## ipdata\_lookup\_asn

Look up detailed information for an Autonomous System Number

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                    |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------ |
| `asn`     | string | Yes      | —       | Autonomous System Number prefixed with 'AS' (e.g. 'AS15169', 'AS2', 'AS13335') |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "asn": {
        "type": "string",
        "description": "Autonomous System Number prefixed with 'AS' (e.g. 'AS15169', 'AS2', 'AS13335')"
      }
    },
    "required": [
      "PCID",
      "asn"
    ]
  }
  ```
</Expandable>

***

## ipdata\_lookup\_ip

Look up geolocation and threat data for an IP address

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                                                                                                                                                                                                                                                                          |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ip`      | string | Yes      | —       | IPv4 or IPv6 address to look up (e.g. '8.8.8.8' or '2001:4860:4860::8888')                                                                                                                                                                                                                                                                           |
| `fields`  | string | No       | —       | Comma-separated list of fields to return. Available fields: ip, is\_eu, city, region, region\_code, country\_name, country\_code, continent\_name, continent\_code, latitude, longitude, postal, calling\_code, flag, emoji\_flag, emoji\_unicode, asn, carrier, languages, currency, time\_zone, threat, company, count. Omit to return all fields. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "ip": {
        "type": "string",
        "description": "IPv4 or IPv6 address to look up (e.g. '8.8.8.8' or '2001:4860:4860::8888')"
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of fields to return. Available fields: ip, is_eu, city, region, region_code, country_name, country_code, continent_name, continent_code, latitude, longitude, postal, calling_code, flag, emoji_flag, emoji_unicode, asn, carrier, languages, currency, time_zone, threat, company, count. Omit to return all fields."
      }
    },
    "required": [
      "PCID",
      "ip"
    ]
  }
  ```
</Expandable>