View as Markdown
Geoapify icon

Geoapify ACTION

Get Route

Calculates a route between two sets of latitude and longitude points. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Geoapify account once, then configure and run Get Route 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: "geoapify-get-route",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    geoapify: { authProvisionId: "apn_xxxxxxx" },
    fromLatitude: "From Latitude",
    fromLongitude: "From Longitude",
  },
})

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 Route inputs
Property Type Description
fromLatitude From Latitude string
The latitude of the starting point
Required
fromLongitude From Longitude string
The longitude of the starting point
Required
toLatitude To Latitude string
The latitude of the destination point
Required
toLongitude To Longitude string
The longitude of the destination point
Required
mode Mode string
The mode of transportation
Required
type Type string
The route optimization type
Optional
units Units string
Distance units for the calculated route, the default value is metric
Optional
format Format string
The format of the response, default value is geojson
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
geoapify-get-route
Version
0.0.2
App
Geoapify
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes