View as Markdown
ipbase icon

ipbase ACTION

Check IP Address

Checks the provided IP address (both v4 & v6 formats) and returns all available information. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ipbase account once, then configure and run Check IP Address 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: "ipbase-check-ip-address",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ipbase: { authProvisionId: "apn_xxxxxxx" },
    ip: "IP",
    language: "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.

Check IP Address inputs
Property Type Description
ip IP string
The IP address you want to query.
Required
language Language string
An ISO Alpha 2 Language Code for localizing the IP data.
Optional
hostname Hostname boolean
If the hostname parameter is set to TRUE, the API response will contain the hostname of the ip. Default to FALSE
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
ipbase-check-ip-address
Version
0.0.2
App
ipbase
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes