Skip to main content
GET
/
v1
/
geocoding
/
search
Search for a place or address
curl --request GET \
  --url https://api.footstep.ai/v1/geocoding/search \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "coordinates": {
        "lat": 51.5074,
        "lng": -0.1278
      },
      "label": "London, England, United Kingdom",
      "name": "London",
      "country": "United Kingdom",
      "country_code": "GBR",
      "region": "England",
      "locality": "London",
      "confidence": 0.95,
      "place_type": "locality"
    }
  ],
  "query": {
    "text": "London",
    "size": 10
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.footstep.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Your Footstep API key

Query Parameters

​
text
string
required

Search text (address, place name, landmark)

​
size
integer
default:5

Maximum number of results. The top match is the strongest hit; ask for more only when you need disambiguation candidates

Required range: 1 <= x <= 40
​
focus.point.lat
number

Latitude to bias results towards

Required range: -90 <= x <= 90
​
focus.point.lon
number

Longitude to bias results towards

Required range: -180 <= x <= 180
​
boundary.country
string

Comma-separated ISO 3166-1 alpha-3 country codes (e.g. GBR,USA)

​
place_types
string

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

Response

Geocoding results

​
results
object[]
required
​
query
object
required