WalkStep Data Type

Represents one instruction in walking directions. Three examples from New York City:

Turn onto Broadway from W 57th St (coming from 7th Ave):
distance = 100 (say)
walkDirection = RIGHT
streetName = Broadway
everything else null/false

Now, turn from Broadway onto Central Park S via Columbus Circle
distance = 200 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Central Park S
exit = 1 (first exit)
immediately everything else false

Instead, go through the circle to continue on Broadway
distance = 100 (say)
walkDirection = CIRCLE_COUNTERCLOCKWISE
streetName = Broadway
exit = 3
stayOn = true
everything else false

Properties
name data type description
distance number The distance in meters that this step takes.
relativeDirection RelativeDirection The relative direction of this step.
streetName string The name of the street.
absoluteDirection AbsoluteDirection The absolute direction of this step.
exit string When exiting a highway or traffic circle, the exit name/number.
stayOn boolean Indicates whether or not a street changes direction at an intersection.
area boolean This step is on an open area, such as a plaza or train platform, and thus the directions should say something like "cross"
bogusName boolean The name of this street was generated by the system, so we should only display it once, and generally just display right/left directions
lon number The longitude of start of the step
lat number The latitude of start of the step
alerts array of LocalizedAlert
elevation string

Example

{
  "distance" : 12345.0,
  "relativeDirection" : "CIRCLE_COUNTERCLOCKWISE",
  "streetName" : "...",
  "absoluteDirection" : "NORTHEAST",
  "exit" : "...",
  "stayOn" : true,
  "area" : true,
  "bogusName" : true,
  "lon" : 12345.0,
  "lat" : 12345.0,
  "alerts" : [ {
    "alertHeaderText" : "...",
    "alertDescriptionText" : "...",
    "alertUrl" : "...",
    "effectiveStartDate" : 12345
  }, {
    "alertHeaderText" : "...",
    "alertDescriptionText" : "...",
    "alertUrl" : "...",
    "effectiveStartDate" : 12345
  } ],
  "elevation" : "..."
}