Skip to main content

A tool for building a database of OpenStreetMap for geocoding and for searching the database. Search library.

Project description

Nominatim - Frontend Library

Nominatim is a tool to search OpenStreetMap data by name and address (geocoding) and to generate synthetic addresses of OSM points (reverse geocoding).

This module implements the library for searching a Nominatim database imported with the nominatim-db package.

Installation

To install the Nominatim API from pypi, run:

pip install nominatim-api

Running a Nominatim server

You need Falcon or Starlette to run Nominatim as a service, as well as an ASGI-capable server like uvicorn. To install them from pypi run:

pip install falcon uvicorn

You need to have a Nominatim database imported with the 'nominatim-db' package. Go to the project directory, then run uvicorn as:

uvicorn --factory nominatim_api.server.falcon.server:run_wsgi

Documentation

The full documentation for the Nominatim library can be found at: https://nominatim.org/release-docs/latest/library/Getting-Started/

The v1 API of the server is documented at: https://nominatim.org/release-docs/latest/api/Overview/

License

The source code is available under a GPLv3 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nominatim_api-5.3.1.tar.gz (365.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nominatim_api-5.3.1-py3-none-any.whl (525.2 kB view details)

Uploaded Python 3

File details

Details for the file nominatim_api-5.3.1.tar.gz.

File metadata

  • Download URL: nominatim_api-5.3.1.tar.gz
  • Upload date:
  • Size: 365.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nominatim_api-5.3.1.tar.gz
Algorithm Hash digest
SHA256 5c31a93e66499c6d09de5e79f6bb08d9e0d19270089c49c898ba73ba207a613d
MD5 6028b7901ab74583701fe45d858b18af
BLAKE2b-256 11c4d6a267b1ec6b5872004885a0c9c0cbfcc3bdb3495f6583376432239d32a8

See more details on using hashes here.

File details

Details for the file nominatim_api-5.3.1-py3-none-any.whl.

File metadata

  • Download URL: nominatim_api-5.3.1-py3-none-any.whl
  • Upload date:
  • Size: 525.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nominatim_api-5.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6b3267f79961a68fb9ba33d0f8653933cc33754ddd5d5257591cefaa6bc879d
MD5 ff79e575745fb444ff47e35c4e9d704c
BLAKE2b-256 79af70caecf31b804657b312931048d3d5baa3a7f5d9296dbda654334820a593

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page