> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Aviato: Geocoder Search

> Search for a location and get geocoded matches. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Search for a location and get geocoded matches.

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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 | — | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "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}.",
    "properties": {
      "text": {
        "type": "string"
      },
      "limit": {
        "type": "integer"
      },
      "lang": {
        "type": "string"
      }
    },
    "required": [
      "text"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "name": {
              "type": "string"
            },
            "placetype": {
              "type": "string"
            },
            "population": {
              "type": "integer"
            },
            "languageDefaulted": {
              "type": "boolean"
            },
            "country": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "abbr": {
                  "type": "string"
                },
                "languageDefaulted": {
                  "type": "boolean"
                }
              },
              "required": [
                "id",
                "name",
                "abbr",
                "languageDefaulted"
              ],
              "additionalProperties": false
            },
            "region": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "abbr": {
                  "type": "string"
                },
                "languageDefaulted": {
                  "type": "boolean"
                }
              },
              "required": [
                "id",
                "name",
                "languageDefaulted"
              ],
              "additionalProperties": false
            },
            "locality": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "languageDefaulted": {
                  "type": "boolean"
                }
              },
              "required": [
                "id",
                "name",
                "languageDefaulted"
              ],
              "additionalProperties": false
            },
            "geom": {
              "type": "object",
              "properties": {
                "area": {
                  "type": "number",
                  "format": "double"
                },
                "bbox": {
                  "type": "string"
                },
                "lat": {
                  "type": "number",
                  "format": "double"
                },
                "lon": {
                  "type": "number",
                  "format": "double"
                }
              },
              "required": [
                "bbox",
                "lat",
                "lon"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "id",
            "name",
            "placetype",
            "languageDefaulted",
            "geom"
          ],
          "additionalProperties": false
        }
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Aviato provider guide](https://deepline.com/docs/providers/aviato/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.