--- description: Capacitor plugin for handling geocoding and reverse geocoding with cross-platform support and high performance. title: Capacitor Geocoder Plugin for Android, iOS & Web - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/geocoder.png --- [ Skip to content](#capawesome-teamcapacitor-geocoder) [ 🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode.](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * Geocoder [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm or Yarn ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) # @capawesome-team/capacitor-geocoder[¶](#capawesome-teamcapacitor-geocoder "Permanent link") Capacitor plugin for handling geocoding and reverse geocoding. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[¶](#features "Permanent link") We are proud to offer one of the most complete and feature-rich Capacitor plugins for geocoding and reverse geocoding. Here are some of the key features: * 🖥️ **Cross-platform**: Supports Android, iOS and Web. * 📍 **Geocoding**: Convert addresses into geographic coordinates. * 🗺️ **Reverse Geocoding**: Convert geographic coordinates into human-readable addresses. * 🌐 **Multiple Providers**: Support for Google Maps and OpenStreetMap on Web. * 🌍 **Localization**: Customize the locale for geocoding requests. * 🔢 **Configurable Results**: Limit the number of addresses returned in reverse geocoding operations. * 🛠️ **Native APIs**: Uses platform-native geocoding services on Android and iOS for reliable and accurate results. * 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * 🔁 **Up-to-date**: Always supports the latest Capacitor version. * ⭐️ **Support**: Priority support from the Capawesome Team. * ✨ **Handcrafted**: Built from the ground up with care and expertise, not forked or AI-generated. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 0.1.x | 7.x.x | Deprecated | ## Demo[¶](#demo "Permanent link") | Android | iOS | Web | | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | ![Android Demo](https://capawesome.io/docs/assets/images/gifs/capacitor-geocoder-android.gif) | ![iOS Demo](https://capawesome.io/docs/assets/images/gifs/capacitor-geocoder-ios.gif) | ![Web Demo](https://capawesome.io/docs/assets/images/gifs/capacitor-geocoder-web.gif) | ## Installation[¶](#installation "Permanent link") This plugin is only available to [Capawesome Insiders](https://capawesome.io/insiders/). First, make sure you have the Capawesome npm registry set up. You can do this by running the following commands: `[](#%5F%5Fcodelineno-0-1)npm config set @capawesome-team:registry https://npm.registry.capawesome.io [](#%5F%5Fcodelineno-0-2)npm config set //npm.registry.capawesome.io/:_authToken ` **Attention**: Replace `` with the license key you received from Polar. If you don't have a license key yet, you can get one by becoming a [Capawesome Insider](https://capawesome.io/insiders/). Next, you can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-1-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-2-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome-team/capacitor-geocoder` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-3-1)npm install @capawesome-team/capacitor-geocoder universal-geocoder [](#%5F%5Fcodelineno-3-2)npx cap sync ` ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-4-1)import { Geocoder } from '@capawesome-team/capacitor-geocoder'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const geocode = async () => { [](#%5F%5Fcodelineno-4-4) const result = await Geocoder.geocode({ [](#%5F%5Fcodelineno-4-5) address: '1600 Amphitheatre Parkway, Mountain View, CA', [](#%5F%5Fcodelineno-4-6) }); [](#%5F%5Fcodelineno-4-7) console.log('Geocode result:', result); [](#%5F%5Fcodelineno-4-8)}; [](#%5F%5Fcodelineno-4-9) [](#%5F%5Fcodelineno-4-10)const geodecode = async () => { [](#%5F%5Fcodelineno-4-11) const result = await Geocoder.geodecode({ [](#%5F%5Fcodelineno-4-12) latitude: 37.422, [](#%5F%5Fcodelineno-4-13) longitude: -122.084, [](#%5F%5Fcodelineno-4-14) }); [](#%5F%5Fcodelineno-4-15) console.log('Geodecode result:', result); [](#%5F%5Fcodelineno-4-16)}; ` ## API[¶](#api "Permanent link") * [geocode(...)](#geocode) * [geodecode(...)](#geodecode) * [Interfaces](#interfaces) ### geocode(...)[¶](#geocode "Permanent link") `[](#%5F%5Fcodelineno-5-1)geocode(options: GeocodeOptions) => Promise ` Translate an address into geographic coordinates. Only available on Android and iOS. | Param | Type | | ----------- | --------------------------------- | | **options** | [GeocodeOptions](#geocodeoptions) | **Returns:** `Promise<[GeocodeResult](#geocoderesult)>` **Since:** 0.0.1 --- ### geodecode(...)[¶](#geodecode "Permanent link") `[](#%5F%5Fcodelineno-6-1)geodecode(options: GeodecodeOptions) => Promise ` Translate geographic coordinates into a human-readable address. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------------- | | **options** | [GeodecodeOptions](#geodecodeoptions) | **Returns:** `Promise<[GeodecodeResult](#geodecoderesult)>` **Since:** 0.0.1 --- ### Interfaces[¶](#interfaces "Permanent link") #### GeocodeResult[¶](#geocoderesult "Permanent link") | Prop | Type | Description | Since | | ------------- | ------ | --------------------------------------- | ----- | | **latitude** | number | The latitude of the geocoded location. | 0.0.1 | | **longitude** | number | The longitude of the geocoded location. | 0.0.1 | #### GeocodeOptions[¶](#geocodeoptions "Permanent link") | Prop | Type | Description | Default | Since | | ---------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------- | ----- | | **address** | string | The address to geocode. | 0.0.1 | | | **locale** | string | The locale (BCP 47 language tag) to use for the geocoding request. By default, the device's locale is used. | 0.0.1 | | | **webApiKey** | string | The API key to use for the geocoding service. Only available on Web. | 0.0.1 | | | **webProvider** | 'googlemaps' \| 'openstreetmaps' | The provider to use for the geocoding service. Only available on Web. | 'openstreetmaps' | 0.0.1 | | **webUserAgent** | string | The User-Agent identifying your application. Only available on the web. | 0.0.1 | | #### GeodecodeResult[¶](#geodecoderesult "Permanent link") | Prop | Type | Description | Since | | ------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------ | ----- | | **addresses** | Address\[\] | The list of addresses that match the given coordinates. The number of addresses returned is limited by the limit option. | 0.0.1 | #### Address[¶](#address "Permanent link") | Prop | Type | Description | Since | | ---------------- | ---------- | ---------------------------------------------------------------- | ----- | | **adminArea** | string | The administrative area (e.g. state or province) of the address. | 0.0.1 | | **addressLines** | string\[\] | The lines of the address. | 0.0.1 | | **countryCode** | string | The country code of the address. | 0.0.1 | | **countryName** | string | The name of the country. | 0.0.1 | | **phoneNumber** | string | The phone number of the address. | 0.0.1 | | **postalCode** | string | The postal code of the address. | 0.0.1 | | **subAdminArea** | string | The sub-administrative area (e.g. county) of the address. | 0.0.1 | | **url** | string | The URL of the address. | 0.0.1 | #### GeodecodeOptions[¶](#geodecodeoptions "Permanent link") | Prop | Type | Description | Default | Since | | ---------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----- | | **latitude** | number | The latitude of the location to reverse geocode. | 0.0.1 | | | **limit** | number | The maximum number of results to return. | 5 | 0.0.1 | | **longitude** | number | The longitude of the location to reverse geocode. | 0.0.1 | | | **webApiKey** | string | The API key to use for the geocoding service. Only available on Web. | 0.0.1 | | | **webProvider** | 'googlemaps' \| 'openstreetmaps' | The provider to use for the geocoding service. Only available on Web. | 'openstreetmaps' | 0.0.1 | | **webUserAgent** | string | The User-Agent identifying your application. Only needed if webProvider is set to openstreetmaps which uses the Nominatim service (see https://operations.osmfoundation.org/policies/nominatim/). The goal is to be able to limit the number of requests per application. Only available on the web. | 0.0.1 | | ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/geocoder/CHANGELOG.md). ## Breaking Changes[¶](#breaking-changes "Permanent link") See [BREAKING.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/geocoder/BREAKING.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/geocoder/LICENSE). May 17, 2026 Back to top