View as Markdown
IPGeolocation icon

IPGeolocation ACTION

Get IP Geolocation

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
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's IPGeolocation account once, then configure and run Get IP Geolocation from your backend or agent.

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get IP Geolocation inputs
Property Type Description
ip IP Address or Domain string
The IPv4/IPv6 address or domain name to look up. Leave blank to geolocate the caller's IP address
Optional
lang Language string
Language for the response. Defaults to English. Only available on paid plans
Optional
include Include Additional Data string
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
Optional
fields Fields string
Comma-separated list of fields to return (e.g. location.city,currency,asn.organization). Reduces response size. Available on all plans
Optional
excludes Exclude Fields string
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
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ipgeolocation-get-geolocation
Version
0.0.2
App
IPGeolocation
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes