---
title: Ip Geolocation
slug: connectors/ip-geolocation
docTags: 
createdAt: 2026-06-09T16:30:16.600Z
---

IP Geolocation API provides real-time and accurate geolocation, and security information for any IPv4 or IPv6 address and domain name along with the user-agent detail for the provided user-agent string. You can geolocate your online visitors and provide them the customized user-experience accordingly.

## Asset Setup

Keep in mind that the IP Geolocation API exposes the API Token in the URL by design. This is a security risk as the API Token is a secret and can be used to make requests to this paid API. It is a public key that is used to identify your account. You can use the API Token in the URL or in the HTTP header. The API Token is a unique identifier for your account.
You can find your API Token in the [Dashboard](https://dashboard.ipgeolocation.io/).

## Additional Documentation

- [Ip Geolocation Connector Documentation](https://docs.swimlane.com/connectors/ip-geolocation)
- [Ip Geolocation API Documentation](https://ipgeolocation.io/documentation.html)

# Configurations

## API Key Authentication

Authenticates using an API Key

### Configuration Parameters

| **Parameter** | **Description**                    | **Type** | **Required** |
| ------------- | ---------------------------------- | -------- | ------------ |
| url           | A URL to the target host.          | string   | Required     |
| api\_key      | API key                            | string   | Optional     |
| verify\_ssl   | Verify SSL certificate             | boolean  | Optional     |
| http\_proxy   | A proxy to route requests through. | string   | Optional     |

# Actions

## IP Lookup

Get information about the IP or domain name

### Endpoint

- **URL:** `/ipgeo`
- **Method:** `GET`

### Input

| **Argument Name**     | **Type** | **Required** | **Description**                     |
| --------------------- | -------- | ------------ | ----------------------------------- |
| `parameters.ip`       | string   | Required     | Parameters for the IP Lookup action |
| `parameters.lang`     | string   | Optional     | Parameters for the IP Lookup action |
| `parameters.fields`   | string   | Optional     | Parameters for the IP Lookup action |
| `parameters.excludes` | string   | Optional     | Parameters for the IP Lookup action |
| `parameters.include`  | string   | Optional     | Parameters for the IP Lookup action |

### Input Example

`{"parameters":{"ip":"8.8.8.8","lang":"en","fields":"country,city","excludes":"continent,location","include":"security,liveHostname"}}`

### Output

| **Parameter**     | **Type** | **Description**                  |
| ----------------- | -------- | -------------------------------- |
| `status_code`     | number   | HTTP status code of the response |
| `reason`          | string   | Response reason phrase           |
| `ip`              | string   | Output field: ip                 |
| `continent_code`  | string   | Output field: continent\_code    |
| `continent_name`  | string   | Name of the resource             |
| `country_code2`   | string   | Output field: country\_code2     |
| `country_code3`   | string   | Output field: country\_code3     |
| `country_name`    | string   | Name of the resource             |
| `country_capital` | string   | Output field: country\_capital   |
| `state_prov`      | string   | Output field: state\_prov        |
| `district`        | string   | Output field: district           |
| `city`            | string   | Output field: city               |
| `zipcode`         | string   | Output field: zipcode            |
| `latitude`        | string   | Output field: latitude           |
| `longitude`       | string   | Output field: longitude          |
| `is_eu`           | boolean  | Output field: is\_eu             |
| `calling_code`    | string   | Output field: calling\_code      |
| `country_tld`     | string   | Output field: country\_tld       |
| `languages`       | string   | Output field: languages          |
| `country_flag`    | string   | Output field: country\_flag      |
| `geoname_id`      | string   | Unique identifier                |
| `isp`             | string   | Output field: isp                |
| `connection_type` | string   | Type of the resource             |
| `organization`    | string   | Output field: organization       |
| `currency`        | object   | Output field: currency           |

### Output Example

`{"status_code":200,"response_headers":{"Date":"Sat, 04 Mar 2023 23:37:52 GMT","Content-Type":"application/json;charset=utf-8","Transfer-Encoding":"chunked","Connection":"keep-alive","X-Application-Context":"application:production:8002","CF-Cache-Status":"DYNAMIC","Strict-Transport-Security":"max-age=31536000; includeSubDomains; preload","Server":"cloudflare","CF-RAY":"7a2df315bf01d2cc-EZE","Content-Encoding":"gzip","alt-svc":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"},"reason":"OK","json_...`

# Response Headers

| **Header**                | **Description**                                          | **Example**                                  |
| ------------------------- | -------------------------------------------------------- | -------------------------------------------- |
| alt-svc                   | HTTP response header: alt-svc                            | h3=":443"; ma=86400, h3-29=":443"; ma=86400  |
| CF-Cache-Status           | HTTP response header: CF-Cache-Status                    | DYNAMIC                                      |
| CF-RAY                    | HTTP response header: CF-RAY                             | 7a2df315bf01d2cc-EZE                         |
| Connection                | HTTP response header: Connection                         | keep-alive                                   |
| Content-Encoding          | HTTP response header: Content-Encoding                   | gzip                                         |
| Content-Type              | The media type of the resource                           | application/json;charset=utf-8               |
| Date                      | The date and time at which the message was originated    | Sat, 04 Mar 2023 23:37:52 GMT                |
| Server                    | Information about the software used by the origin server | cloudflare                                   |
| Strict-Transport-Security | HTTP response header: Strict-Transport-Security          | max-age=31536000; includeSubDomains; preload |
| Transfer-Encoding         | HTTP response header: Transfer-Encoding                  | chunked                                      |
| X-Application-Context     | HTTP response header: X-Application-Context              | application\:production:8002                 |