> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Geoapify

The Geoapify connector lets your AI agent act in each user's Geoapify account. Each user connects their own Geoapify API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 29 tools.

**Authentication:** API Key
**Categories:** Search, Analytics
**Tools:** 29: 25 read, 4 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=GEOAPIFY)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Geoapify connection

   In **AgentKit > Connections**, create a Geoapify connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'geoapify'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Geoapify:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'geoapify_boundaries_part_of',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "geoapify"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Geoapify:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="geoapify_boundaries_part_of",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Geoapify credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'geoapify_batch_geocode_reverse_get',
  toolInput: {
    id: '<id>',
  },
  connector: 'geoapify',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="geoapify_batch_geocode_reverse_get",
    tool_input={
        "id": "<id>",
    },
    connection_name="geoapify",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `geoapify_batch_geocode_reverse_get`

Get Batch Reverse Geocoding Results · Read-only

Get the status or results of a batch reverse geocoding job.
Returns the pending status while running, then one address per input location.
Start the job with geoapify_batch_geocode_reverse_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Batch job identifier returned by the submit endpoint. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
- `format` (`string`, optional): Batch geocode result format. Default: json. One of: `json`, `geojson`.

Example input: `{"id":"<id>"}`

### `geoapify_batch_geocode_search_get`

Get Batch Geocoding Results · Read-only

Get the status or results of a batch geocoding job.
Returns the pending status while running, then one result per input address with lat, lon and formatted address.
Start the job with geoapify_batch_geocode_search_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Batch job identifier returned by the submit endpoint. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
- `format` (`string`, optional): Batch geocode result format. Default: json. One of: `json`, `geojson`.

Example input: `{"id":"<id>"}`

### `geoapify_batch_get`

Get Batch Job Results · Read-only

Get the status or results of a generic batch job.
Returns the pending status while running, then one result per input with its params and the API response.
Start the job with geoapify_batch_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Batch job identifier returned by the submit endpoint. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.

Example input: `{"id":"<id>"}`

### `geoapify_boundaries_consists_of`

Get Sub-Boundaries · Read-only

List the boundaries one level (or more) below a boundary, such as the districts of a city.
Returns a feature for each sub-boundary with place_id, name, boundary type and optional geometry.
Get the boundary place ID from geoapify_boundaries_part_of or a geocoding result.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Geoapify place identifier returned by the Geocoding, Places, or related Geoapify APIs. This is the recommended lookup method. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
- `boundary` (`string`, optional): Boundary type to return. Default: administrative. One of: `administrative`, `postal_code`, `political`, `low_emission_zone`, `public_transport`, `traditional`, `timezone`, `religious_administration`, `religious`, `place`, `neighborhood`, `region`, `municipality`, `barony`, `town`, `health`, `historic`, `historic:administrative`.
- `geometry` (`string`, optional): Geometry representation for returned boundaries. point returns representative points and is the default. The geometry_* values return simplified Polygon or MultiPolygon geometry at the specified accuracy in meters. One of: `point`, `geometry_1000`, `geometry_5000`, `geometry_10000`.
- `lang` (`string`, optional): Language used for boundary names and address fields. Default: en.
- `sublevel` (`integer`, optional): Nested boundary depth. Default: 1.

Example input: `{"id":"<id>"}`

### `geoapify_boundaries_part_of`

Get Boundaries Containing · Read-only

List the administrative and other boundaries (city, county, state, country, postcode) that contain a location or place.
Returns a feature for each containing boundary with name, boundary type, admin level and optional geometry.
Use geoapify_boundaries_consists_of for the sub-areas of a boundary.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `boundaries` (`string`, optional): Boundary types to return. Multiple values are comma-separated. Separate multiple values with ,. Values: administrative, postal_code, political, low_emission_zone, public_transport, traditional, timezone, religious_administration, religious, place, neighborhood, region, municipality, barony, town, health, historic, historic:administrative. Example: administrative,postal_code.
- `geometry` (`string`, optional): Geometry representation for returned boundaries. point returns representative points and is the default. The geometry_* values return simplified Polygon or MultiPolygon geometry at the specified accuracy in meters. One of: `point`, `geometry_1000`, `geometry_5000`, `geometry_10000`.
- `id` (`string`, optional): Geoapify place identifier returned by the Geocoding, Places, or related Geoapify APIs. This is the recommended lookup method. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
- `lang` (`string`, optional): Language used for boundary names and address fields. Default: en.
- `lat` (`number`, optional): Latitude of the place. Alternative to id; provide together with lon and leave unset when using a place ID. Example: 52.5163.
- `lon` (`number`, optional): Longitude of the place. Alternative to id; provide together with lat and leave unset when using a place ID. Example: 13.3777.
- `osm_id` (`integer`, optional): Numeric OpenStreetMap object identifier. Alternative to id; use together with osm_type and leave unset when using a place ID. Example: 240109189.
- `osm_type` (`string`, optional): OpenStreetMap object type used with osm_id: n for node, w for way, or r for relation. One of: `r`, `w`, `n`.

Example input: `{}`

### `geoapify_elevation_get`

Get Elevation · Read-only

Get the ground elevation of up to 1,000 locations, optionally with the distance from the previous point.
Returns results in input order with elevation in meters or feet.
Use for elevation profiles along a route.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `locations` (`array`, required): Ordered input locations. Use [longitude, latitude] arrays or objects with lat and lon. Results preserve this order. Example: [[13.3777, 52.5163], [13.405, 52.52]].
- `format` (`string`, optional): Response representation. json returns a results array; geojson returns a FeatureCollection. Default: json. One of: `json`, `geojson`.
- `includeDistance` (`boolean`, optional): When true, include the distance from the previous input location. The first result has distance 0. Default: False. Example: false.
- `units` (`string`, optional): Elevation and optional distance units. Metric results use meters (m); imperial results use rounded feet (ft). Default: metric. One of: `metric`, `imperial`.

Example input: `{"locations":[{"lat":52.5163,"lon":13.3777}]}`

### `geoapify_geocode_autocomplete`

Autocomplete Address · Read-only

Suggest addresses and places for partial text, for type-ahead search.
Returns suggestions with formatted address, address parts, lat, lon and result type.
Use geoapify_geocode_search for a complete address.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `text` (`string`, required): Partial address or place name to autocomplete. Example: Potsdamer Platz, Berlin.
- `bias` (`string`, optional): Result ranking bias. Separate multiple values with ,. Example: proximity:13.3777,52.5163.
- `countrycodes` (`string`, optional): ISO 3166-1 alpha-2 country filters. Separate multiple values with ,. Example: de,at.
- `filter` (`string`, optional): Hard result filters. Separate multiple values with ,. Example: countrycode:de.
- `format` (`string`, optional): Response serialization: geojson, json, or xml. Default: geojson. One of: `json`, `geojson`.
- `lang` (`string`, optional): Result language. Default: en.
- `limit` (`integer`, optional): Maximum number of results. Example: 20.
- `type` (`string`, optional): Requested location type. Example: country. One of: `country`, `state`, `city`, `postcode`, `street`, `amenity`, `locality`.

Example input: `{"text":"<text>"}`

### `geoapify_geocode_reverse`

Reverse Geocode · Read-only

Convert latitude and longitude into the nearest address or place.
Returns the address with formatted text, street, city, postcode, country and distance from the point.
Use geoapify_geocode_search for address to coordinates.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `lat` (`number`, required): Latitude. Example location: Old Saint Stephens Church, 24 Clark Street, Boston, Massachusetts. Example: 52.5163.
- `lon` (`number`, required): Longitude for the same example location. Example: 13.3777.
- `countrycodes` (`string`, optional): ISO 3166-1 alpha-2 country filters. Separate multiple values with ,. Example: de,at.
- `format` (`string`, optional): Response format. Default: geojson. One of: `json`, `geojson`.
- `lang` (`string`, optional): Result language. Default: en.
- `limit` (`integer`, optional): Maximum number of results. Default: 1. Example: 20.
- `type` (`string`, optional): Requested result type. Example: country. One of: `country`, `state`, `city`, `postcode`, `street`, `amenity`, `locality`, `building`.

Example input: `{"lat":52.5163,"lon":13.3777}`

### `geoapify_geocode_search`

Geocode Address · Read-only

Convert a free-form or structured address into coordinates and a normalized address.
Returns matching locations with lat, lon, formatted address, address parts, result type and confidence.
Use geoapify_geocode_autocomplete for type-ahead and geoapify_geocode_reverse for coordinates to address.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `bias` (`string`, optional): Result ranking bias. Separate multiple values with ,. Example: proximity:13.3777,52.5163.
- `city` (`string`, optional): City name. Structured address input; do not use with text. Example: Berlin.
- `country` (`string`, optional): Country name. Structured address input; do not use with text. Example: Germany.
- `countrycodes` (`string`, optional): ISO 3166-1 alpha-2 country filters. Separate multiple values with ,. Example: de,at.
- `filter` (`string`, optional): Hard result filters. Separate multiple values with ,. Example: countrycode:de.
- `format` (`string`, optional): Response serialization: geojson, json, or xml. Default: geojson. One of: `json`, `geojson`.
- `housenumber` (`string`, optional): House number. Structured address input; do not use with text. Example: 1.
- `lang` (`string`, optional): Result language. Default: en.
- `limit` (`integer`, optional): Maximum number of results. Example: 20.
- `name` (`string`, optional): Place or amenity name. Structured address input; do not use with text. Example: Brandenburger Tor.
- `postcode` (`string`, optional): Postcode or ZIP code. Structured address input; do not use with text. Example: 10117.
- `state` (`string`, optional): State or region name. Structured address input; do not use with text. Example: Berlin.
- `street` (`string`, optional): Street name. Structured address input; do not use with text. Example: Pariser Platz.
- `text` (`string`, optional): Free-form address query. Alternative to the structured address parameters; do not combine them. Example: Potsdamer Platz, Berlin.
- `type` (`string`, optional): Requested location type. Example: country. One of: `country`, `state`, `city`, `postcode`, `street`, `amenity`, `locality`.

Example input: `{}`

### `geoapify_geometry_combine`

Combine Stored Geometries · Read-only

Combine two or more stored geometries or isolines by ID with union or intersection.
Returns the combined GeoJSON feature, optionally with extra details.
Store geometries with geoapify_geometry_store or create isolines with geoapify_isoline_get first.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`array`, required): IDs of two or more stored geometries or isolines to combine (from geoapify_geometry_store or geoapify_isoline_get). Example: ["a3f2029c4c2741f40782725fa0dc88be", "1a98e89ca85dcc8251211d7d83e16512"].
- `operation` (`string`, required): Required operation. union merges all input areas; intersection keeps only their common area. One of: `intersection`, `union`.
- `details` (`string`, optional): Extra datasets to add to the result, such as population. Separate multiple values with ,. Example: population.
- `format` (`string`, optional): Response encoding. The documented response schema and example describe the default GeoJSON format. Example: geojson. One of: `json`, `geojson`.

Example input: `{"id":["a3f2029c4c2741f40782725fa0dc88be","1a98e89ca85dcc8251211d7d83e16512"],"operation":"intersection"}`

### `geoapify_geometry_operation`

Run Geometry Operation · Read-only

Run a geometry operation such as length, area, buffer, union, intersection, distance, centroid, simplify or bounding box on GeoJSON geometries.
Returns the operation result: a measurement or a new GeoJSON geometry.
Use geoapify_geometry_combine to combine stored isolines or geometries by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `operation` (`string`, required): Geometry operation to run, for example length, area, buffer, union, intersection, difference, distance, centroid, bbox, simplify, contains or within. Example: area.
- `arguments` (`object`, optional): The operation's inputs as one object, using the field names Geoapify documents for that operation: geometry, geometry1/geometry2, geometries, point, polygon, line, bbox, distance, params and so on. Coordinates are GeoJSON [longitude, latitude]. Example: {"geometry": {"type": "Polygon", "coordinates": [[[13.37, 52.51], [13.39, 52.51], [13.39, 52.52], [13.37, 52.51]]]}}.

Example input: `{"operation":"<operation>"}`

### `geoapify_ip_info_get`

Get IP Location · Read-only

Look up the approximate location of an IP address, or of the caller when ip is empty.
Returns city, state, country (with ISO codes and names), continent, coordinates and the IP.
Use to localize users by IP.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `ip` (`string`, optional): IPv4 or IPv6 address. The client address is used when omitted. Example: 93.109.164.24.
- `lang` (`string`, optional): Result language. Default: en.

Example input: `{}`

### `geoapify_isoline_get`

Get Isoline · Read-only

Calculate the area reachable from a point within a travel time or distance (isochrone or isodistance) by car, truck, bike, foot or transit.
Returns a GeoJSON feature collection of reachability polygons with an id for later use, or a pending status for large ranges.
Repeat the call with the returned id to fetch a pending isoline.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `avoid` (`array`, optional): Routing features or areas to avoid. Examples include tolls, highways, ferries, location:latitude,longitude, polygon:lat,lon;lat,lon;..., and country_codes:us,ca. Example: ["tolls", "ferries"].
- `details` (`string`, optional): Extra datasets to add to every isoline feature, such as population. Separate multiple values with ,. Example: population.
- `format` (`string`, optional): Response encoding. The documented success schema and example describe the default geojson format. One of: `json`, `geojson`.
- `id` (`string`, optional): ID returned for a previously generated isoline. Use id by itself instead of the calculation parameters. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
- `lat` (`number`, optional): Origin latitude in decimal degrees. Required when calculating an isoline; omit when retrieving by id. Example: 52.5163.
- `lon` (`number`, optional): Origin longitude in decimal degrees. Required when calculating an isoline; omit when retrieving by id. Example: 13.3777.
- `max_speed` (`number`, optional): Optional maximum travel speed: 10–252 km/h with metric units or 6.5–155 mph with imperial units. Example: 80.
- `mode` (`string`, optional): Travel mode used to calculate reachability. drive represents passenger-car routing. Required when calculating. One of: `walk`, `hike`, `scooter`, `motorcycle`, `drive`, `light_truck`, `bicycle`, `mountain_bike`, `road_bike`, `bus`, `medium_truck`, `truck`, `truck_dangerous_goods`, `heavy_truck`, `long_truck`, `transit`, `approximated_transit`.
- `range` (`string`, optional): One to 10 reachability limits. Required when calculating. Values are seconds for type=time; for type=distance, values are meters with metric units or miles with imperial units. Separate multiple values with ,. Example: 900,1800.
- `route_type` (`string`, optional): Route optimization preference: balanced, shortest distance, or fewer maneuvers. Default: balanced. One of: `balanced`, `short`, `less_maneuvers`.
- `traffic` (`string`, optional): Traffic model. Use approximated to account for typical traffic where supported. Default: free_flow. One of: `free_flow`, `approximated`.
- `type` (`string`, optional): Isoline kind. Use time for an isochrone or distance for an isodistance. Required when calculating. One of: `time`, `distance`.
- `units` (`string`, optional): Unit system for distance ranges and max_speed. Metric uses meters and km/h; imperial uses miles and mph. Time ranges are always seconds. Default: metric. One of: `metric`, `imperial`.

Example input: `{}`

### `geoapify_map_match`

Match GPS Track · Read-only

Snap an ordered GPS track to the road network for a travel mode.
Returns the matched route as GeoJSON with distance, time, legs and steps, plus optional address and OSM tags per step.
Use geoapify_routing to route between points instead.

Read only: yes. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `mode` (`string`, required): Travel profile used to decide which roads can plausibly connect the GPS measurements. drive represents a passenger car. One of: `walk`, `hike`, `scooter`, `motorcycle`, `drive`, `light_truck`, `bicycle`, `mountain_bike`, `road_bike`, `bus`, `medium_truck`, `truck`, `truck_dangerous_goods`, `heavy_truck`, `long_truck`.
- `waypoints` (`array`, required): Ordered GPS measurements to match. Input order is preserved; the API does not optimize or reorder these points. Example: [{"timestamp": "2026-11-16T10:00:00Z", "location": [13.3777, 52.5163]}, {"timestamp": "2026-11-16T10:01:00Z", "location": [13.38, 52.517]}].
- `geocode_step_address` (`boolean`, optional): When true, reverse-geocodes matched route steps and adds address data. Each geocoded step adds API credit cost. Default: False. Example: false.
- `lang` (`string`, optional): Language code used for any generated address or instruction text. Default: en. One of: `en`, `de`, `es`, `fr`, `hi`, `it`, `pt`, `ru`, `sl`, `sv`, `ca`, `cs`.
- `lookup_osm_overlap` (`boolean`, optional): When true, includes OpenStreetMap overlap information for matched route steps. Each lookup step adds API credit cost. Default: False. Example: false.
- `lookup_step_osmtags` (`boolean`, optional): When true, looks up OpenStreetMap tags for matched route steps. Each lookup step adds API credit cost. Default: False. Example: false.

Example input: `{"mode":"walk","waypoints":[]}`

### `geoapify_place_details_get`

Get Place Details · Read-only

Get details of a place by Geoapify place ID, coordinates or OSM ID: contacts, opening hours, building and nearby radius features.
Returns GeoJSON features with name, address, categories, contact details, opening hours and geometry.
Get place IDs from geoapify_places_search or a geocoding result.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `features` (`string`, optional): Primary feature groups to return. Separate multiple values with |. details returns the place record and geometry, building returns the containing building, radius groups describe fixed-distance surroundings, and walk_* or drive_* groups return reachability isolines. Defaults to details. See the [feature reference](https://apidocs.geoapify.com/docs/place-details/#api). Example: details|building.
- `id` (`string`, optional): Geoapify place identifier returned by the Geocoding, Places, or related Geoapify APIs. This is the recommended lookup method; do not combine it with coordinates or OpenStreetMap identifiers. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
- `lang` (`string`, optional): Language used for names and address fields. Default: en.
- `lat` (`number`, optional): Latitude of the location to inspect. Alternative to id; provide it together with lon and leave it unset when using a place ID. Example: 52.5163.
- `lon` (`number`, optional): Longitude of the location to inspect. Alternative to id; provide it together with lat and leave it unset when using a place ID. Example: 13.3777.
- `osm_id` (`integer`, optional): Numeric OpenStreetMap object identifier. Alternative to id; use together with osm_type and leave it unset when using a place ID. Example: 240109189.
- `osm_type` (`string`, optional): OpenStreetMap object type used with osm_id: n for node, w for way, or r for relation. One of: `r`, `w`, `n`.

Example input: `{}`

### `geoapify_place_info_get`

Get Place Info · Read-only

Get information about the place or building at a location or OSM ID, including the address.
Returns the place with name, categories, address and building details.
Use geoapify_place_details_get for richer details by place ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `isBuilding` (`boolean`, optional): Whether the requested object is a building. Example: false.
- `lang` (`string`, optional): Result language. Default: en.
- `lat` (`number`, optional): Place latitude. Must be used with lon. Example: 52.5163.
- `lon` (`number`, optional): Place longitude. Must be used with lat. Example: 13.3777.
- `name` (`string`, optional): Optional place name. Example: Brandenburger Tor.
- `osm_id` (`number`, optional): OpenStreetMap object identifier. Example: 240109189.
- `osm_type` (`string`, optional): OpenStreetMap object type. One of: `r`, `w`, `n`.
- `skipAddress` (`boolean`, optional): Skip address enrichment. Example: false.

Example input: `{}`

### `geoapify_places_search`

Search Places · Read-only

Find places (points of interest) by category within an area or near a point, such as restaurants, supermarkets or charging stations.
Returns GeoJSON features with name, categories, address, coordinates and distance, with paging via limit and offset.
Use geoapify_places_search_by_geometry to search inside a custom polygon.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `categories` (`string`, required): One or more comma-separated place category keys. Categories are hierarchical: a parent category such as commercial includes its child categories. Use a more specific key, such as commercial.supermarket, to narrow the results. See the [complete category reference](https://apidocs.geoapify.com/docs/places/#categories). Separate multiple values with ,. Example: catering.restaurant.
- `bias` (`string`, optional): Ranking preference that prioritizes places without excluding other results. Supported forms are proximity:lon,lat, circle:lon,lat,radiusMeters, and rect:lon1,lat1,lon2,lat2. Provide filter, bias, or both. Example: proximity:13.3777,52.5163.
- `conditions` (`string`, optional): Optional comma-separated conditions that restrict results by place attributes. Conditions are hierarchical: a parent such as wheelchair includes its child conditions, while wheelchair.yes requests fully wheelchair-accessible places. See the [complete condition reference](https://apidocs.geoapify.com/docs/places/#conditions). Separate multiple values with ,.
- `filter` (`string`, optional): Spatial constraint that limits which places can be returned. Supported forms are circle:lon,lat,radiusMeters, rect:lon1,lat1,lon2,lat2, geometry:geometryId, place:placeId, and countrycode:code. Multiple filters can be joined with | and use AND logic. Provide filter, bias, or both. Example: countrycode:de.
- `lang` (`string`, optional): Language for names and address fields. Default: en.
- `limit` (`integer`, optional): Maximum number of places returned per page. Default: 20.
- `name` (`string`, optional): Optional place-name filter. Only places matching this name are returned. Example: Brandenburger Tor.
- `offset` (`integer`, optional): Zero-based result offset for pagination. Use with limit to request the next page. Default: 0.

Example input: `{"categories":"<categories>"}`

### `geoapify_places_search_by_geometry`

Search Places In Geometry · Read-only

Find places by category inside or near a GeoJSON geometry passed in the body, such as a polygon or isoline.
Give a filter or a bias.
Returns GeoJSON features with name, categories, address and coordinates.
Use geoapify_places_search for rectangle, circle or place-ID filters.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `categories` (`array`, required): One or more place category keys. Example: ["catering.restaurant"].
- `bias` (`object`, optional): Rank results by closeness, as an object with a type: proximity (lon, lat), circle or rect. Example: {"type": "proximity", "lon": 13.3777, "lat": 52.5163}.
- `conditions` (`array`, optional): Place-attribute conditions that results must meet, such as wheelchair.yes or internet_access. Example: ["wheelchair.yes"].
- `filter` (`object`, optional): Area to search, as one object with a type: circle (lon, lat, radius in meters), rect (lon1, lat1, lon2, lat2), polygon or polyline (a GeoJSON geometry, optional buffer in meters), geometry (a stored geometry id), place (a place id) or countrycode. Example: {"type": "circle", "lon": 13.3777, "lat": 52.5163, "radius": 1000}.
- `lang` (`string`, optional): lang Default: en.
- `limit` (`integer`, optional): limit Default: 20.
- `name` (`string`, optional): Only places whose name matches this text. Example: Starbucks.
- `offset` (`integer`, optional): offset Default: 0.

Example input: `{"categories":["catering.restaurant"]}`

### `geoapify_postcode_search`

Get Postcode · Read-only

Find the postcode area for a postcode or for coordinates.
Returns the postcode feature with postcode, city, state, country and optional geometry.
Use geoapify_postcodes_list to list postcodes in an area.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `countrycode` (`string`, optional): Optional ISO 3166-1 alpha-2 country code filter.
- `format` (`string`, optional): Response format. Default: geojson. One of: `json`, `geojson`.
- `geometry` (`string`, optional): Postcode geometry representation. Use point for centroid geometry or original for source geometry. Default: point. One of: `point`, `original`.
- `lang` (`string`, optional): Result language as a supported two-letter language code. Default: en.
- `lat` (`number`, optional): Latitude for reverse postcode search. Must be used together with lon and without postcode. Example: 52.5163.
- `lon` (`number`, optional): Longitude for reverse postcode search. Must be used together with lat and without postcode. Example: 13.3777.
- `postcode` (`string`, optional): Postcode text to search. Mutually exclusive with lat/lon coordinate search. Example: 10117.

Example input: `{}`

### `geoapify_postcodes_list`

List Postcodes · Read-only

List the postcodes in an area or matching text, with paging.
Returns postcode features with postcode, city, state, country and optional geometry.
Use geoapify_postcode_search for one postcode.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `bias` (`string`, optional): Optional result bias. Supported values include proximity:lon,lat, circle:lon,lat,radius, and rect:lon1,lat1,lon2,lat2. Multiple bias values can be repeated or separated with |. Separate multiple values with |. Example: proximity:13.3777,52.5163.
- `countrycode` (`string`, optional): Optional ISO 3166-1 alpha-2 country code filter.
- `filter` (`string`, optional): Optional spatial or place filter. Supported values include rect:lon1,lat1,lon2,lat2, circle:lon,lat,radius, and place:place_id. Multiple filters can be repeated or separated with |. Separate multiple values with |. Example: countrycode:de.
- `format` (`string`, optional): Response format. Default: geojson. One of: `json`, `geojson`.
- `geometry` (`string`, optional): Postcode geometry representation. Use point for centroid geometry or original for source geometry. Default: point. One of: `point`, `original`.
- `lang` (`string`, optional): Result language as a supported two-letter language code. Default: en.
- `limit` (`integer`, optional): Maximum number of postcode results to return. Default: 5. Example: 20.
- `offset` (`integer`, optional): Number of matching results to skip. Default: 0.
- `text` (`string`, optional): Free-text postcode query. Example: Potsdamer Platz, Berlin.

Example input: `{}`

### `geoapify_route_matrix`

Get Route Matrix · Read-only

Calculate travel time and distance between every source and every target for a travel mode.
Returns sources_to_targets, a matrix of rows (one per source) with distance and time per target.
Use geoapify_routing for the full path between two points.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `mode` (`string`, required): Travel profile used to calculate speeds, access rules, and road restrictions. drive represents a passenger car. One of: `walk`, `hike`, `scooter`, `motorcycle`, `drive`, `light_truck`, `bicycle`, `mountain_bike`, `road_bike`, `bus`, `medium_truck`, `truck`, `truck_dangerous_goods`, `heavy_truck`, `long_truck`.
- `sources` (`array`, required): Origin locations. Each source produces one row in sources_to_targets. Example: [{"location": [13.3777, 52.5163]}].
- `targets` (`array`, required): Destination locations. Each target produces one column in every sources_to_targets row. Example: [{"location": [13.405, 52.52]}, {"location": [13.43, 52.5]}].
- `avoid` (`array`, optional): Rules for what routes should avoid. Each rule has a type (tolls, ferries, highways, green_zones, transfers, locations, polygons or country_codes), an optional importance from 0 to 1, and values for locations, polygons or countries. Example: [{"type": "tolls"}, {"type": "country_codes", "values": ["ch"]}].
- `max_speed` (`number`, optional): Maximum speed for driving, truck, and bus modes. Use 10–252 km/h with units=metric, or 6.5–155 mph with units=imperial. Example: 80.
- `traffic` (`string`, optional): Traffic model for motorized modes. free_flow assumes uncongested roads; approximated reduces speeds on roads likely to be congested. Default: free_flow. One of: `free_flow`, `approximated`.
- `type` (`string`, optional): Route preference. balanced balances time and distance; short prioritizes distance; less_maneuvers penalizes turns. Default: balanced. One of: `balanced`, `short`, `less_maneuvers`.
- `units` (`string`, optional): Unit system for matrix distances. metric returns meters; imperial returns miles. Default: metric. One of: `metric`, `imperial`.

Example input: `{"mode":"walk","sources":[],"targets":[]}`

### `geoapify_route_plan`

Plan Routes · Read-only

Solve a vehicle routing problem: assign jobs and pickup-delivery shipments to agents (vehicles or workers) with time windows, capacities and skills.
Returns a feature collection with one optimized route per agent, plus unassigned jobs and shipments.
Use geoapify_routing for a single route.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agents` (`array`, required): Resources—such as vehicles or workers—to which jobs and shipments can be assigned. Example: [{"start_location": [13.3777, 52.5163], "time_windows": [[0, 28800]]}].
- `mode` (`string`, required): Travel profile used for all agent routes. drive represents passenger cars. One of: `walk`, `hike`, `scooter`, `motorcycle`, `drive`, `light_truck`, `bicycle`, `mountain_bike`, `road_bike`, `bus`, `medium_truck`, `truck`, `truck_dangerous_goods`, `heavy_truck`, `long_truck`.
- `avoid` (`array`, optional): Rules for what routes should avoid. Each rule has a type (tolls, ferries, highways, green_zones, transfers, locations, polygons or country_codes), an optional importance from 0 to 1, and values for locations, polygons or countries. Example: [{"type": "tolls"}, {"type": "country_codes", "values": ["ch"]}].
- `jobs` (`array`, optional): Independent service or delivery tasks. At least one job or shipment is required. Example: [{"location": [13.405, 52.52], "duration": 300}].
- `locations` (`array`, optional): Reusable locations that agents, jobs and shipments can point to by zero-based location_index, each with a location [longitude, latitude] and optional id. At most 300 unique coordinates per call. Example: [{"id": "warehouse", "location": [13.3777, 52.5163]}].
- `max_speed` (`number`, optional): Maximum speed for driving, truck, and bus modes. Use 10–252 km/h with units=metric, or 6.5–155 mph with units=imperial. Example: 80.
- `shipments` (`array`, optional): Paired pickup-delivery tasks. Pickup always precedes delivery and both are assigned to the same agent. Example: [{"id": "order-1", "pickup": {"location": [13.38, 52.51], "duration": 120}, "delivery": {"location": [13.43, 52.5], "duration": 120}}].
- `traffic` (`string`, optional): Traffic model for motorized modes. free_flow assumes uncongested roads; approximated accounts for likely congestion. Default: free_flow. One of: `free_flow`, `approximated`.
- `type` (`string`, optional): Route preference used for agent travel. balanced balances time and distance; short prioritizes distance; less_maneuvers penalizes turns. Default: balanced. One of: `balanced`, `short`, `less_maneuvers`.
- `units` (`string`, optional): Unit system for returned route distances. metric returns meters; imperial returns miles. Default: metric. One of: `metric`, `imperial`.

Example input: `{"agents":[],"mode":"walk"}`

### `geoapify_routing`

Get Route · Read-only

Calculate a route through two or more waypoints for a travel mode (drive, truck, bicycle, walk, transit and more), optionally optimizing the stop order.
Returns the route as GeoJSON with distance, time, legs and turn-by-turn steps.
Use geoapify_route_matrix for many-to-many travel times and geoapify_route_plan for multi-vehicle planning.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `mode` (`string`, required): Travel profile used to calculate speeds, access rules, and road restrictions. drive represents a passenger car. One of: `walk`, `hike`, `scooter`, `motorcycle`, `drive`, `light_truck`, `bicycle`, `mountain_bike`, `road_bike`, `bus`, `medium_truck`, `truck`, `truck_dangerous_goods`, `heavy_truck`, `long_truck`, `transit`, `approximated_transit`.
- `waypoints` (`string`, required): Ordered route points. Use latitude,longitude for each point (latitude from -90 to 90; longitude from -180 to 180) and separate points with |. At least two waypoints are required. Separate multiple values with |. Example: {'timestamp': '2026-11-16T10:00:00Z', 'location': [13.3777, 52.5163]}|{'timestamp': '2026-11-16T10:01:00Z', 'location': [13.38, 52.517]}.
- `avoid` (`string`, optional): Road features, locations, polygons, or countries to avoid. Separate multiple rules with |. An optional importance from 0 to 1 can follow road-feature rules, for example tolls:0.8. Separate multiple values with |. Example: tolls|ferries.
- `details` (`string`, optional): Additional result data. instruction_details adds maneuver metadata; route_details adds road attributes; elevation adds the elevation profile; admin_areas adds country and state metadata and administrative area crossings. polyline5 and polyline6 add encoded geometry to the route properties and every leg without replacing the GeoJSON geometry.
- `format` (`string`, optional): Response representation. geojson returns a GeoJSON FeatureCollection; json returns route objects with {lon, lat} geometry points; xml returns the JSON structure serialized as XML. Default: geojson. One of: `json`, `geojson`.
- `intermediate_waypoint_mode` (`string`, optional): Treatment of intermediate waypoints. stopover splits the route into independent legs; through_stop splits it into legs while preserving travel direction; pass_through treats it as a via point without creating a new leg. Default: stopover. One of: `stopover`, `through_stop`, `pass_through`.
- `lang` (`string`, optional): Language code for human-readable turn-by-turn instructions. Example: en. One of: `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`.
- `max_speed` (`number`, optional): Maximum speed for driving, truck, and bus modes. Use 10–252 km/h with units=metric, or 6.5–155 mph with units=imperial. Example: 80.
- `optimize_stops` (`boolean`, optional): Whether to optimize the order of intermediate waypoints. The first and last waypoints remain fixed. Default: False. Example: false.
- `traffic` (`string`, optional): Traffic model for motorized modes. free_flow assumes uncongested roads; approximated reduces speeds on roads likely to be congested. Default: free_flow. One of: `free_flow`, `approximated`.
- `type` (`string`, optional): Route preference. balanced balances time and distance; short prioritizes distance; less_maneuvers penalizes turns and is supported only for motorized road modes. Default: balanced. One of: `balanced`, `short`, `less_maneuvers`.
- `units` (`string`, optional): Unit system for distances in the response. metric returns meters; imperial returns miles. Default: metric. One of: `metric`, `imperial`.

Example input: `{"mode":"walk","waypoints":"<waypoints>"}`

### `geoapify_timezone_get`

Get Timezone · Read-only

Get the time zone at a location, optionally at a given moment.
Returns the time zone name, abbreviation, UTC and DST offsets and the local time.
Use geoapify_timezone_transitions_list for DST change dates.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `lat` (`number`, required): Latitude. Example: 52.5163.
- `lon` (`number`, required): Longitude. Example: 13.3777.
- `at` (`string`, optional): RFC 3339 instant with an offset. Defaults to now. Example: 2026-11-16T12:00:00Z.

Example input: `{"lat":52.5163,"lon":13.3777}`

### `geoapify_timezone_transitions_list`

List Timezone Transitions · Read-only

List the UTC offset transitions (such as daylight saving changes) of the time zone at a location within a period.
Returns the time zone and its transitions with dates and new offsets.
Use geoapify_timezone_get for the current offset.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, required): Inclusive RFC 3339 start instant. Example: 2026-01-01T00:00:00Z.
- `lat` (`number`, required): Latitude. Example: 52.5163.
- `lon` (`number`, required): Longitude. Example: 13.3777.
- `to` (`string`, required): Exclusive RFC 3339 end instant. Example: 2027-01-01T00:00:00Z.

Example input: `{"from":"<from>","lat":52.5163,"lon":13.3777,"to":"<to>"}`

### `geoapify_batch_create`

Start Batch Job · Write

Start an asynchronous batch job that runs one Geoapify API (for example routing, isoline or place details) for many inputs at reduced cost.
Returns the job id and status.
Poll geoapify_batch_get with the id for results; use the batch geocoding tools for addresses.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `api` (`string`, required): Geoapify API path to run for each input, for example /v1/routing, /v1/isoline or /v2/place-details. Example: /v1/routing. One of: `/v1/isoline`, `/v1/routing`, `/v1/places`, `/v1/geometry`, `/v1/geocode/search`, `/v1/geocode/reverse`, `/v1/mapmatching`, `/v2/places`, `/v2/place-info`, `/v2/place-details`, `/v1/ipinfo`, `/v1/routeplanner`, `/v1/routematrix`, `/v1/boundaries/part-of`, `/v1/boundaries/consists-of`, `/v1/boundaries/near-by`, `/v1/boundaries/parent-of`.
- `inputs` (`array`, required): One entry per call to run, 1 to 1,000. Each has an optional id and the params (query parameters) and/or body for that call, which are merged with the shared params and body. Example: [{"id": "1", "params": {"waypoints": "52.5163,13.3777|52.52,13.405"}}].
- `body` (`object`, optional): JSON body shared by all inputs, for batch APIs that take a POST body (for example route matrix). Example: {"mode": "drive"}.
- `params` (`object`, optional): Request-level query parameters applied to all batch inputs. Example: {"mode": "drive"}.
- `priority` (`number`, optional): Processing priority and credit-cost factor. Use 0.5 to spend 50% of the normal credits when longer processing is acceptable, or 1 to spend the full credits for faster processing. Values between 0.5 and 1 balance the discount and processing speed. Default: 0.5.

Example input: `{"api":"/v1/isoline","inputs":[{"id":"1","params":{"waypoints":"52.5163,13.3777|52.52,13.405"}}]}`

### `geoapify_batch_geocode_reverse_create`

Start Batch Reverse Geocoding · Write

Start an asynchronous job that reverse geocodes up to 1,000 coordinates at once (batch pricing).
Returns the job id and status; results are not ready immediately.
Poll geoapify_batch_geocode_reverse_get with the id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `locations` (`array`, required): Coordinates to reverse geocode, 1 to 1,000, each as an object with lat and lon. Example: [{"lat": 52.5163, "lon": 13.3777}].
- `countrycodes` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country code filters. Example: de,at.
- `lang` (`string`, optional): Result language as a supported two-letter language code. Example: en.
- `priority` (`number`, optional): Optional batch processing priority factor. Example: 0.5.
- `type` (`string`, optional): Optional reverse geocoding result type filter. Example: country. One of: `country`, `state`, `city`, `postcode`, `street`, `amenity`, `locality`, `building`.

Example input: `{"locations":[{"lat":52.5163,"lon":13.3777}]}`

### `geoapify_batch_geocode_search_create`

Start Batch Geocoding · Write

Start an asynchronous job that geocodes up to 1,000 addresses at once (batch pricing).
Returns the job id and status; results are not ready immediately.
Poll geoapify_batch_geocode_search_get with the id until the results come back.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `addresses` (`array`, required): Free-text addresses or place queries to geocode, 1 to 1,000. Example: ["668 Cedar St, San Carlos, CA 94070", "Potsdamer Platz, Berlin"].
- `bias` (`string`, optional): Optional geocoding bias expression. Example: proximity:13.3777,52.5163.
- `countrycodes` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country code filters. Example: de,at.
- `filter` (`string`, optional): Optional geocoding filter expression. Example: countrycode:de.
- `lang` (`string`, optional): Result language as a supported two-letter language code. Example: en.
- `lat` (`number`, optional): Latitude for an optional geocoding bias. Must be used together with lon. Example: 52.5163.
- `lon` (`number`, optional): Longitude for an optional geocoding bias. Must be used together with lat. Example: 13.3777.
- `priority` (`number`, optional): Optional batch processing priority factor. Example: 0.5.
- `text` (`string`, optional): Default text query applied with request-level parameters. Example: Potsdamer Platz, Berlin.
- `type` (`string`, optional): Optional result type filter. Example: country. One of: `country`, `state`, `city`, `postcode`, `street`, `amenity`, `locality`.

Example input: `{"addresses":["668 Cedar St, San Carlos, CA 94070","Potsdamer Platz, Berlin"]}`

### `geoapify_geometry_store`

Store Geometry · Write

Store a GeoJSON geometry, feature or feature collection on Geoapify so it can be combined by ID.
Returns the stored geometry's id.
Combine stored geometries with geoapify_geometry_combine.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `geojson` (`object`, required): GeoJSON Geometry, Feature or FeatureCollection to store, coordinates as [longitude, latitude]. Example: {"type": "Feature", "properties": {}, "geometry": {"type": "Point", "coordinates": [13.4, 52.5]}}.

Example input: `{"geojson":{}}`

## Related

Other Search connectors ([all 89](/agentkit/connectors/?category=search)):

- [Supadata](/agentkit/connectors/supadata/): Scalekit connector, API key, 21 tools
- [Exa](/agentkit/connectors/exa/): Scalekit connector, API key, 21 tools
- [Brave Search](/agentkit/connectors/brave/): Scalekit connector, API key, 18 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
