Skip to main content
GET
/
v1
/
geocoding
/
parse
Parse a free-text address into components
curl --request GET \
  --url https://api.footstep.ai/v1/geocoding/parse \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.footstep.ai/v1/geocoding/parse"

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/parse', 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/parse",
  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/parse"

	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/parse")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.footstep.ai/v1/geocoding/parse")

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
{ "input": "10 Downing Street, London SW1A 2AA, United Kingdom", "components": { "house_number": "10", "road": "Downing Street", "city": "London", "postcode": "SW1A 2AA", "country": "United Kingdom" } }

Authorizations

x-api-key
string
header
required

Your Footstep API key

Query Parameters

text
string
required

Free-text address to parse

Response

Parsed address components

input
string
required

The original input text

components
object
required

Parsed address components. Only fields that were detected are included.