Skip to main content
Geoapify logo
  • Category: places & weather
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 25
  • Triggers: 0
  • Slug: GEOAPIFY
  • Version: 20261101_00

Tools

Slug: GEOAPIFY_ADDRESS_AUTOCOMPLETETool to fetch address suggestions based on partial input. Use when you need to get predictive suggestions from incomplete address text.

Input Parameters

string
Bias results by proximity or boundary using formats: proximity:lon,lat|circle:lon,lat,radius|rect:lon1,lat1,lon2,lat2|countrycode:CC; combine with ’|’ for OR
string
Language code (ISO 639-1, 2 letters, e.g., ‘en’)
string
required
Partial address text to autocomplete
string ("country" | "state" | "city" | "postcode" | "street" | "amenity" | "locality")
Restrict suggestions by location type
integer
Maximum number of results to return, must be >= 1
string
Filter results by boundary or country using formats: circle:lon,lat,radius|rect:lon1,lat1,lon2,lat2|countrycode:CC|place:placeId; combine with ’|’ for AND
string ("geojson" | "json" | "xml")
Response format; one of: ‘geojson’ (default), ‘json’, ‘xml’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_BATCH_REQUESTSCreate or retrieve asynchronous batch processing jobs for geocoding, reverse geocoding, routing, or isoline APIs. Use cases: - Batch geocode up to 1000 addresses at once (forward geocoding) - Batch reverse geocode multiple coordinates - Process multiple routing or isoline requests in one batch Workflow: 1. Create a job by providing ‘api’ and ‘inputs’ (returns job ID and status ‘pending’) 2. Poll the job by providing ‘id’ until status changes from ‘pending’ to complete (results available)

Input Parameters

string
32-character hex job ID to retrieve status/results. Omit to create a new job. When provided, all other fields must be omitted.
string ("/v1/geocode/search" | "/v1/geocode/reverse" | "/v1/routing" | "/v1/isoline")
API endpoint to batch. Required when creating a job. /v1/geocode/search for forward geocoding, /v1/geocode/reverse for reverse geocoding, /v1/routing for routes, /v1/isoline for isochrones/isodistances.
object
Common JSON body applied to all inputs (for APIs requiring a body). Input-level body values override these.
array
Array of 1-1000 input objects. Required when creating a job. Each input has ‘params’ (required) and optional ‘id’ and ‘body’.
object
Common query parameters applied to all inputs. E.g., {‘lang’: ‘en’, ‘limit’: ‘3’}. Input-level params override these.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_BOUNDARIESRetrieve all administrative boundaries that contain a given location. Returns hierarchical boundaries (suburb, city, county, state, country) as GeoJSON features. Use this to find what administrative areas a coordinate belongs to, get boundary polygons for mapping, or identify postal codes and political districts for a location.

Input Parameters

string
Geoapify Place ID (from Places, Geocoding, or Geometry API responses). Use this OR lat/lon, not both.
number
Latitude of the location (-90 to 90). Required together with lon if id is not provided.
number
Longitude of the location (-180 to 180). Required together with lat if id is not provided.
string
ISO 639-1 two-letter language code for localized names (e.g., ‘en’, ‘de’, ‘fr’, ‘es’, ‘ja’). Results will use local names if not specified.
string ("point" | "geometry_1000" | "geometry_5000" | "geometry_10000")
Geometry detail level: ‘point’ returns centroid only (fastest), ‘geometry_1000/5000/10000’ returns simplified polygon boundaries at 1km/5km/10km resolution (lower = more detailed, larger response).
string ("administrative" | "postal_code" | "political" | "low_emission_zone")
Type of boundary to retrieve: ‘administrative’ for government divisions (city/county/state/country), ‘postal_code’ for postal zones, ‘political’ for electoral districts, ‘low_emission_zone’ for environmental zones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_CREATE_BATCH_FORWARD_GEOCODE_JOBTool to create a batch forward geocoding job for up to 1000 addresses. Use when you need to geocode multiple addresses asynchronously. Returns a job ID for retrieving results once processing is complete.

Input Parameters

string
Prioritize results based on proximity to geographic areas without limiting search scope. Formats: ‘circle:lon,lat,radiusMeters’ (circular priority), ‘rect:lon1,lat1,lon2,lat2’ (rectangular priority), ‘countrycode:code1,code2’ (country priority, use ‘auto’ for IP detection), ‘proximity:lon,lat’ (prioritize by distance from point).
string
Result language in ISO 639-1 format (e.g., ‘en’ for English).
string ("country" | "state" | "city" | "postcode" | "street" | "amenity")
Location types for filtering geocoding results.
string
Refine geocoding results by applying geographic filters. Formats: ‘circle:lon,lat,radiusMeters’ (circular area), ‘rect:lon1,lat1,lon2,lat2’ (rectangular area), ‘countrycode:code1,code2’ (specific countries, use ‘auto’ for IP detection), ‘place:placeId’ (specific boundary using place_id).
array
required
List of address strings to geocode (1-1000 addresses). Each item should be a valid address or partial address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_CREATE_BATCH_REVERSE_GEOCODE_JOBTool to create a batch reverse geocoding job that converts multiple lat/lon coordinates into addresses asynchronously. Use when you need to reverse geocode multiple coordinates (up to 1000) in one request. Returns a job ID for retrieving results.

Input Parameters

string
Result language in ISO 639-1 format (2-letter code, e.g., ‘en’ for English, ‘de’ for German).
string ("country" | "state" | "city" | "postcode" | "street" | "amenity")
Location type to search for. Filters results by type: country, state, city, postcode, street, or amenity (POIs).
array
required
List of latitude/longitude coordinate pairs to reverse geocode. Minimum 1, maximum 1000 locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_FORWARD_GEOCODINGTool to convert an address into geographic coordinates. Use when you need latitude and longitude from an address.

Input Parameters

string
Location bias. Formats: ‘circle:lon,lat,radiusMeters’, ‘rect:lon1,lat1,lon2,lat2’, ‘countrycode:code1,code2’, ‘proximity:lon,lat’. Combine multiple with ’|’ for OR logic. Default is countrycode:auto.
string
City name for structured address search
string
Result language (ISO 639-1 2-letter code, e.g., ‘en’)
string
Amenity or place name for structured address search
string
Free-form address to search, e.g., ‘Berlin, Germany’
string ("country" | "state" | "city" | "postcode" | "street" | "amenity" | "locality")
Location type filter. Allowed: country, state, city, postcode, street, amenity, locality
integer
Maximum number of results to return (default 5)
string
State or province for structured address search
string
Geoapify API key (auto-injected from authentication, typically not needed)
string
Location filters. Formats: ‘circle:lon,lat,radiusMeters’, ‘rect:lon1,lat1,lon2,lat2’, ‘countrycode:code1,code2’, ‘place:placeId’. Combine multiple with ’|’ for AND logic.
string ("geojson" | "json" | "xml")
Response format. One of: geojson (default), json, xml
string
Street name for structured address search
string
Country name for structured address search
string
Postal code or ZIP for structured address search
string
House number for structured address search

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_GEOMETRYTool to perform geometric operations on stored polygon geometries. Use when combining or intersecting multiple stored geometries.

Input Parameters

array
required
List of at least two geometry IDs to combine or intersect.
string ("union" | "intersection")
required
Geometric operation to apply. Must be ‘union’ or ‘intersection’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_GET_BATCH_FORWARD_GEOCODE_RESULTSRetrieve completed batch forward geocoding results in JSON using a job ID. If the job is still processing, returns a pending status with an empty results list.

Input Parameters

string
required
The unique job ID that was returned when the batch geocoding job was created. This ID is used to retrieve the results.
string ("json" | "csv")
The format in which to retrieve the results, either JSON or CSV. Defaults to JSON.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_GET_BATCH_REVERSE_GEOCODE_RESULTSTool to retrieve batch reverse geocoding job results. Use when you have a batch job ID from creating a batch reverse geocoding job and want to fetch the completed results.

Input Parameters

string
required
The unique job ID that was returned when the batch reverse geocoding job was created. This ID is used to retrieve the results.
string ("json" | "csv")
The format in which to retrieve the results, either JSON or CSV. Defaults to JSON if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_GET_BOUNDARIES_CONSISTS_OFGet boundaries that a specified location consists of. Returns child administrative divisions (states for country, districts for city). Useful for drilling down into sub-regions.

Input Parameters

string
required
Geoapify Place ID of the parent boundary to get sub-boundaries for (e.g., states for a country, districts for a city). Obtain this ID from Geocoding, Places, or other Boundaries API responses.
string
ISO 639-1 two-letter language code for localized names (e.g., ‘en’, ‘de’, ‘fr’, ‘es’, ‘ja’). Results will use local names if not specified.
string ("point" | "geometry_1000" | "geometry_5000" | "geometry_10000")
Geometry detail level: ‘point’ returns centroid only (fastest), ‘geometry_1000/5000/10000’ returns simplified polygon boundaries at 1km/5km/10km resolution (lower = more detailed, larger response, higher cost).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_GET_MAP_STYLETool to retrieve vector map style JSON for MapLibre GL and Mapbox GL. Returns a Mapbox-compatible style specification for rendering vector tiles.

Input Parameters

string ("osm-carto" | "osm-bright" | "osm-bright-grey" | "osm-bright-smooth" | "klokantech-basic" | "osm-liberty" | "maptiler-3d" | "toner" | "toner-grey" | "positron" | "positron-blue" | "positron-red" | "dark-matter" | "dark-matter-brown" | "dark-matter-dark-grey" | "dark-matter-dark-purple" | "dark-matter-purple-roads" | "dark-matter-yellow-roads")
required
Map style name. Common styles: osm-carto (OpenStreetMap default), osm-bright (bright OSM), dark-matter (dark theme), positron (light theme), toner (high contrast).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_GET_STATIC_MAPTool to generate static map images with customizable style, size, center, zoom, markers, and geometries. Use when you need a map image for display or printing.

Input Parameters

string
Bounding box to fit the map view in format ‘rect:lon1,lat1,lon2,lat2’. The map automatically adjusts center and zoom to fit this area. Cannot be used with center/zoom.
string
Map zoom level (0-20). Higher values show more detail. Required when using center parameter.
string ("osm-carto" | "osm-bright" | "osm-bright-grey" | "osm-bright-smooth" | "klokantech-basic" | "osm-liberty" | "maptiler-3d" | "toner" | "toner-grey" | "positron" | "dark-matter" | "dark-matter-brown" | "dark-matter-dark-grey" | "dark-matter-dark-purple" | "dark-matter-purple-roads" | "dark-matter-yellow-roads")
required
Map style to use. Options: osm-carto (OpenStreetMap Carto), osm-bright (OSM Bright), positron (light base map), dark-matter (dark base map), and others.
integer
required
Image width in pixels (1-4096). For high-resolution images with scaleFactor > 1, the effective width should not exceed 4096 pixels.
string
Map center coordinates in format ‘lonlat:longitude,latitude’ (e.g., ‘lonlat:2.3522,48.8566’ for Paris). Required unless area, marker, geometry, or geojson is specified.
string ("png" | "jpeg")
Output image format. Options: ‘png’ (default, supports transparency), ‘jpeg’ (smaller file size).
integer
required
Image height in pixels (1-4096). For high-resolution images with scaleFactor > 1, the effective height should not exceed 4096 pixels.
string
Marker definition(s) in format ‘lonlat:lon,lat;color:hex;size:small|medium|large;type:awesome|material’. Multiple markers can be separated by ’|’. Example: ‘lonlat:2.35,48.85;color:#ff0000;size:medium|lonlat:2.36,48.86;color:#0000ff’.
string
GeoJSON Feature or FeatureCollection (URL-encoded, max 1024 chars). Features can have properties: fillColor, fillOpacity, lineColor, lineWidth, lineOpacity. The map view automatically adjusts to fit the GeoJSON bounds.
string
Geometry to display on the map (lines, polygons, circles, rectangles). Format: ‘type:geometry_definition;color:hex;width:number’. Types: polyline, polygon, circle, rect. Example: ‘polyline:2.35,48.85,2.36,48.86,2.37,48.87;color:#0000ff;width:3’.
integer
Resolution multiplier for high-quality/print images (1-8). Default is 1. Use 2 for retina displays. Higher values (up to 8) available for print media.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_IP_GEOLOCATIONLookup geographic location information for an IP address. Returns city-level location data including country, region, city, coordinates, and additional metadata like currency and language. If no IP is provided, returns location for the caller’s IP address.

Input Parameters

string
IP address (IPv4 or IPv6) to lookup; if omitted, uses the caller’s IP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_ISOLINETool to generate isochrone or isodistance isolines. Use when visualizing reachable areas from a point; use id to poll ongoing calculations.

Input Parameters

string
Unique identifier of previously generated isoline (valid 24h). Exclusive with lat/lon/type/mode/range.
number
Latitude of the origin point in decimal degrees. Required for new calculation.
number
Longitude of the origin point in decimal degrees. Required for new calculation.
string ("drive" | "light_truck" | "medium_truck" | "truck" | "heavy_truck" | "truck_dangerous_goods" | "long_truck" | "bus" | "scooter" | "motorcycle" | "bicycle" | "mountain_bike" | "road_bike" | "walk" | "hike" | "transit" | "approximated_transit")
Travel mode for route calculation. Required for new calculation.
string ("time" | "distance")
Isoline type: ‘time’ (seconds) or ‘distance’ (meters). Required for new calculation.
string
Features to avoid separated by ’|’. Options: tolls, ferries, highways. Example: ‘tolls|ferries’.
string
Isoline range(s): seconds for time type (max 3600) or meters for distance type (max 60000). Supply single int or list for multiple ranges.
string ("metric" | "imperial")
Units for distance calculations. Default metric.
string ("free_flow" | "approximated")
Traffic model (motorized modes only). Default free_flow.
integer
Vehicle max speed in KPH (10-252). Applies to drive/truck/bus modes.
string ("balanced" | "short" | "less_maneuvers")
Route optimization. Default balanced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_LIST_POSTCODESTool to list postcodes within a specified area or boundary. Use when you need to retrieve multiple postcodes in a geographic region using filters like circle, rectangle, or place ID.

Input Parameters

integer
Maximum number of postcodes to return (1-100)
string
required
Filter by area. Supported formats: ‘place:place_id’ (e.g., ‘place:51a59aa36fd7e7594059923ee27e96a94740f00102f90185250300000000c00208’), ‘rect:lon1,lat1,lon2,lat2’ (e.g., ‘rect:-0.1447,51.5008,-0.1108,51.5163’), ‘circle:lon,lat,radius_meters’ (e.g., ‘circle:-0.1278,51.5074,5000’)
string
Restrict results to country (ISO 3166-1 alpha-2 code, e.g., ‘gb’, ‘us’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_MAP_MATCHINGSnap GPS traces to the road network for accurate route reconstruction. Use this tool to: - Correct GPS drift and inaccuracies in recorded tracks - Align vehicle/cycling/walking traces to actual roads - Get road names and properties along the matched route - Calculate accurate distance and travel time from GPS data

Input Parameters

string ("drive" | "walk" | "bicycle")
required
Travel mode: ‘drive’ for car, ‘walk’ for pedestrian, or ‘bicycle’ for cycling
array
required
List of GPS waypoints to snap to the road network. Provide at least 2 waypoints (up to 1000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_MAP_TILESTool to fetch raster map tiles or style JSON from Geoapify. Use when rendering custom maps with specific styles.

Input Parameters

integer
Tile column X (required when mode=‘tile’).
integer
Tile row Y (required when mode=‘tile’).
integer
Zoom level (required when mode=‘tile’).
string ("tile" | "style")
Choose ‘tile’ to fetch a raster PNG tile, or ‘style’ to fetch the style JSON.
string
required
Map style ID. E.g., ‘osm-bright’, ‘positron’, ‘dark-matter’.
string
required
Your Geoapify API key.
boolean
Whether to request high-DPI ‘@2x’ tile (only when mode=‘tile’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_MARKER_ICONGenerate custom map marker icons as PNG images. Creates customizable marker icons for use in mapping applications (Leaflet, MapLibre GL, Google Maps, etc.). Supports multiple styles (material, circle, plain), custom colors, icons from Material Design and Font Awesome libraries, or custom text/numbers. Example use cases: - Create a red location pin with a star icon - Generate numbered markers (1, 2, 3…) for route waypoints - Create custom-colored markers matching your brand

Input Parameters

string
Icon name from the selected library (e.g., ‘star’, ‘home’, ‘landmark’, ‘map-marker’). See Material Design Icons or Font Awesome v6 for available names.
integer
Total icon image height in pixels. Common values: 30, 40, 50, 80.
string
Text or number to display instead of an icon (e.g., ‘1’, ‘A’, ‘B’). Cannot be used with ‘icon’ parameter.
string ("material" | "awesome" | "circle" | "plain")
Marker style/shape type. Options: ‘material’ (pin-style), ‘awesome’ (shaped marker), ‘circle’ (round), ‘plain’ (icon only, no background). Defaults to ‘material’.
string
Background/marker color as hex code (e.g., ‘#FF5050’, ‘#3498db’). Not used for type=‘plain’.
string ("material" | "awesome" | "lucide")
Icon library to use. Options: ‘material’ (Material Design Icons), ‘awesome’ (Font Awesome v6), ‘lucide’ (Lucide icons). Defaults to match ‘type’ parameter.
boolean
Set to true to remove the default shadow from the marker.
integer
Inner icon/text size in pixels. Should be less than ‘size’. Common values: 20, 28, 35.
integer ("1" | "2")
Scale factor for high-resolution displays. Use 2 for retina/HiDPI displays.
string
Shadow color as hex code (e.g., ‘#00000080’ for semi-transparent black).
string
Border/stroke color as hex code (e.g., ‘#000000’). Not used for type=‘plain’.
string
Color of inner icon/text as hex code (e.g., ‘#FFFFFF’, ‘#4f4f4f’).
boolean
Set to true to remove the white circle background behind the icon.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_PLACE_DETAILSTool to retrieve detailed information about a specific place. Use when you have a place ID or coordinates and need comprehensive metadata.

Input Parameters

string
Place unique identifier returned by Geoapify Places or Geocoding API. Required if lat and lon are not provided.
number
Latitude of the place. Must be provided together with lon if id is omitted.
number
Longitude of the place. Must be provided together with lat if id is omitted.
string
Response language (ISO 639-1 code, two lowercase letters).
string
Comma-separated list of features to return. Defaults to details when request is by id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_PLACESSearch for points of interest (POIs) like restaurants, hotels, attractions, hospitals, etc. within a geographic area. Use this tool when you need to find places by category near a location. You must provide either a ‘filter’ (to search within a bounded area) or ‘bias’ (to rank results by proximity to a point). Common use cases: - Find restaurants near a location: categories=[‘catering.restaurant’], bias=‘proximity:lon,lat’ - Search for hotels in a city area: categories=[‘accommodation.hotel’], filter=‘circle:lon,lat,5000’ - Find wheelchair-accessible attractions: categories=[‘tourism.attraction’], conditions=[‘wheelchair’]

Input Parameters

string
Proximity bias to rank results by distance to a point. Required if ‘filter’ not provided. Format: ‘proximity:lon,lat’. Results are sorted by distance to this point.
string
ISO 639-1 language code for localized results (e.g., ‘en’, ‘de’, ‘ja’, ‘fr’).
string
Filter results to only include places matching this name (case-insensitive partial match).
integer
Maximum number of results to return (1-500). Default is 20.
string
Spatial filter to constrain search area. Required if ‘bias’ not provided. Formats: ‘circle:lon,lat,radiusMeters’ (e.g., ‘circle:13.4,52.5,1000’ for 1km radius), ‘rect:lon1,lat1,lon2,lat2’ (bounding box with SW and NE corners).
integer
Number of results to skip for pagination. Use with ‘limit’ to paginate through results.
array
required
Place category keys to search for. Common categories include: ‘catering.restaurant’, ‘catering.cafe’, ‘accommodation.hotel’, ‘tourism.attraction’, ‘tourism.sights’, ‘healthcare.hospital’, ‘commercial.supermarket’, ‘entertainment.cinema’, ‘sport.fitness’. Multiple categories can be provided to search across types.
array
Additional condition filters for accessibility or amenities, e.g., ‘wheelchair’ to filter only wheelchair-accessible places, ‘internet_access’ for places with WiFi.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_POSTCODETool to retrieve postcode information for a location. Use when you need to fetch postcode details based on a given postcode or geographic coordinates.

Input Parameters

number
Latitude of location; must be provided with lon
number
Longitude of location; must be provided with lat
string
Response language (ISO 639-1 code, 2 letters)
string ("geojson" | "json" | "xml")
Response format; one of: ‘json’, ‘geojson’, ‘xml’
string ("point" | "original")
Return geometry as ‘point’ or ‘original’ boundary
string
Postal code to search for
string
Restrict search to country (ISO 3166-1 alpha-2)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_REVERSE_GEOCODINGTool to reverse geocode coordinates into a structured address. Use when converting lat/lon to human-readable addresses.

Input Parameters

number
required
Latitude coordinate in decimal degrees.
number
required
Longitude coordinate in decimal degrees.
string
2-letter ISO 639-1 language code for the result.
string ("country" | "state" | "city" | "postcode" | "street" | "amenity")
Address level to search; one of country, state, city, postcode, street, amenity.
integer
Maximum number of results to return (default: 1).
string ("geojson" | "json" | "xml")
Response format: one of geojson, json, xml (default: geojson).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_ROUTE_MATRIXCompute travel time and distance matrices between origin and destination coordinates. Requires a Geoapify API key supplied directly in the request.

Input Parameters

string ("drive" | "light_truck" | "medium_truck" | "truck" | "heavy_truck" | "truck_dangerous_goods" | "long_truck" | "bus" | "scooter" | "motorcycle" | "bicycle" | "mountain_bike" | "road_bike" | "walk" | "hike")
Travel mode for the route calculation. Options: ‘drive’ (default), ‘walk’, ‘bicycle’, ‘truck’, etc.
string ("balanced" | "short" | "less_maneuvers")
Route type preference: ‘balanced’ (default), ‘short’ (shortest distance), ‘less_maneuvers’ (fewer turns).
array
List of road types or features to avoid. Each item specifies a type (‘tolls’, ‘highways’, ‘ferries’, ‘unpaved’) and optional importance (0.0-1.0).
string ("metric" | "imperial")
Unit system for distances: ‘metric’ (default, meters) or ‘imperial’ (miles).
string
required
Geoapify API key
array
required
List of origin waypoints (at least one required). Each waypoint has a location [longitude, latitude].
array
required
List of destination waypoints (at least one required). Each waypoint has a location [longitude, latitude].
string ("free_flow" | "approximated")
Traffic model for motorized modes: ‘free_flow’ (default, no traffic) or ‘approximated’ (estimated traffic delays).
number
Maximum vehicle speed in km/h (10-252). Limits the assumed travel speed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_ROUTE_PLANNEROptimize multi-agent routes for deliveries, pickups, and service jobs. Solves Vehicle Routing Problems (VRP) including: Travelling Salesman (TSP), Capacitated VRP, VRP with Time Windows, and Pickup-Delivery problems. Required: Either ‘jobs’ (one-way tasks) or ‘shipments’ (pickup-delivery pairs). Coordinates: Use [longitude, latitude] format (not lat/lon).

Input Parameters

array
One-way service jobs to assign. Use for simple deliveries/services. Required if shipments not provided.
string
Travel mode: ‘drive’ (car), ‘truck’, ‘bicycle’, ‘walk’, ‘transit’. Defaults to drive.
string ("balanced" | "short" | "less_maneuvers")
Route optimization: ‘balanced’ (default), ‘short’ (minimize distance), ‘less_maneuvers’ (simpler directions).
array
Roads or features to avoid: tolls, ferries, highways, or specific locations.
string ("metric" | "imperial")
Distance units in response: ‘metric’ (meters) or ‘imperial’ (miles). Defaults to metric.
array
List of agents (vehicles/workers) to assign work to. Defaults to 1 agent if omitted.
string ("free_flow" | "approximated")
Traffic model: ‘free_flow’ (no traffic) or ‘approximated’ (estimated traffic). Defaults to free_flow.
array
Reusable locations referenced by index. Useful for warehouses or depots used by multiple agents.
number
Max speed in km/h to cap travel speed calculations for driving modes.
array
Paired pickup-delivery shipments. Use when items must be picked up then delivered. Required if jobs not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GEOAPIFY_ROUTINGTool to calculate routes between multiple waypoints. Use when you need both distance, time, and turn-by-turn directions for two or more coordinates.

Input Parameters

string ("bg" | "ca" | "cs" | "da" | "de" | "el" | "en-GB" | "en" | "es" | "et" | "fi" | "fr" | "hi" | "hu" | "it" | "ja" | "nb-NO" | "nl" | "pl" | "pt-BR" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "tr" | "uk")
Language code for instructions (e.g., en, de, fr).
string ("drive" | "light_truck" | "medium_truck" | "truck" | "heavy_truck" | "truck_dangerous_goods" | "long_truck" | "bus" | "scooter" | "motorcycle" | "bicycle" | "mountain_bike" | "road_bike" | "walk" | "hike" | "transit" | "approximated_transit")
Travel mode (default: drive).
string ("balanced" | "short" | "less_maneuvers")
Route optimization: balanced (default), short, less_maneuvers. (less_maneuvers only for motorized road modes)
string
Avoid options separated by ’|’, e.g., ‘tolls|ferries:0.5|highways’.
string ("metric" | "imperial")
Distance units; metric (default) or imperial.
string ("geojson" | "json" | "xml")
Response format: geojson (default), json, xml.
string
Comma-separated extra details: instruction_details, route_details, elevation.
string ("free_flow" | "approximated")
Traffic model for motorized modes (default: free_flow).
integer
Max vehicle speed in KPH (10-252).
string
required
Two or more waypoints in ‘lat,lon’ or ‘lonlat:lon,lat’ format, pipe-separated. E.g. ‘36.734770,-76.610637|36.761226,-76.488354’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not