Geocoding

Search Nominatim places

Searches OpenStreetMap places by address. Pass either free-text q or structured fields (street, city, county, state, country, postalcode), not both. limit defaults to 10 and is clamped to 20; countrycodes restricts by ISO 3166-1 alpha-2 country. Each result has its display name, coordinates, category, type, bounding box, importance and address parts. No match returns 404.

get/geocoding/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/geocoding/search
  • Auth: API key in header x-api-key

Query parameters

qstring

Free-text search query

streetstring

Structured street or house number

citystring

Structured city

countystring

Structured county

statestring

Structured state

countrystring

Structured country

postalcodestring

Structured postal code

limitinteger

Maximum results, defaults to 10 and clamps to 20

countrycodesstring

Comma-separated ISO 3166-1 alpha-2 country filters

accept_languagestring

Preferred result language, forwarded to Nominatim

addressdetailsboolean

Include address details, defaults to true

extratagsboolean

Include OSM extra tags

namedetailsboolean

Include multilingual name details

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "query": "Empire State Building",
    "results": [
      {
        "address": {
          "ISO3166-2-lvl4": "US-NY",
          "city": "New York",
          "country": "United States",
          "country_code": "us",
          "county": "New York County",
          "house_number": "350",
          "neighbourhood": "Koreatown",
          "office": "Empire State Building",
          "postcode": "10118",
          "road": "5th Avenue",
          "state": "New York",
          "suburb": "Manhattan"
        },
        "addresstype": "office",
        "boundingbox": [
          "40.7479255",
          "40.7489585",
          "-73.9865012",
          "-73.9848166"
        ],
        "category": "office",
        "display_name": "Empire State Building, 350, 5th Avenue, New York, United States",
        "importance": 0.5803438355141769,
        "lat": "40.7484421",
        "licence": "Data © OpenStreetMap contributors, ODbL 1.0. http://osm.org/copyright",
        "lon": "-73.9856589",
        "name": "Empire State Building",
        "osm_id": 34633854,
        "osm_type": "way",
        "place_id": 358220252,
        "place_rank": 30,
        "type": "yes"
      }
    ]
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.