> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/opencage.md).

# OpenCage

Forward and reverse geocode places, narrow searches geographically, and look up UN/LOCODE logistics locations.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| OpenCage  | API Key        |

#### OpenCage

Connect with an OpenCage API key to forward and reverse geocode places, restrict searches geographically, and look up UN/LOCODEs.

**Set up in OpenCage**

1. Prepare the OpenCage account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Copy the 32-character key from the Geocoding API tab in your OpenCage dashboard.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **OpenCage**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                 |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Copy the 32-character key from the Geocoding API tab in your OpenCage dashboard. [Provider instructions](https://opencagedata.com/dashboard). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **OpenCage** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Forward geocode

Find coordinates and address details for an address or place.

**Inputs**

| Field              | Type    | Required | Description                                       |
| ------------------ | ------- | -------- | ------------------------------------------------- |
| Address or place   | string  | Yes      | Address or place to locate.                       |
| Result limit       | integer | No       | Maximum matching locations to return. Default: 5. |
| Preferred language | string  | No       | Preferred language for formatted results.         |

**Outputs**

| Field             | Type          | Description                                              |
| ----------------- | ------------- | -------------------------------------------------------- |
| Geocoding results | object\_array | Matching locations with coordinates and address details. |
| Licenses          | object\_array | Data licenses returned by OpenCage.                      |

#### Reverse geocode

Find the nearest address or place for coordinates.

**Inputs**

| Field              | Type   | Required | Description                                  |
| ------------------ | ------ | -------- | -------------------------------------------- |
| Latitude           | number | Yes      | North-south coordinate from -90 through 90.  |
| Longitude          | number | Yes      | East-west coordinate from -180 through 180.  |
| Preferred language | string | No       | Preferred language for the returned address. |

**Outputs**

| Field                     | Type          | Description                                   |
| ------------------------- | ------------- | --------------------------------------------- |
| Reverse geocoding results | object\_array | Nearest address or place for the coordinates. |
| Licenses                  | object\_array | Data licenses returned by OpenCage.           |

#### Look up UN/LOCODE

Look up a logistics location by its UN/LOCODE.

**Inputs**

| Field     | Type   | Required | Description                                 |
| --------- | ------ | -------- | ------------------------------------------- |
| UN/LOCODE | string | Yes      | Five-character UN location code to look up. |

**Outputs**

| Field            | Type          | Description                                           |
| ---------------- | ------------- | ----------------------------------------------------- |
| UN/LOCODE result | object        | Location and transport function details for the code. |
| Licenses         | object\_array | Data licenses returned by OpenCage.                   |

#### Geocode within a country

Find an address or place while restricting results to one country.

**Inputs**

| Field              | Type    | Required | Description                                           |
| ------------------ | ------- | -------- | ----------------------------------------------------- |
| Address or place   | string  | Yes      | Address or place to find within the selected country. |
| Country code       | string  | Yes      | Two-letter country code used to restrict results.     |
| Result limit       | integer | No       | Maximum matching locations to return. Default: 5.     |
| Preferred language | string  | No       | Preferred language for formatted results.             |

**Outputs**

| Field                      | Type          | Description                                      |
| -------------------------- | ------------- | ------------------------------------------------ |
| Country-restricted results | object\_array | Matching locations within the requested country. |
| Licenses                   | object\_array | Data licenses returned by OpenCage.              |

#### Geocode within a bounding box

Find an address or place while restricting results to a bounding box.

**Inputs**

| Field              | Type    | Required | Description                                       |
| ------------------ | ------- | -------- | ------------------------------------------------- |
| Address or place   | string  | Yes      | Address or place to find inside the bounding box. |
| Minimum longitude  | number  | Yes      | Longitude of the southwest corner.                |
| Minimum latitude   | number  | Yes      | Latitude of the southwest corner.                 |
| Maximum longitude  | number  | Yes      | Longitude of the northeast corner.                |
| Maximum latitude   | number  | Yes      | Latitude of the northeast corner.                 |
| Result limit       | integer | No       | Maximum matching locations to return. Default: 5. |
| Preferred language | string  | No       | Preferred language for formatted results.         |

**Outputs**

| Field                | Type          | Description                                           |
| -------------------- | ------------- | ----------------------------------------------------- |
| Bounding-box results | object\_array | Matching locations inside the requested bounding box. |
| Licenses             | object\_array | Data licenses returned by OpenCage.                   |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/opencage.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
