View as Markdown
Mapbox icon

Mapbox ACTION

Geocode Address

Retrieves the geocoded location for a given address. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mapbox account once, then configure and run Geocode 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: "mapbox-geocode-address",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mapbox: { authProvisionId: "apn_xxxxxxx" },
    address: "Address",
    boundingBox: "Bounding Box",
  },
})

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.

Geocode Address inputs
Property Type Description
address Address string
The address (or partial address) to geocode. This could be an address, a city name, etc. Must consist of at most 20 words and numbers separated by spacing and punctuation, and at most 256 characters.
Required
boundingBox Bounding Box string
Limit results to only those contained within the supplied bounding box. Bounding boxes should be supplied as four numbers separated by commas, in minLon,minLat,maxLon,maxLat order. The bounding box cannot cross the 180th meridian. You can use the Location Helper to find a bounding box for use with this API.
Optional
proximity Proximity string
Bias the response to favor results that are closer to this location. Provided as two comma-separated coordinates in longitude,latitude order.
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
mapbox-geocode-address
Version
0.0.3
App
Mapbox
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes