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>'
import requests

url = "https://api.footstep.ai/v1/geocoding/structured-search"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.footstep.ai/v1/geocoding/structured-search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.footstep.ai/v1/geocoding/structured-search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.footstep.ai/v1/geocoding/structured-search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.footstep.ai/v1/geocoding/structured-search")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.footstep.ai/v1/geocoding/structured-search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{ "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, "place_type": "address" } ], "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: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
place_types
string

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

Response

Geocoding results

results
object[]
required
query
object
required