# Get IP Geolocation — IPGeolocation

> Retrieve geolocation data for an IPv4/IPv6 address or domain name, including location, country metadata, timezone, currency, ASN, security insights and more. See the documentation

- Key: `ipgeolocation-get-geolocation`
- Type: Action (Read-only)
- Version: 0.0.2
- App: IPGeolocation (`ipgeolocation`) — https://pipedream.com/apps/ipgeolocation.md
- This page (HTML): https://pipedream.com/apps/ipgeolocation/actions/get-geolocation
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/ipgeolocation/actions/get-geolocation/get-geolocation.mjs

## Description

Retrieve geolocation data for an IPv4/IPv6 address or domain name, including location, country metadata, timezone, currency, ASN, security insights and more. [See the documentation](https://ipgeolocation.io/documentation/ip-location-api.html)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `ip` | `string` | No | The IPv4/IPv6 address or domain name to look up. Leave blank to geolocate the caller's IP address |
| `lang` | `string` | No | Language for the response. Defaults to English. Only available on paid plans |
| `include` | `string` | No | Comma-separated list of extra modules to include in the response. Available values: geo_accuracy, dma_code, user_agent, security, abuse, hostname, liveHostname, hostnameFallbackLive. Use * to include all. Only available on paid plans |
| `fields` | `string` | No | Comma-separated list of fields to return (e.g. location.city,currency,asn.organization). Reduces response size. Available on all plans |
| `excludes` | `string` | No | Comma-separated list of fields or objects to exclude from the response (e.g. currency,location.continent_code). The ip field is always returned. Available on all plans |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "ipgeolocation",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "ipgeolocation-get-geolocation",
  arguments: {
    ip: "IP Address or Domain",
    lang: "Language",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ipgeolocation-get-geolocation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ipgeolocation: { authProvisionId: "apn_xxxxxxx" },
    ip: "IP Address or Domain",
    lang: "Language",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "ipgeolocation-get-geolocation",
    "configured_props": {
      "ipgeolocation": { "authProvisionId": "apn_xxxxxxx" },
      "ip": "IP Address or Domain",
      "lang": "Language"
    }
  }'
```

---

- App: https://pipedream.com/apps/ipgeolocation.md · All apps: https://pipedream.com/apps