View as Markdown
Ideal Postcodes icon

Ideal Postcodes ACTION

Find Place

Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name, and id. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ideal Postcodes account once, then configure and run Find Place 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: "ideal_postcodes-find-place",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ideal_postcodes: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    countryIso: "Country ISO",
  },
})

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.

Find Place inputs
Property Type Description
query Query string
Specifies the place you wish to query.
Required
countryIso Country ISO string
Filter by country ISO code (3 letter code, ISO 3166-1 standard). Filter by multiple countries with a comma separated list. E.g. GBR,IRL.
Optional
biasCountryIso Bias Country ISO string
Bias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. Bias by multiple countries with a comma separated list. E.g. GBR,IRL.
Optional
biasLonlat Bias Geolocation string
Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is 50000. Uses the format [longitude],[latitude],[radius in metres]. Only one geospatial bias may be provided.
Optional
biasIp Bias Geolocation of IP boolean
Biases search based on approximate geolocation of IP address. Set true to enable.
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
ideal_postcodes-find-place
Version
0.0.3
App
Ideal Postcodes
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes