Address Search

Search address by a part of its name

SecurityApiKeyAuth
Request
query Parameters
q
string

Query

Example: q=United States, New Y
lat
number [ -90 .. 90 ]

Latitude

lon
number [ -180 .. 180 ]

Longitude

location_bias_scale
number [ 0 .. 1 ]

This setting determines the extent to which the prominence of a search result is considered. Sensible values range from 0.0, where prominence is almost entirely disregarded, to 1.0, where prominence has approximately equal influence as other factors. The default value is set at 0.2.

lang
string

Preferred language

Example: lang=en
zoom
number [ 0 .. 18 ]

The required level of detail for the address is specified by a numerical value. The default setting is 18. This number approximately aligns with the zoom levels utilized in XYZ tile sources within frameworks such as Leaflet.js, OpenLayers, and others. The zoom levels correspond to varying degrees of address detail as follows:

  • 3 - country
  • 5 - state
  • 8 - county
  • 10 - city
  • 14 - suburb
  • 16 - major street
  • 17 - any street
  • 18 - building Default zoom level is 10.
Example: zoom=10
limit
number [ 1 .. 50 ]

Limit the number of returned results

Example: limit=1
bbox
Array of strings (BoundingBox) = 4 items

Filter results by bounding box

Example: bbox=9.5,51.5,11.5,53.5
layer
string

Filter results by layer. List of available layers:

  • house
  • street
  • locality
  • district
  • city
  • county
  • state
  • country
Example: layer=city
osm_tag
string^!{0,1}([a-z]*){0,1}(:[a-z]*){0,1}$

Filter results by OSM tags. Examples:

  • Include places with tag: osm_tag=key:value
  • Exclude places with tag: osm_tag=!key:value
  • Include places with tag key: osm_tag=key
  • Include places with tag value: osm_tag=:value
  • Exclude places with tag key: osm_tag=!key
  • Exclude places with tag value: osm_tag=:!value
Example: osm_tag=tourism:museum
Responses
200

Address search result.

400

Incorrect request parameters.

401

API key is incorrect or not provided.

402

Subscription daily limit exceeded.

403

Subscription suspended.

get/address/search
Request samples
Response samples
application/json
{
  • "features": [
    • {
      • "geometry": {
        • "coordinates": [
          • 0,
          • 0,
          • 0,
          • 0
          ],
        • "type": "string"
        },
      • "type": "string",
      • "properties": {
        • "osm_type": "string",
        • "osm_id": 0,
        • "extent": [
          • 0,
          • 0,
          • 0,
          • 0
          ],
        • "country": "string",
        • "osm_key": "string",
        • "countrycode": "string",
        • "osm_value": "string",
        • "postcode": "string",
        • "name": "string",
        • "county": "string",
        • "state": "string",
        • "type": "string"
        }
      }
    ],
  • "type": "string"
}
Copyright © PickPoint.io LLC 2024. All rights reserved.