Skip to content

Geocoder

API calls to search address and location using geocoder.

Geocoder types

  • google.
  • yandex.
  • progorod.
  • osm.
  • locationiq.

API actions

API path: /geocoder.

search_address

Performs a forward geocoding. Returns a list of locations matching the given address. Items in the list sorted by relevance.

Parameters

name description type format
q Address (or place) or coordinates to geocode. string/location "750 Avenue E,San Francisco,CA 94130,USA"
geocoder Optional. Geocoder type that will be preferably used for searching. Google geocoder is always used for users with the premium GIS. enum "google"
bounds Optional. JSON object. The bounding box, specified by coordinates of northwest and southeast corners. Geocoder will preferably return results from within these bounds. That is the parameter influences the priority of results, so if more relevant results exist outside of bounds, they may be included. bounds_object {"nw":{"lat":37.9,"lng":-122.4},"se":{"lat":37.8,"lng":-122.3}}
lang Optional. Language in which results should be. ISO 639 language code. enum "en_US"
with_details Optional. If true then the response will contain details. boolean true

Example

curl -X POST 'https://api.navixy.com/v2/geocoder/search_address' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "q": "750 Avenue E,San Francisco,CA 94130,USA", "lang": "en", "geocoder": "google"}'

Response

{
    "success": true,
    "locations": [{
            "lat": 37.825014712963565,
            "lng": -122.37202062079945,
            "address": "750 Avenue E,San Francisco",
            "details": {
              "country": "USA",
              "province": "CA",
              "locality": "San Francisco",
              "street": "Avenue E",
              "house": "750",
              "postcode": "94130",
              "bounds": {
                "nw":{
                  "lat": 37.825064712964,
                  "lng": -122.3720706208
                },
                "se":{
                  "lat": 37.824964712964,
                  "lng": -122.3719706208
                }
              }
            }
    }]
}
  • lat - double. Latitude.
  • lng - double. Longitude.
  • address - string. Address.
  • details - details object.
    • country - optional string.
    • province - optional string.
    • locality - optional string.
    • street - optional string.
    • house - optional string.
    • postcode - optional string.
    • bounds - optional object, the bounding box which can fully contain the returned result.
      • nw - North West corner.
      • se - South East corner.

search_location

Search address by location using geocoder.

Parameters

name description type format
location Location coordinates (see: data types description section section). location {"lat": , "lng": }
geocoder Optional. Geocoder type that will be preferably used for searching. Google geocoder is always used for users with the premium GIS. enum "google"
lang Optional. ISO 639 language code. enum "en_US"
with_details Optional. If true then the response will contain details. boolean true
goal Helps to choose the target geocoder. Now supported ui, ui_user_action. Use ui_user_action for requests initiated by user, otherwise ui. enum "ui"

Examples

curl -X POST 'https://api.navixy.com/v2/geocoder/search_location' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "location": "{"lat": 37.825429, "lng": -122.371982}}'

Response

{
    "success": true,
    "value": "750 Avenue E,San Francisco,CA 94130,USA",
    "details": {
      "country": "USA",
      "province": "CA",
      "locality": "San Francisco",
      "street": "Avenue E",
      "house": "750",
      "postcode": "94130",
      "bounds": {
        "nw":{
          "lat": 37.825064712964,
          "lng": -122.3720706208
        },
        "se":{
          "lat": 37.824964712964,
          "lng": -122.3719706208
        }
      }
    }
}
  • value - string. Address.
  • details - optional details object.
    • country - optional string.
    • province - optional string.
    • locality - optional string.
    • street - optional string.
    • house - optional string.
    • postcode - optional string.
    • bounds - optional object, the bounding box which can fully contain the returned result.
      • nw - North West corner.
      • se - South East corner.
Last update: October 16, 2024