Get Elevation

curl --request POST \ --url https://api.footstep.ai/v1/routing/elevation \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "shape": [ { "lat": 51.5322, "lon": -0.124 }, { "lat": 51.5007, "lon": -0.1246 }, { "lat": 51.5055, "lon": -0.0754 } ] } '

{ "shape": [ { "lat": 0, "lon": 0 } ], "height": [ 123 ], "range_height": [ [ 123 ] ], "summary": { "max_elevation_meters": 123, "min_elevation_meters": 123, "avg_elevation_meters": 123, "total_ascent_meters": 123, "total_descent_meters": 123 } }

Authorizations

x-api-key

string

header

required

Your Footstep API key

Body

application/json

Provide either shape or encoded_polyline

shape

object[]

Coordinates (max 2000)

Maximum array length: 2000

Show child attributes

encoded_polyline

string

Encoded polyline alternative

range

boolean

default:false

Include cumulative distances

resample_distance

number

Resample interval in meters

Required range: 1 <= x <= 1000

height_precision

number

default:0

Decimal places for heights

Required range: 0 <= x <= 2

format

enum<string>

default:footstep

Response format. footstep = optimised for app developers (encoded polyline, flat structure). geojson = standard GeoJSON FeatureCollection (decoded coordinates, immediately usable in Leaflet/Mapbox GL/deck.gl).

Available options:

footstep,

geojson

Response

Elevation data with summary

shape

object[]

Show child attributes

height

number[]

Elevations (when range=false)

range_height

number[][]

[distance_meters, elevation_meters] tuples (when range=true)

Required array length: 2 elements

summary

object

Elevation statistics for the requested points. total_ascent_meters and total_descent_meters are included only when range: true was requested.

Show child attributes

Routing

Geocoding

Natural Language

Predict

Authorizations

Body

Response