{"id":20980884,"url":"https://github.com/cap-go/capacitor-nativegeocoder","last_synced_at":"2026-06-05T00:01:15.963Z","repository":{"id":45463941,"uuid":"508654246","full_name":"Cap-go/capacitor-nativegeocoder","owner":"Cap-go","description":"Capacitor plugin for native forward and reverse geocoding","archived":false,"fork":false,"pushed_at":"2025-05-06T18:44:00.000Z","size":1087,"stargazers_count":28,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-09T17:45:43.646Z","etag":null,"topics":["android","capacitor","capacitor-plugin","geocoding","swift"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2022-06-29T10:58:40.000Z","updated_at":"2025-05-07T22:19:49.000Z","dependencies_parsed_at":"2023-02-19T04:30:42.672Z","dependency_job_id":"bbf43392-4b75-4b39-8f76-950617bc6f43","html_url":"https://github.com/Cap-go/capacitor-nativegeocoder","commit_stats":{"total_commits":183,"total_committers":5,"mean_commits":36.6,"dds":0.6284153005464481,"last_synced_commit":"cc9594b474c2f58a0a70edd877c814b083ba3b92"},"previous_names":[],"tags_count":182,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-nativegeocoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-nativegeocoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-nativegeocoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-nativegeocoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-nativegeocoder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254171621,"owners_count":22026476,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","capacitor","capacitor-plugin","geocoding","swift"],"created_at":"2024-11-19T05:31:06.662Z","updated_at":"2026-06-05T00:01:15.956Z","avatar_url":"https://github.com/Cap-go.png","language":"Java","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":[],"sub_categories":[],"readme":"# @capgo/capacitor-nativegeocoder\n\u003ca href=\"https://capgo.app/\"\u003e\u003cimg src=\"https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-nativegeocoder\" alt=\"Capgo - Instant updates for Capacitor\" /\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_nativegeocoder\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_nativegeocoder\"\u003e Missing a feature? We’ll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\nCapacitor plugin for native forward and reverse geocoding\n\n## Documentation\n\nThe most complete doc is available here: https://capgo.app/docs/plugins/nativegeocoder/\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ---------- |\n| v8.\\*.\\*       | v8.\\*.\\*                | ✅          |\n| v7.\\*.\\*       | v7.\\*.\\*                | On demand   |\n| v6.\\*.\\*       | v6.\\*.\\*                | ❌          |\n| v5.\\*.\\*       | v5.\\*.\\*                | ❌          |\n\n\u003e **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-nativegeocoder\nnpx cap sync\n```\n\nthen import this into your code:\n\n```javascript\nimport { NativeGeocoder } from '@capgo/capacitor-nativegeocoder';\n```\n\n## iOS\n\nApple requires privacy descriptions to be specified in `Info.plist` for location information:\n\n- `NSLocationAlwaysAndWhenInUseUsageDescription` (`Privacy - Location Always Usage Description`)\n- `NSLocationWhenInUseUsageDescription` (`Privacy - Location When In Use Usage Description`)\n\nRead about [Configuring `Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) in the [iOS Guide](https://capacitorjs.com/docs/ios) for more information on setting iOS permissions in Xcode\nThe IOS implementation require internet\n\n## Android\n\nThis API requires the following permissions be added to your `AndroidManifest.xml`:\n\n```xml\n\u003c!-- Geolocation API --\u003e\n\u003cuses-permission android:name=\"android.permission.ACCESS_COARSE_LOCATION\" /\u003e\n\u003cuses-permission android:name=\"android.permission.ACCESS_FINE_LOCATION\" /\u003e\n\u003cuses-feature android:name=\"android.hardware.location.gps\" /\u003e\n```\n\n## Web\n\nThis API requires a Google API key to be set in the `apiKey` field of the `ForwardOptions` or `ReverseOptions` interfaces.\n\nThere is no way to use this plugin on the web without a Google API key.\n\nThe return data is limited to the data available from the native API on the device, as example `formatted_address` is not available in web implementation, as it's not available in the native API.\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`reverseGeocode(...)`](#reversegeocode)\n* [`forwardGeocode(...)`](#forwardgeocode)\n* [`getPluginVersion()`](#getpluginversion)\n* [Interfaces](#interfaces)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### reverseGeocode(...)\n\n```typescript\nreverseGeocode(options: ReverseOptions) =\u003e Promise\u003c{ addresses: Address[]; }\u003e\n```\n\nConvert latitude and longitude to an address\n\n| Param         | Type                                                      |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#reverseoptions\"\u003eReverseOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ addresses: Address[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.0.1\n\n--------------------\n\n\n### forwardGeocode(...)\n\n```typescript\nforwardGeocode(options: ForwardOptions) =\u003e Promise\u003c{ addresses: Address[]; }\u003e\n```\n\nConvert an address to latitude and longitude\n\n| Param         | Type                                                      |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#forwardoptions\"\u003eForwardOptions\u003c/a\u003e\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ addresses: Address[]; }\u0026gt;\u003c/code\u003e\n\n**Since:** 0.0.1\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003c{ version: string; }\u003e\n```\n\nGet the native Capacitor plugin version\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ version: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### Interfaces\n\n\n#### Address\n\n| Prop                        | Type                  |\n| --------------------------- | --------------------- |\n| **`latitude`**              | \u003ccode\u003enumber\u003c/code\u003e   |\n| **`longitude`**             | \u003ccode\u003enumber\u003c/code\u003e   |\n| **`countryCode`**           | \u003ccode\u003estring\u003c/code\u003e   |\n| **`countryName`**           | \u003ccode\u003estring\u003c/code\u003e   |\n| **`postalCode`**            | \u003ccode\u003estring\u003c/code\u003e   |\n| **`administrativeArea`**    | \u003ccode\u003estring\u003c/code\u003e   |\n| **`subAdministrativeArea`** | \u003ccode\u003estring\u003c/code\u003e   |\n| **`locality`**              | \u003ccode\u003estring\u003c/code\u003e   |\n| **`subLocality`**           | \u003ccode\u003estring\u003c/code\u003e   |\n| **`thoroughfare`**          | \u003ccode\u003estring\u003c/code\u003e   |\n| **`subThoroughfare`**       | \u003ccode\u003estring\u003c/code\u003e   |\n| **`areasOfInterest`**       | \u003ccode\u003estring[]\u003c/code\u003e |\n\n\n#### ReverseOptions\n\n| Prop                | Type                 | Description                                                              |\n| ------------------- | -------------------- | ------------------------------------------------------------------------ |\n| **`latitude`**      | \u003ccode\u003enumber\u003c/code\u003e  | latitude is a number representing the latitude of the location.          |\n| **`longitude`**     | \u003ccode\u003enumber\u003c/code\u003e  | longitude is a number representing the longitude of the location.        |\n| **`useLocale`**     | \u003ccode\u003eboolean\u003c/code\u003e | Localise the results to the given locale.                                |\n| **`defaultLocale`** | \u003ccode\u003estring\u003c/code\u003e  | locale is a string in the format of language_country, for example en_US. |\n| **`maxResults`**    | \u003ccode\u003enumber\u003c/code\u003e  | Max number of results to return.                                         |\n| **`apiKey`**        | \u003ccode\u003estring\u003c/code\u003e  | Only used for web platform to use google api                             |\n| **`resultType`**    | \u003ccode\u003estring\u003c/code\u003e  | Only used for web platform to use google api                             |\n\n\n#### ForwardOptions\n\n| Prop                | Type                 | Description                                                              |\n| ------------------- | -------------------- | ------------------------------------------------------------------------ |\n| **`addressString`** | \u003ccode\u003estring\u003c/code\u003e  | address is a string of the address to be geocoded.                       |\n| **`useLocale`**     | \u003ccode\u003eboolean\u003c/code\u003e | Localise the results to the given locale.                                |\n| **`defaultLocale`** | \u003ccode\u003estring\u003c/code\u003e  | locale is a string in the format of language_country, for example en_US. |\n| **`maxResults`**    | \u003ccode\u003enumber\u003c/code\u003e  | Max number of results to return.                                         |\n| **`apiKey`**        | \u003ccode\u003estring\u003c/code\u003e  | Only used for web platform to use google api                             |\n\n\u003c/docgen-api\u003e\n\n## Thanks\nTo [@sebastianbaar](https://github.com/sebastianbaar) and his work on [cordova-plugin-nativegeocoder](https://github.com/sebastianbaar/cordova-plugin-nativegeocoder) what he made was very inspiring\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-nativegeocoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-go%2Fcapacitor-nativegeocoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-nativegeocoder/lists"}