Aviato: Geocoder Search

Search for a location and get geocoded matches.

Tool ID: aviato_geocoder_search

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'aviato_geocoder_search',
  {
    "text": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute aviato_geocoder_search --input '{
  "text": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": [
    {
      "id": 123,
      "name": "Example",
      "placetype": "example",
      "languageDefaulted": true,
      "geom": {
        "bbox": "example",
        "lat": 123,
        "lon": 123
      }
    }
  ]
}

Use deepline describe aviato_geocoder_search --json for the latest machine-readable contract.

Input reference

Allows you to search for a specific location, and returns a list of potential geocoded matches. If you are performing a people/company search, we highly recommend using the Geocoded ID of the location you intend to search for, and filtering by “locationIDList” contains {geocoded_id}.

Name	Type	Required	Default	Details
`payload.text`	`string`	Yes	—	—
`payload.limit`	`integer`	No	—	—
`payload.lang`	`string`	No	—	—

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`array`	Yes	—	Provider response payload.
`result.data[].id`	`integer`	Yes	—	—
`result.data[].name`	`string`	Yes	—	—
`result.data[].placetype`	`string`	Yes	—	—
`result.data[].population`	`integer`	No	—	—
`result.data[].languageDefaulted`	`boolean`	Yes	—	—
`result.data[].country`	`object`	No	—	—
`result.data[].country.id`	`integer`	Yes	—	—
`result.data[].country.name`	`string`	Yes	—	—
`result.data[].country.abbr`	`string`	Yes	—	—
`result.data[].country.languageDefaulted`	`boolean`	Yes	—	—
`result.data[].region`	`object`	No	—	—
`result.data[].region.id`	`integer`	Yes	—	—
`result.data[].region.name`	`string`	Yes	—	—
`result.data[].region.abbr`	`string`	No	—	—
`result.data[].region.languageDefaulted`	`boolean`	Yes	—	—
`result.data[].locality`	`object`	No	—	—
`result.data[].locality.id`	`integer`	Yes	—	—
`result.data[].locality.name`	`string`	Yes	—	—
`result.data[].locality.languageDefaulted`	`boolean`	Yes	—	—
`result.data[].geom`	`object`	Yes	—	—
`result.data[].geom.area`	`number`	No	—	Format: `double`.
`result.data[].geom.bbox`	`string`	Yes	—	—
`result.data[].geom.lat`	`number`	Yes	—	Format: `double`.
`result.data[].geom.lon`	`number`	Yes	—	Format: `double`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0.02 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation