{"ok":true,"site":"nominatim-openstreetmap","host":"nominatim.openstreetmap.org","about":"Nominatim (OpenStreetMap geocoder): search places by free text or structured address, reverse-geocode coordinates, fetch full place details by OSM id, and check server/data status.","commands":[{"command":"search-places","summary":"Free-text geocoding search for places, addresses or POIs by name. Returns matching OSM objects with coordinates.","params":[{"name":"q","type":"string","required":true,"description":"Free-text query, e.g. a place name, address or landmark"},{"name":"api_limit","type":"number","description":"Maximum number of results (1-40, server default 10) (sent to the site as \"limit\"; clify's own --limit only shapes the output)"},{"name":"countrycodes","type":"string","description":"Comma-separated ISO 3166-1 alpha-2 country codes to restrict results to, e.g. us or de,at"},{"name":"accept_language","type":"string","description":"Preferred language(s) for result names, e.g. en or de,en"},{"name":"layer","type":"string","description":"Restrict results to a thematic layer (comma-separated allowed)","oneOf":["address","poi","railway","natural","manmade"]},{"name":"exclude_place_ids","type":"string","description":"Comma-separated places already shown, to get the next page of results. Format: OSM type letter plus OSM id (N/W/R + osm_id), e.g. W518071791,R126326"},{"name":"addressdetails","type":"boolean","description":"Include a broken-down address object (house_number, road, city, postcode, country...) per result"},{"name":"polygon_geojson","type":"boolean","description":"Include the full GeoJSON outline of each result. This can be very large."}],"exampleUrl":"https://clify-dev.netlify.app/nominatim-openstreetmap/search-places?q=Brandenburg+Gate+Berlin&api_limit=5&countrycodes=us&accept_language=en&layer=address&exclude_place_ids=W518071791"},{"command":"search-structured","summary":"Structured address/POI search using separate fields (amenity, street, city, county, state, country, postalcode). Can be restricted to a bounding box.","params":[{"name":"amenity","type":"string","description":"Name or type of POI, e.g. cafe"},{"name":"street","type":"string","description":"House number and street name, e.g. 10 Downing Street"},{"name":"city","type":"string","description":"City / town name"},{"name":"county","type":"string","description":"County name"},{"name":"state","type":"string","description":"State / province name"},{"name":"country","type":"string","description":"Country name or code"},{"name":"postalcode","type":"string","description":"Postal code"},{"name":"viewbox","type":"string","description":"Preferred search area as lon1,lat1,lon2,lat2 (two corners), e.g. 2.33,48.86,2.37,48.84"},{"name":"bounded","type":"boolean","description":"With viewbox: only return results inside the box"},{"name":"dedupe","type":"boolean","description":"Merge duplicate results such as multiple segments of the same street. Server default is true. Set to false to keep all."},{"name":"polygon_threshold","type":"number","description":"Simplification tolerance in degrees for returned polygons, e.g. 0.01"},{"name":"api_limit","type":"number","description":"Maximum number of results (1-40) (sent to the site as \"limit\"; clify's own --limit only shapes the output)"},{"name":"countrycodes","type":"string","description":"Comma-separated ISO country codes to restrict results"},{"name":"accept_language","type":"string","description":"Preferred language(s) for names, e.g. en"},{"name":"exclude_place_ids","type":"string","description":"Comma-separated places already shown (N/W/R + osm_id), for the next page"},{"name":"addressdetails","type":"boolean","description":"Include a broken-down address object per result"},{"name":"polygon_geojson","type":"boolean","description":"Include GeoJSON outlines (can be large)"}],"exampleUrl":"https://clify-dev.netlify.app/nominatim-openstreetmap/search-structured?amenity=cafe&street=10+Downing+Street&city=London&country=United+Kingdom&postalcode=75004&viewbox=2.33%2C48.86%2C2.37%2C48.84&polygon_threshold=0.01"},{"command":"get-place-details","summary":"Get full details of an OSM place by type and id: names, extratags (wikidata, population, website), address hierarchy, linked places, centroid. Optionally includes child places or search keywords.","params":[{"name":"osmtype","type":"string","required":true,"description":"OSM object type: N=node, W=way, R=relation","oneOf":["N","W","R"]},{"name":"osmid","type":"number","required":true,"description":"OSM object id (osm_id from search results)"},{"name":"class","type":"string","description":"OSM class/category to pick when an object has several (category from search results), e.g. boundary"},{"name":"hierarchy","type":"boolean","description":"Include child places that have this place as parent","default":false},{"name":"keywords","type":"boolean","description":"Include the name and address search keywords indexed for this place"},{"name":"polygon_geojson","type":"boolean","description":"Include the full geometry as GeoJSON (can be large)"}],"exampleUrl":"https://clify-dev.netlify.app/nominatim-openstreetmap/get-place-details?osmtype=R&osmid=2027202&class=boundary"},{"command":"reverse-geocode","summary":"Reverse geocode a latitude/longitude to the nearest OSM object and its address, at a chosen detail level (zoom).","params":[{"name":"lat","type":"number","required":true,"description":"Latitude in WGS84 decimal degrees"},{"name":"lon","type":"number","required":true,"description":"Longitude in WGS84 decimal degrees"},{"name":"zoom","type":"number","description":"Address detail level 0-18: 3=country, 5=state, 8=county, 10=city, 12=town/borough, 14=suburb, 16=major street, 17=street, 18=building","default":18},{"name":"layer","type":"string","description":"Restrict to a thematic layer","oneOf":["address","poi","railway","natural","manmade"]},{"name":"accept_language","type":"string","description":"Preferred language(s) for names, e.g. en"},{"name":"polygon_geojson","type":"boolean","description":"Include the GeoJSON outline of the result (can be large)"}],"exampleUrl":"https://clify-dev.netlify.app/nominatim-openstreetmap/reverse-geocode?lat=43.29882129999999&lon=-72.4817747&zoom=18"},{"command":"get-status","summary":"Check Nominatim server status, software/database version and when the OSM data was last updated.","params":[],"exampleUrl":"https://clify-dev.netlify.app/nominatim-openstreetmap/get-status"}]}