Skip to main content
GET
/
v1
/
geocoding
/
places
Search for places and points of interest
curl --request GET \
  --url https://api.footstep.ai/v1/geocoding/places \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "coordinates": {
        "lat": 51.5318,
        "lng": -0.1243
      },
      "label": "Caravan, Granary Square, London, England, United Kingdom",
      "name": "Caravan",
      "country": "United Kingdom",
      "country_code": "GBR",
      "region": "England",
      "locality": "London",
      "distance_meters": 120,
      "confidence": 0.92,
      "layer": "venue",
      "source": "openstreetmap"
    }
  ],
  "query": {
    "query": "coffee shop",
    "near": {
      "lat": 51.5322,
      "lon": -0.124
    },
    "radius": 5,
    "size": 10
  }
}

Authorizations

x-api-key
string
header
required

Your Footstep API key

Query Parameters

query
string
required

What to search for (e.g. 'coffee shop', 'restaurant', 'supermarket', 'train station', 'park')

near.lat
number
required

Latitude to search around

Required range: -90 <= x <= 90
near.lon
number
required

Longitude to search around

Required range: -180 <= x <= 180
radius
number
default:5

Search radius in kilometres

Required range: 0.1 <= x <= 50
size
integer
default:10

Maximum number of results

Required range: 1 <= x <= 40
boundary.country
string

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

Response

Places matching the query

results
object[]
required
query
object
required