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

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

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.