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.
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
Prepare the OpenCage account or service that the workflow will access. Grant access to the required resources and operations.
API Key: Copy the 32-character key from the Geocoding API tab in your OpenCage dashboard.
Set up in StackAI
Open Settings → Connections, add a connection, and select OpenCage.
Enter the credentials and connection details in the fields below.
Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.
Connection fields
API Key
Yes
Copy the 32-character key from the Geocoding API tab in your OpenCage dashboard. Provider instructions.
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
Add the required OpenCage action to the workflow.
Select a connection when the action requests one.
Complete the required fields. Use the reference picker when a value comes from another workflow step.
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
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
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
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
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
UN/LOCODE
string
Yes
Five-character UN location code to look up.
Outputs
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
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
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
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
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.
Last updated
Was this helpful?

