Custom Connector
OpenCage Geocoding Connector
Global
The OpenCage Geocoding Connector provides access to the OpenCage REST API for geocoding and reverse geocoding. It converts addresses or place names into coordinates and transforms latitude/longitude pairs into human-readable locations, supporting JSON, XML, and GeoJSON output formats — ideal for logistics, travel apps, mapping solutions, and analytics tools.
Overview
Integration Overview
The OpenCage Connector exposes the following endpoints:
- Forward geocoding. Convert addresses or place names into geographic coordinates.
- Reverse geocoding. Convert latitude/longitude pairs into addresses and location metadata.
- GeoJSON support. Retrieve geocoding data formatted for GIS workflows.
- XML support. Retrieve geocoding data in XML format for legacy or specialized systems.
Documentation
Detailed Integration Documentation
Forward Geocoding (JSON)
| Operation ID | forwardGeocodingJson |
|---|---|
| Endpoint | /json |
| Parameters | q (string, required) – address or place name (e.g. Eiffel Tower, Paris). key (string, required) – your OpenCage API key. pretty (integer, optional, default 0) – pretty-print the response. |
| Purpose | Converts an address or place into geographic coordinates. |
| Output | JSON with coordinates, formatted address, confidence score, and other metadata. |
| Workflow example | Useful for address lookups in travel or logistics platforms. |
Reverse Geocoding (JSON)
| Operation ID | reverseGeocodingJson |
|---|---|
| Endpoint | /json |
| Parameters | q (string, required) – coordinates in lat,lon format (e.g. 40.7128,-74.0060). key (string, required) – your OpenCage API key. pretty (integer, optional, default 0). |
| Purpose | Converts latitude and longitude into a human-readable address and location data. |
| Output | JSON with address, location context, and confidence metadata. |
| Workflow example | Perfect for displaying user locations or analyzing GPS data. |
Forward Geocoding (GeoJSON)
| Operation ID | forwardGeocodingGeojson |
|---|---|
| Endpoint | /geojson |
| Parameters | q (string, required) – address or place name. key (string, required) – your OpenCage API key. |
| Purpose | Same as forward geocoding but returns data in GeoJSON format for GIS applications. |
| Output | GeoJSON object with coordinates and location metadata. |
| Workflow example | Useful for mapping or spatial analytics tools. |
Reverse Geocoding (GeoJSON)
| Operation ID | reverseGeocodingGeojson |
|---|---|
| Endpoint | /geojson |
| Parameters | q (string, required) – coordinates in lat,lon format. key (string, required) – your OpenCage API key. |
| Purpose | Reverse geocoding with GeoJSON output for spatial systems. |
| Output | GeoJSON object containing location and address data. |
| Workflow example | Enables integration with mapping libraries and GIS dashboards. |
Forward or Reverse Geocoding (XML)
| Operation ID | geocodingXml |
|---|---|
| Endpoint | /xml |
| Parameters | q (string, required) – address for forward, or lat,lon for reverse. key (string, required) – your OpenCage API key. |
| Purpose | Provides XML output for forward or reverse geocoding. |
| Output | XML document with location details. |
| Workflow example | Designed for legacy systems or XML-based integrations. |
Example Workflow: Location Finder Tool
| Look up an address | Call forwardGeocodingJson with q set to the address and your API key to obtain coordinates and a formatted address. |
|---|---|
| Resolve coordinates | Call reverseGeocodingJson with q set to lat,lon to convert a GPS position into a readable location. |
| Feed a map | Use the GeoJSON endpoints to plot results directly in a mapping library or GIS dashboard. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.