Skip to main content
POST
/
v1
/
geocoding
/
batch
curl --request POST \
  --url https://api.footstep.ai/v1/geocoding/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "items": [
    {
      "text": "Buckingham Palace, London"
    },
    {
      "text": "Eiffel Tower, Paris"
    },
    {
      "text": "Colosseum, Rome"
    }
  ]
}
'
{
  "results": [
    {
      "index": 0,
      "results": [
        {
          "coordinates": {
            "lat": 51.5014,
            "lng": -0.1419
          },
          "label": "Buckingham Palace, London, England, United Kingdom",
          "name": "Buckingham Palace",
          "country": "United Kingdom",
          "country_code": "GBR",
          "region": "England",
          "locality": "London",
          "confidence": 0.95,
          "layer": "venue",
          "source": "openstreetmap"
        }
      ]
    },
    {
      "index": 1,
      "results": [
        {
          "coordinates": {
            "lat": 48.8584,
            "lng": 2.2945
          },
          "label": "Eiffel Tower, Paris, Île-de-France, France",
          "name": "Eiffel Tower",
          "country": "France",
          "country_code": "FRA",
          "region": "Île-de-France",
          "locality": "Paris",
          "confidence": 0.96,
          "layer": "venue",
          "source": "openstreetmap"
        }
      ]
    },
    {
      "index": 2,
      "results": [
        {
          "coordinates": {
            "lat": 41.8902,
            "lng": 12.4922
          },
          "label": "Colosseum, Rome, Lazio, Italy",
          "name": "Colosseum",
          "country": "Italy",
          "country_code": "ITA",
          "region": "Lazio",
          "locality": "Rome",
          "confidence": 0.97,
          "layer": "venue",
          "source": "openstreetmap"
        }
      ]
    }
  ],
  "summary": {
    "total": 3,
    "matched": 3,
    "failed": 0
  }
}

Authorizations

​
x-api-key
string
header
required

Your Footstep API key

Body

application/json
​
items
object[]
required

Addresses to geocode. Each item can use free text (text field) or structured components (address, locality, country, etc.).

Required array length: 1 - 1000 elements
​
size
integer
default:1

Maximum results per item

Required range: 1 <= x <= 10

Response

Batch geocoding results

​
results
object[]
required
​
summary
object
required