NOMINATIM(1) Generated Python Manual NOMINATIM(1) (NAME) nominatim - Nominatim (SYNOPSIS) nominatim [-h] [--version] {import,freeze,replication,special- phrases,add- data,index,refresh,admin,export,convert,serve,search,reverse,lookup,details,status} ... (DESCRIPTION) Nominatim. 'cli_args' . sys.args . 'environ' Nominatim . None os.environ . (OPTIONS) --version Nominatim (AVAILABLE COMMANDS) nominatim import Nominatim OSM. nominatim freeze . nominatim replication (replication) . nominatim special-phrases (special phrases). nominatim add-data . nominatim index . nominatim refresh . nominatim admin . nominatim export CSV. nominatim convert . () nominatim serve API. nominatim search . nominatim reverse (reverse) API. nominatim lookup (lookup) API. nominatim details (details) API. nominatim status (COMMAND) 'nominatim import' : nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--osm-file FILE] [--continue {import-from-file,load-data,indexing,db-postprocess}] [--osm2pgsql-cache SIZE] [--reverse-only] [--no-partitions] [--no-updates] [--offline] [--ignore-errors] [--index-noanalyse] [--prepare-database] Nominatim OSM. Nominatim Postgresql . (superuser) . (DEFAULT ARGUMENTS) 'nominatim import' -q, --quiet -v, --verbose ( ) --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (threads) (REQUIRED ARGUMENTS) 'nominatim import' --osm-file FILE OSM ( ) --continue {import-from-file,load-data,indexing,db-postprocess} (OPTIONAL ARGUMENTS) 'nominatim import' --osm2pgsql-cache SIZE (cache) osm2pgsql ( ) --reverse-only --no-partitions ( ) --no-updates --offline .SH 'nominatim import' --ignore-errors SQL --index-noanalyse analyse ( ) --prepare-database 'nominatim freeze' : nominatim freeze [-h] [-q] [-v] [--project-dir DIR] [-j NUM] . Nominatim OpenStreetMap . (drop) (geocoding) . `--no-updates` . 'nominatim freeze' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (threads) 'nominatim replication' : nominatim replication [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--init] [--no-update-functions] [--check-for-updates] [--once] [--catch-up] [--no-index] [--osm2pgsql-cache SIZE] [--socket-timeout SOCKET_TIMEOUT] (replication) . replication OSM ( diff OSM) . OSMF replication https://planet.osm.org/replication OSM . . '--init' replication . . `--once` . 'nominatim replication' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (threads) 'nominatim replication' --init --no-update-functions (trigger function) ( ) 'nominatim replication' --check-for-updates --once . --catch-up --no-index . --once --osm2pgsql-cache SIZE (cache) osm2pgsql ( ) 'nominatim replication' --socket-timeout SOCKET_TIMEOUT (timeout) 'nominatim special-phrases' : nominatim special-phrases [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--import-from-wiki] [--import-from-csv FILE] [--no-replace] [--min MIN] . . 'Hotels in Barcelona' . OSM . CSV . : * phrase - * class - OSM * type - OSM * operator - ( : in near name -) * plural - (Y/N) Nominatim / . . building=yes . `phrase-settings.json` `--config` ..SH " (DEFAULT ARGUMENTS)" 'nominatim special-phrases' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (INPUT ARGUMENTS) 'nominatim special-phrases' --import-from-wiki OSM --import-from-csv FILE CSV --no-replace --min MIN (COMMAND) 'nominatim add-data' : nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM] (--file FILE | --diff FILE | --node ID | --way ID | --relation ID | --tiger-data DIR) [--use-main-api] [--osm2pgsql-cache SIZE] [--socket-timeout SOCKET_TIMEOUT] . . OSM OSM OSM API . . . `nominatim index` . OSM . TIGER . https://nominatim.org/release-docs/latest/customize/Tiger . (DEFAULT ARGUMENTS) 'nominatim add-data' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (SOURCE) 'nominatim add-data' --file FILE OSM diff --diff FILE diff OSM (: --file ) --node ID API --way ID API --relation ID API --tiger-data DIR TIGER (EXTRA ARGUMENTS) 'nominatim add-data' --use-main-api OSM API Overpass --osm2pgsql-cache SIZE () osm2pgsql ( ) --socket-timeout SOCKET_TIMEOUT (COMMAND) 'nominatim index' : nominatim index [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--boundaries-only] [--no-boundaries] [--minrank RANK] [--maxrank RANK] . . . . ..SH " (DEFAULT ARGUMENTS)" 'nominatim index' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (FILTER ARGUMENTS) 'nominatim index' --boundaries-only . --no-boundaries . --minrank RANK, -r RANK / --maxrank RANK, -R RANK / (COMMAND) 'nominatim refresh' : nominatim refresh [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--postcodes] [--word-tokens] [--word-counts] [--address-levels] [--functions] [--wiki-data] [--secondary-importance] [--importance] [--ro-access] [--website] [--data-object OBJECT] [--data-area OBJECT] [--no-diff-updates] [--enable-debug-statements] [--force-reimport] . . . . : 'update' 'replication' 'add-data' . (DEFAULT ARGUMENTS) 'nominatim refresh' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (DATA ARGUMENTS) 'nominatim refresh' --postcodes (centroid) --word-tokens --word-counts (full-word) --address-levels --functions PL/pgSQL --wiki-data Wikipedia/data --secondary-importance --importance ( !) --ro-access --website (DEPRECATED). . --data-object OBJECT OSM (: [NWR]) --data-area OBJECT OSM (: [NWR]) (ARGUMENTS FOR FUNCTION REFRESH) 'nominatim refresh' --no-diff-updates --enable-debug-statements .SH 'nominatim refresh' --force-reimport 'nominatim admin' : nominatim admin [-h] [-q] [-v] [--project-dir DIR] [-j NUM] (--warm | --check-database | --migrate | --analyse-indexing | --collect-os-info | --clean-deleted AGE) [--search-only] [--reverse-only] [--osm-id OSM_ID | --place-id PLACE_ID] . 'nominatim admin' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM 'nominatim admin' --warm --check-database --migrate --analyse-indexing --collect-os-info --clean-deleted AGE 'nominatim admin' --search-only --reverse-only 'nominatim admin' --osm-id OSM_ID OSM --place-id PLACE_ID Nominatim 'nominatim export' : nominatim export [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--output-type {country,state,county,city,suburb,street,path}] [--output-format OUTPUT_FORMAT] [--language LANGUAGE] [--restrict-to-country COUNTRY_CODE] [--restrict-to-osm-node ID] [--restrict-to-osm-way ID] [--restrict-to-osm-relation ID] CSV. 'nominatim export' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM 'nominatim export' --output-type {country,state,county,city,suburb,street,path} (: street) --output-format OUTPUT_FORMAT (: --output-type). : placeid,postcode --language LANGUAGE ( ) 'nominatim export' --restrict-to-country COUNTRY_CODE --restrict-to-osm-node ID OSM --restrict-to-osm-way ID OSM --restrict-to-osm-relation ID OSM.SH " (COMMAND)" 'nominatim convert' : nominatim convert [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--format {sqlite}] --output OUTPUT [--with-reverse] [--with-search] [--with-details] . () . SQLite (reverse lookup) . (OPTIONS) 'nominatim convert' --format {sqlite} ( sqlite ) --output OUTPUT, -o OUTPUT . (DEFAULT ARGUMENTS) 'nominatim convert' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM ( ) (SWITCHES TO DEFINE DATABASE LAYOUT) 'nominatim convert' --with-reverse, --without-reverse / API reverse lookup (: ) --with-search, --without-search / API search (: ) --with-details, --without-details / API details (: ) (COMMAND) 'nominatim serve' : nominatim serve [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--server SERVER] [--engine {falcon,starlette}] API. . . ! Python : falcon () starlette. Python uvicorn . : http://127.0.0.1:8088 (DEFAULT ARGUMENTS) 'nominatim serve' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (SERVER ARGUMENTS) 'nominatim serve' --server SERVER . --engine {falcon,starlette} . (: falcon) (COMMAND) 'nominatim search' : nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--query QUERY] [--amenity AMENITY] [--street STREET] [--city CITY] [--county COUNTY] [--state STATE] [--country COUNTRY] [--postalcode POSTALCODE] [--format FORMAT] [--addressdetails] [--extratags] [--entrances] [--namedetails] [--lang LANGS] [--polygon-output {geojson,kml,svg,text}] [--polygon-threshold TOLERANCE] [--countrycodes CC,..] [--exclude_place_ids ID,..] [--limit LIMIT] [--viewbox X1,Y1,X2,Y2] [--bounded] [--layer LAYER] [--no-dedupe] [--list-formats] . /search API . : https://nominatim.org/release-docs/latest/api/Search (DEFAULT ARGUMENTS) 'nominatim search' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM .SH " (QUERY ARGUMENTS)" 'nominatim search' --query QUERY --amenity AMENITY : / POI --street STREET : --city CITY : --county COUNTY : --state STATE : --country COUNTRY : --postalcode POSTALCODE : (OUTPUT FORMATTING) 'nominatim search' --format FORMAT ( --list-format ) --addressdetails --extratags ( ) --entrances --namedetails --lang LANGS, --accept-language LANGS --polygon-output {geojson,kml,svg,text} GeoJSON KML SVG WKT --polygon-threshold TOLERANCE . . (RESULT LIMITATION) 'nominatim search' --countrycodes CC,.. --exclude_place_ids ID,.. --limit LIMIT --viewbox X1,Y1,X2,Y2 --bounded viewbox --layer LAYER ( ) --no-dedupe (OTHER OPTIONS) 'nominatim search' --list-formats . (COMMAND) 'nominatim reverse' : nominatim reverse [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--lat LAT] [--lon LON] [--zoom ZOOM] [--layer LAYER] [--format FORMAT] [--addressdetails] [--extratags] [--entrances] [--namedetails] [--lang LANGS] [--polygon-output {geojson,kml,svg,text}] [--polygon-threshold TOLERANCE] [--list-formats] API. /reverse API . : https://nominatim.org/release-docs/latest/api/Reverse (DEFAULT ARGUMENTS) 'nominatim reverse' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM .SH " (QUERY ARGUMENTS)" 'nominatim reverse' --lat LAT ( WGS84) --lon LON ( WGS84) --zoom ZOOM --layer LAYER ( ) (OUTPUT FORMATTING) 'nominatim reverse' --format FORMAT ( --list-format ) --addressdetails --extratags ( ) --entrances --namedetails --lang LANGS, --accept-language LANGS --polygon-output {geojson,kml,svg,text} GeoJSON KML SVG WKT --polygon-threshold TOLERANCE . . (OTHER OPTIONS) 'nominatim reverse' --list-formats . (COMMAND) 'nominatim lookup' : nominatim lookup [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--id OSMID] [--format FORMAT] [--addressdetails] [--extratags] [--entrances] [--namedetails] [--lang LANGS] [--polygon-output {geojson,kml,svg,text}] [--polygon-threshold TOLERANCE] [--list-formats] (lookup) API. /lookup API . : https://nominatim.org/release-docs/latest/api/Lookup (DEFAULT ARGUMENTS) 'nominatim lookup' -q, --quiet -v, --verbose ( ) --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (QUERY ARGUMENTS) 'nominatim lookup' --id OSMID OSM ( ) (OUTPUT FORMATTING) 'nominatim lookup' --format FORMAT ( --list-format ) --addressdetails --extratags ( ) --entrances --namedetails --lang LANGS, --accept-language LANGS --polygon-output {geojson,kml,svg,text} GeoJSON KML SVG WKT --polygon-threshold TOLERANCE . ..SH " (OTHER OPTIONS)" 'nominatim lookup' --list-formats . (COMMAND) 'nominatim details' usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--node NODE] [--way WAY] [--relation RELATION] [--place_id PLACE_ID] [--class OBJECT_CLASS] [--format FORMAT] [--addressdetails] [--keywords] [--linkedplaces] [--entrances] [--hierarchy] [--group_hierarchy] [--polygon_geojson] [--lang LANGS] [--list-formats] API. /details API . : https://nominatim.org/release-docs/latest/api/Details (DEFAULT ARGUMENTS) 'nominatim details' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM (QUERY ARGUMENTS) 'nominatim details' --node NODE, -n NODE OSM . --way WAY, -w WAY OSM . --relation RELATION, -r RELATION OSM . --place_id PLACE_ID, -p PLACE_ID OSM --class OBJECT_CLASS . (OUTPUT ARGUMENTS) 'nominatim details' --format FORMAT ( --list-formats ) --addressdetails --keywords --linkedplaces --entrances --hierarchy --group_hierarchy --polygon_geojson --lang LANGS, --accept-language LANGS (OTHER OPTIONS) 'nominatim details' --list-formats . (COMMAND) 'nominatim status' usage: nominatim status [-h] [-q] [-v] [--project-dir DIR] [-j NUM] [--format FORMAT] [--list-formats] API. /status API . : https://nominatim.org/release-docs/latest/api/Status (DEFAULT ARGUMENTS) 'nominatim status' -q, --quiet -v, --verbose --project-dir DIR Nominatim (: /var/lib/nominatim/) -j NUM, --threads NUM .SH " API (API PARAMETERS)" 'nominatim status' --format FORMAT ( --list-formats ) (OTHER OPTIONS) 'nominatim status' --list-formats . (AUTHORS) Nominatim info@nominatim.org (DISTRIBUTION) Nominatim : Nominatim 2026-04-19 NOMINATIM(1)