> ## 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: Inputs, Cost & CLI Example

> Allows you to search for a specific location, and returns a list of potential geocoded matches. Includes inputs, outputs, costs, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=aviato_geocoder_search:{"text":"{{text}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name            | Type      | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ----------- |
| `payload.text`  | `string`  | Yes      |         |             |
| `payload.limit` | `integer` | No       |         |             |
| `payload.lang`  | `string`  | No       |         |             |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `array`  | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute aviato_geocoder_search --payload '{
  "text": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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