Geoapify

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

Language code (ISO 639-1, 2 letters, e.g., 'en')

Partial address text to autocomplete

Restrict suggestions by location type

Maximum number of results to return, must be >= 1

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

Response format; one of: 'geojson' (default), 'json', 'xml'

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Batch job ID. Provide to retrieve status and results; omit to create a new job.

API path to call. Supported values: /v1/geocode/search, /v1/geocode/reverse, /v1/routing, /v1/isoline.

Common JSON body for all inputs, e.g., routing mode.

Array of input objects; up to 1000 elements when creating a job.

Common query parameters for all inputs, e.g., language code.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Place ID from Geometry or Places API. Mutually exclusive with lat and lon.

Latitude of the location. Required with lon if id is omitted.

Longitude of the location. Required with lat if id is omitted.

Language code for results (ISO 639-1).

Level of geometry detail to return.

Type of boundary to retrieve.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

City name for structured address search

Result language (ISO 639-1 2-letter code, e.g., 'en')

Amenity or place name for structured address search

Free-form address to search, e.g., 'Berlin, Germany'

Location type filter. Allowed: country, state, city, postcode, street, amenity, locality

Maximum number of results to return (default 5)

State or province for structured address search

Geoapify API key

Location filters. Formats: 'circle:lon,lat,radiusMeters', 'rect:lon1,lat1,lon2,lat2', 'countrycode:code1,code2', 'place:placeId'. Combine multiple with '|' for AND logic.

Response format. One of: geojson (default), json, xml

Street name for structured address search

Country name for structured address search

Postal code or ZIP for structured address search

House number for structured address search

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

List of at least two geometry IDs to combine or intersect.

Geometric operation to apply. Must be 'union' or 'intersection'.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

IP address to lookup; if omitted, uses the caller's IP.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Unique identifier of previously generated isoline (valid 24h). Exclusive with lat/lon/type/mode/range.

Latitude of the origin point in decimal degrees. Required for new calculation.

Longitude of the origin point in decimal degrees. Required for new calculation.

Travel mode for route calculation. Required for new calculation.

Isoline type: 'time' (seconds) or 'distance' (meters). Required for new calculation.

Avoid rules separated by '|', e.g. tolls or ferries.

Isoline range(s): seconds for time or meters for distance. Supply single int or list for multiple.

Units for distance calculations. Default metric.

Traffic model (motorized modes only). Default free_flow.

Vehicle max speed in KPH (10-252). Applies to drive/truck/bus modes.

Route optimization. Default balanced.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Travel mode: drive, walk, or bicycle

Geoapify API key

List of GPS waypoints to match (1 to 1000 points)

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Tile column X (required when mode='tile').

Tile row Y (required when mode='tile').

Zoom level (required when mode='tile').

Choose 'tile' to fetch a raster PNG tile, or 'style' to fetch the style JSON.

Map style ID. E.g., 'osm-bright', 'positron', 'dark-matter'.

Your Geoapify API key.

Whether to request high-DPI '@2x' tile (only when mode='tile').

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Inner icon name per the selected library.

Total icon image height in pixels.

Text to display instead of an icon.

Marker style/shape. Defaults to 'material' if not specified.

Background color; ignored for type='plain'; must be URL-encoded, '#' as '%23'.

Icon library; defaults to match 'type'.

Flag to disable default shadow.

Inner icon/text height in pixels.

Shadow color; must be URL-encoded, '#' as '%23'.

Border color; ignored for type='plain'; must be URL-encoded, '#' as '%23'.

Color of inner icon/text; must be URL-encoded, '#' as '%23'.

Flag to remove the white circle.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Place unique identifier returned by Geoapify Places or Geocoding API. Required if `lat` and `lon` are not provided.

Latitude of the place. Must be provided together with `lon` if `id` is omitted.

Longitude of the place. Must be provided together with `lat` if `id` is omitted.

Response language (ISO 639-1 code, two lowercase letters).

Comma-separated list of features to return. Defaults to `details` when request is by `id`.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Proximity bias toward a location: 'proximity:lon,lat'.

Response language code (ISO 639-1), e.g., 'en'.

Return only places matching this name.

Maximum number of results per page. Must be >= 1.

Spatial filter to constrain the search area. Formats: 'circle:lon,lat,radiusMeters', 'rect:lon1,lat1,lon2,lat2', 'geometry:geometryId', 'place:placeId', 'countrycode:code1,code2' (coming soon).

Start index for pagination; use with limit. Must be >= 0.

Primary place category keys (comma-separated).

Additional filters such as accessibility/amenities (comma-separated).

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Latitude of location; must be provided with lon

Longitude of location; must be provided with lat

Response language (ISO 639-1 code, 2 letters)

Response format; one of: 'json', 'geojson', 'xml'

Return geometry as 'point' or 'original' boundary

Postal code to search for

Restrict search to country (ISO 3166-1 alpha-2)

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Latitude coordinate in decimal degrees.

Longitude coordinate in decimal degrees.

2-letter ISO 639-1 language code for the result.

Address level to search; one of country, state, city, postcode, street, amenity.

Maximum number of results to return (default: 1).

Response format: one of geojson, json, xml (default: geojson).

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Travel mode; see Routing API Travel Modes

Route type; default 'balanced'

Road types or areas to avoid (see Routing API avoid options)

Units for distance; default 'metric'

Geoapify API key

List of origin waypoints

List of destination waypoints

Traffic model; motorized modes only; default 'free_flow'

Maximum vehicle speed in KPH (10-252)

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

One-way jobs to assign

Travel mode (e.g., drive, bicycle, walk)

Route optimization preference

Avoid rules objects as per Route Planner API

Distance units

List of agents (vehicles/workers)

Traffic model

Reusable locations for indexing

Max speed km/h for driving modes

Paired pickups/deliveries to assign

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Language code for instructions (e.g., en, de, fr).

Travel mode (default: drive).

Route optimization: balanced (default), short, less_maneuvers. (less_maneuvers only for motorized road modes)

Avoid options separated by '|', e.g., 'tolls|ferries:0.5|highways'.

Distance units; metric (default) or imperial.

Response format: geojson (default), json, xml.

Comma-separated extra details: instruction_details, route_details, elevation.

Traffic model for motorized modes (default: free_flow).

Max vehicle speed in KPH (10-252).

Two or more waypoints in 'lat,lon' or 'lonlat:lon,lat' format, pipe-separated. E.g. '36.734770,-76.610637|36.761226,-76.488354'

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not