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

# geocodio

> Geocodio Geocoding

**Server path:** `/geocodio` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                  | Description                          |
| ----------------------------------------------------- | ------------------------------------ |
| [`geocodio_geocode_batch`](#geocodio_geocode_batch)   | Geocode batch of addresses           |
| [`geocodio_geocode_single`](#geocodio_geocode_single) | Geocode single address               |
| [`geocodio_reverse_batch`](#geocodio_reverse_batch)   | Reverse geocode batch of coordinates |
| [`geocodio_reverse_single`](#geocodio_reverse_single) | Reverse geocode single address       |

***

## geocodio\_geocode\_batch

Geocode batch of addresses

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                 |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- |
| `fields`  | string  | No       | —       | Comma-separated list of fields to append                                                    |
| `limit`   | integer | No       | —       | Optional parameter. The maximum number of results to return. The default is no limit.       |
| `body`    | object  | Yes      | —       | List of addresses to geocode. Can either be an array or an object with keys of your choice. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of fields to append"
      },
      "limit": {
        "type": "integer",
        "description": "Optional parameter. The maximum number of results to return. The default is no limit."
      },
      "body": {
        "description": "List of addresses to geocode. Can either be an array or an object with keys of your choice."
      }
    },
    "required": [
      "PCID",
      "body"
    ]
  }
  ```
</Expandable>

***

## geocodio\_geocode\_single

Geocode single address

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                  |
| ------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `q`           | string  | No       | —       | The query (i.e. address) to geocode                                                          |
| `fields`      | string  | No       | —       | Comma-separated list of fields to append                                                     |
| `street`      | string  | No       | —       | Can be used as an alternative to the `q` parameter                                           |
| `street2`     | string  | No       | —       | Can be used as an alternative to the `q` parameter                                           |
| `city`        | string  | No       | —       | Can be used as an alternative to the `q` parameter                                           |
| `county`      | string  | No       | —       | Can be used as an alternative to the `q` parameter                                           |
| `state`       | string  | No       | —       | Can be used as an alternative to the `q` parameter                                           |
| `postal_code` | string  | No       | —       | Can be used as an alternative to the `q` parameter                                           |
| `country`     | string  | No       | —       | Defaults to USA                                                                              |
| `limit`       | integer | No       | —       | Optional parameter. The maximum number of results to return. The default is no limit.        |
| `format`      | string  | No       | —       | Optional parameter to change the output format of the JSON response to a different structure |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "q": {
        "type": "string",
        "description": "The query (i.e. address) to geocode"
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of fields to append"
      },
      "street": {
        "type": "string",
        "description": "Can be used as an alternative to the `q` parameter"
      },
      "street2": {
        "type": "string",
        "description": "Can be used as an alternative to the `q` parameter"
      },
      "city": {
        "type": "string",
        "description": "Can be used as an alternative to the `q` parameter"
      },
      "county": {
        "type": "string",
        "description": "Can be used as an alternative to the `q` parameter"
      },
      "state": {
        "type": "string",
        "description": "Can be used as an alternative to the `q` parameter"
      },
      "postal_code": {
        "type": "string",
        "description": "Can be used as an alternative to the `q` parameter"
      },
      "country": {
        "type": "string",
        "description": "Defaults to USA"
      },
      "limit": {
        "type": "integer",
        "description": "Optional parameter. The maximum number of results to return. The default is no limit."
      },
      "format": {
        "type": "string",
        "description": "Optional parameter to change the output format of the JSON response to a different structure",
        "enum": [
          "simple"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## geocodio\_reverse\_batch

Reverse geocode batch of coordinates

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                           |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `fields`  | string | No       | —       | Comma-separated list of fields to append                                                              |
| `body`    | object | Yes      | —       | List of coordinates to reverse geocode. Can either be an array or an object with keys of your choice. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of fields to append"
      },
      "body": {
        "description": "List of coordinates to reverse geocode. Can either be an array or an object with keys of your choice."
      }
    },
    "required": [
      "PCID",
      "body"
    ]
  }
  ```
</Expandable>

***

## geocodio\_reverse\_single

Reverse geocode single address

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                 |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------- |
| `q`       | string | No       | —       | The query (i.e. latitude/longitude pair) to reverse geocode |
| `fields`  | string | No       | —       | Comma-separated list of fields to append                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "q": {
        "type": "string",
        "description": "The query (i.e. latitude/longitude pair) to reverse geocode"
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of fields to append"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>