IPGeolocation ACTION
Get Bulk IP Geolocation
Retrieve geolocation data for multiple IPv4/IPv6 addresses or domain names in a single request. Maximum 50,000 IPs per request. Only available on paid plans. 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 Bulk 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-bulk-geolocation",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
ipgeolocation: { authProvisionId: "apn_xxxxxxx" },
ips: ["IP Addresses or Domains"],
lang: "Language",
},
})
console.log(result)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-bulk-geolocation",
"configured_props": {
"ipgeolocation": { "authProvisionId": "apn_xxxxxxx" },
"ips": ["IP Addresses or Domains"],
"lang": "Language"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{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-bulk-geolocation",
arguments: {
ips: ["IP Addresses or Domains"],
lang: "Language",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
ips IP Addresses or Domains | string[] | List of IPv4/IPv6 addresses or domain names to look up. Maximum 50,000 per request Required |
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-bulk-geolocation
- Version
- 0.0.2
- App
- IPGeolocation
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗