View as Markdown
IPGeolocation icon

IPGeolocation ACTION

Get IP Security

Retrieve real-time threat intelligence for an IPv4 or IPv6 address, including VPN, proxy, Tor, bot, spam detection, and a threat score. 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 IP Security 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-ip-security",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ipgeolocation: { authProvisionId: "apn_xxxxxxx" },
    ip: "IP Address",
    fields: "Fields",
  },
})

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 Security inputs
Property Type Description
ip IP Address string
The IPv4/IPv6 address to look up. Leave blank to lookup security data for the caller's IP address
Optional
fields Fields string
Comma-separated list of fields to return (e.g. security.is_vpn,security.is_tor). Reduces response size.
Optional
excludes Exclude Fields string
Comma-separated list of fields or objects to exclude from the response (e.g. security.is_relay,security.is_anonymous,security.threat_score). The ip field is always returned.
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-ip-security
Version
0.0.2
App
IPGeolocation
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes