# @prior-it/geocoding

> Modern TypeScript library that allows geocoding and reverse geocoding through the OpenStreetMaps Nominatim API

Latest version **1.0.8** (published 2024-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @prior-it/geocoding
pnpm add @prior-it/geocoding
yarn add @prior-it/geocoding
bun add @prior-it/geocoding
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2024-01-18 |
| First published | 2023-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Robin Arys |
| Maintainers | rarys |
| Keywords | nomimatim, gis, osm, open, street, map, openstreetmap, geocoding, geocode, reverse, reversegeocoding, coordinates, location |

## Links

- npm: https://www.npmjs.com/package/@prior-it/geocoding
- Repository: https://github.com/Prior-IT/geocoding-ts
- Homepage: https://github.com/Prior-IT/geocoding-ts#readme
- Issues: https://github.com/Prior-IT/geocoding-ts/issues
- npm.io page: https://npm.io/package/@prior-it/geocoding

## Recent versions

- 1.0.8 (latest) — 2024-01-18
- 1.0.7 — 2024-01-18
- 1.0.6 — 2023-05-10
- 1.0.5 — 2023-05-10
- 1.0.4 — 2023-05-10
- 1.0.3 — 2023-05-08
- 1.0.2 — 2023-05-08
- 1.0.1 — 2023-05-08

## README

# Geocoding

Modern TypeScript library that allows geocoding and reverse geocoding through the OpenStreetMap Nominatim API

## Installation:
Install using your favourite package manager:

```
npm install @prior-it/geocoding
```

```
pnpm add @prior-it/geocoding
```

```
yarn add @prior-it/geocoding
```

## Requirements:
This library will only work with NodeJS 18 or later.


## Usage:

```ts
import { Geocoding } from "@prior-it/geocoding";

// Regular queries
const response = await Geocoding.search("prior-it hq", { fullAddress: true });
console.log(response.display_name);

// Reverse geocoding
const response = await Geocoding.reverse(51.0195611619683, 3.68261385663317, { zoomlevel: 18 });
console.log(response.address.name);
```

---
_Source: https://npm.io/package/@prior-it/geocoding · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._