# @capgo/capacitor-nativegeocoder

Turn coordinates into addresses and addresses into coordinates from your Capacitor app with the native geocoders on iOS and Android.

<a href="https://capgo.app/?ref=plugin_nativegeocoder"><img src="https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-nativegeocoder" alt="Capgo - Build Capacitor apps with AI, ship updates instantly" /></a>

<div align="center">
  <p><b>Capgo</b>: push fixes to your Capacitor users in minutes, build signed iOS and Android apps without a Mac, and roll back in one click.</p>
  <h2><a href="https://capgo.app/register/?ref=plugin_nativegeocoder">➡️ Get started for free</a></h2>
  <p>14-day unlimited free trial. No credit card required</p>
</div>

> 🤖 **Building with an AI coding agent?** Install [Capgo skills](https://capgo.app/skills/?ref=plugin_nativegeocoder) so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use `@capgo/capacitor-nativegeocoder` in your Capacitor app: `npx skills add Cap-go/capgo-skills`. Then ask your agent: *"Add @capgo/capacitor-nativegeocoder to my Capacitor app and wire it up."* [Agent setup guides](https://capgo.app/agents/?ref=plugin_nativegeocoder) · [Hosted MCP](https://capgo.app/docs/ai/mcp/?ref=plugin_nativegeocoder)

<p align="center">
  <img src="https://raw.githubusercontent.com/Cap-go/capacitor-nativegeocoder/main/assets/github-social-preview.png" alt="@capgo/capacitor-nativegeocoder for Capacitor apps" width="300" />
</p>

## Key features

- **Reverse geocoding**: `reverseGeocode()` converts latitude and longitude to street, city, postal code and country.
- **Forward geocoding**: `forwardGeocode()` converts an address to coordinates.
- **Localized results**: `useLocale` and `defaultLocale` on iOS and Android. Web uses `defaultLocale` for the request language.
- **Result limit**: `maxResults` caps the number of matches.
- **Platforms**: iOS, Android and Web. iOS uses Core Location, Android uses `Geocoder`. Web calls the Google Geocoding API with your `apiKey`.

## Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/nativegeocoder/

## Compatibility

| Plugin version | Capacitor compatibility | Maintained |
| -------------- | ----------------------- | ---------- |
| v8.\*.\*       | v8.\*.\*                | ✅          |
| v7.\*.\*       | v7.\*.\*                | On demand   |
| v6.\*.\*       | v6.\*.\*                | ❌          |
| v5.\*.\*       | v5.\*.\*                | ❌          |

> **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.

## Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

Then use the following prompt:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-nativegeocoder` plugin in my project.
```

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

```bash
npm install @capgo/capacitor-nativegeocoder
npx cap sync
```

then import this into your code:

```javascript
import { NativeGeocoder } from '@capgo/capacitor-nativegeocoder';
```

## iOS

Apple requires privacy descriptions to be specified in `Info.plist` for location information:

- `NSLocationAlwaysAndWhenInUseUsageDescription` (`Privacy - Location Always Usage Description`)
- `NSLocationWhenInUseUsageDescription` (`Privacy - Location When In Use Usage Description`)

Read 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
The IOS implementation require internet

## Android

This API requires the following permissions be added to your `AndroidManifest.xml`:

```xml
<!-- Geolocation API -->
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-feature android:name="android.hardware.location.gps" />
```

## Web

This API requires a Google API key to be set in the `apiKey` field of the `ForwardOptions` or `ReverseOptions` interfaces.

There is no way to use this plugin on the web without a Google API key.

The 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.

## API

<docgen-index>

* [`reverseGeocode(...)`](#reversegeocode)
* [`forwardGeocode(...)`](#forwardgeocode)
* [`getPluginVersion()`](#getpluginversion)
* [Interfaces](#interfaces)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### reverseGeocode(...)

```typescript
reverseGeocode(options: ReverseOptions) => Promise<{ addresses: Address[]; }>
```

Convert latitude and longitude to an address

| Param         | Type                                                      |
| ------------- | --------------------------------------------------------- |
| **`options`** | <code><a href="#reverseoptions">ReverseOptions</a></code> |

**Returns:** <code>Promise&lt;{ addresses: Address[]; }&gt;</code>

**Since:** 0.0.1

--------------------


### forwardGeocode(...)

```typescript
forwardGeocode(options: ForwardOptions) => Promise<{ addresses: Address[]; }>
```

Convert an address to latitude and longitude

| Param         | Type                                                      |
| ------------- | --------------------------------------------------------- |
| **`options`** | <code><a href="#forwardoptions">ForwardOptions</a></code> |

**Returns:** <code>Promise&lt;{ addresses: Address[]; }&gt;</code>

**Since:** 0.0.1

--------------------


### getPluginVersion()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

Get the native Capacitor plugin version

**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>

--------------------


### Interfaces


#### Address

| Prop                        | Type                  |
| --------------------------- | --------------------- |
| **`latitude`**              | <code>number</code>   |
| **`longitude`**             | <code>number</code>   |
| **`countryCode`**           | <code>string</code>   |
| **`countryName`**           | <code>string</code>   |
| **`postalCode`**            | <code>string</code>   |
| **`administrativeArea`**    | <code>string</code>   |
| **`subAdministrativeArea`** | <code>string</code>   |
| **`locality`**              | <code>string</code>   |
| **`subLocality`**           | <code>string</code>   |
| **`thoroughfare`**          | <code>string</code>   |
| **`subThoroughfare`**       | <code>string</code>   |
| **`areasOfInterest`**       | <code>string[]</code> |


#### ReverseOptions

| Prop                | Type                 | Description                                                              |
| ------------------- | -------------------- | ------------------------------------------------------------------------ |
| **`latitude`**      | <code>number</code>  | latitude is a number representing the latitude of the location.          |
| **`longitude`**     | <code>number</code>  | longitude is a number representing the longitude of the location.        |
| **`useLocale`**     | <code>boolean</code> | Localise the results to the given locale.                                |
| **`defaultLocale`** | <code>string</code>  | locale is a string in the format of language_country, for example en_US. |
| **`maxResults`**    | <code>number</code>  | Max number of results to return.                                         |
| **`apiKey`**        | <code>string</code>  | Only used for web platform to use google api                             |
| **`resultType`**    | <code>string</code>  | Only used for web platform to use google api                             |


#### ForwardOptions

| Prop                | Type                 | Description                                                              |
| ------------------- | -------------------- | ------------------------------------------------------------------------ |
| **`addressString`** | <code>string</code>  | address is a string of the address to be geocoded.                       |
| **`useLocale`**     | <code>boolean</code> | Localise the results to the given locale.                                |
| **`defaultLocale`** | <code>string</code>  | locale is a string in the format of language_country, for example en_US. |
| **`maxResults`**    | <code>number</code>  | Max number of results to return.                                         |
| **`apiKey`**        | <code>string</code>  | Only used for web platform to use google api                             |

</docgen-api>

## Thanks
To [@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