Skip to main content
GET
/
v1
/
geocoding
/
structured-search
Search by address components
curl --request GET \
  --url https://api.footstep.ai/v1/geocoding/structured-search \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "coordinates": {
        "lat": 51.5034,
        "lng": -0.1276
      },
      "label": "10 Downing Street, London, England, United Kingdom",
      "name": "10 Downing Street",
      "country": "United Kingdom",
      "country_code": "GBR",
      "region": "England",
      "locality": "London",
      "confidence": 0.98,
      "layer": "address",
      "source": "openaddresses"
    }
  ],
  "query": {
    "text": "",
    "size": 10
  }
}

Authorizations

​
x-api-key
string
header
required

Your Footstep API key

Query Parameters

​
address
string

House number and street (e.g. '10 Downing Street')

​
neighbourhood
string

Neighbourhood or suburb

​
locality
string

City or town

​
county
string

County or district

​
region
string

State, province, or region

​
postalcode
string

Postal or ZIP code

​
country
string

ISO 3166-1 alpha-3 country code (e.g. GBR, USA)

​
size
integer
default:10

Maximum number of results

Required range: 1 <= x <= 40
​
layers
string

Comma-separated layers to filter: venue, address, street, locality, region, country

Response

Geocoding results

​
results
object[]
required
​
query
object
required