Stadia Maps

Stadia Maps Match API

The Match API from Stadia Maps — 1 operation(s) for match.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.stadiamaps.com/
📖
Authentication
https://docs.stadiamaps.com/authentication/
📖
Documentation
https://docs.stadiamaps.com/routing/
📖
Documentation
https://docs.stadiamaps.com/geocoding-search-autocomplete/
📖
Documentation
https://docs.stadiamaps.com/client-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stadia-maps/refs/heads/main/openapi/stadia-maps-match-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/stadia-maps/refs/heads/main/json-schema/stadia-maps-location-schema.json

Other Resources

🔗
SpectralRuleset
https://raw.githubusercontent.com/api-evangelist/stadia-maps/refs/heads/main/rules/stadia-maps-rules.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/stadia-maps/refs/heads/main/json-ld/stadia-maps-context.jsonld
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/stadia-maps/refs/heads/main/vocabulary/stadia-maps-vocabulary.yml

OpenAPI Specification

stadia-maps-match-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  description: 'Confidently create beautiful maps for all your users with our tools. Choose your style from our library or build your own. With a rich palette of choices to fit any context and support for dozens of languages and scripts, you can deliver a quality experience for your customers no matter what part of the globe they call home. '
  version: 7.1.0
  title: Stadia Maps Match API
  contact:
    name: Stadia Maps Support
    url: https://www.stadiamaps.com
    email: support@stadiamaps.com
servers:
- url: https://api.stadiamaps.com
- url: https://api-eu.stadiamaps.com
tags:
- name: Match
paths:
  /map_match/v1:
    post:
      tags:
      - Match
      operationId: map-match
      summary: Match a recorded route to the road network.
      description: The map matching API transforms a recorded route into navigation instructions like you would get from the `route` endpoint. The input can be in the form of either an encoded polyline, or (optionally) timestamped coordinates.
      security:
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mapMatchRequest'
      responses:
        '200':
          description: The matched route(s), which looks more or less like a normal route response, optionally with a `linear_references` key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mapMatchRouteResponse'
        '400':
          description: Bad request; more details will be included
        '500':
          description: An internal parse error occurred; more details will be included
components:
  schemas:
    routingResponseWaypoint:
      allOf:
      - $ref: '#/components/schemas/simpleRoutingWaypoint'
      - type: object
        properties:
          original_index:
            type: integer
            description: The original index of the location (locations may be reordered for optimized routes)
            minimum: 0
    useHillsCostingOption:
      type: number
      format: double
      description: A measure of willingness to take tackle hills. Values near 0 attempt to avoid hills and steeper grades even if it means a longer route, and values near 1 indicates that the user does not fear them. Note that as some routes may be impossible without hills, 0 does not guarantee avoidance of them.
      default: 0.5
      minimum: 0
      maximum: 1
    routeSummary:
      type: object
      properties:
        time:
          type: number
          format: double
          description: The estimated travel time, in seconds
        length:
          type: number
          format: double
          description: The estimated travel distance, in `units` (km or mi)
        min_lat:
          type: number
          format: double
          description: The minimum latitude of the bounding box containing the route.
        max_lat:
          type: number
          format: double
          description: The maximum latitude of the bounding box containing the route.
        min_lon:
          type: number
          format: double
          description: The minimum longitude of the bounding box containing the route.
        max_lon:
          type: number
          format: double
          description: The maximum longitude of the bounding box containing the route.
      required:
      - time
      - length
      - min_lat
      - min_lon
      - max_lat
      - max_lon
    valhallaLanguages:
      type: string
      enum:
      - bg-BG
      - ca-ES
      - cs-CZ
      - da-DK
      - de-DE
      - el-GR
      - en-GB
      - en-US-x-pirate
      - en-US
      - es-ES
      - et-EE
      - fi-FI
      - fr-FR
      - hi-IN
      - hu-HU
      - it-IT
      - ja-JP
      - nb-NO
      - nl-NL
      - pl-PL
      - pt-BR
      - pt-PT
      - ro-RO
      - ru-RU
      - sk-SK
      - sl-SI
      - sv-SE
      - tr-TR
      - uk-UA
      default: en-US
    routeResponse:
      type: object
      required:
      - trip
      properties:
        id:
          $ref: '#/components/schemas/requestId'
        trip:
          $ref: '#/components/schemas/routeTrip'
        alternates:
          type: array
          items:
            type: object
            properties:
              trip:
                $ref: '#/components/schemas/routeTrip'
      example:
        trip:
          locations:
          - type: break
            lat: 60.534715
            lon: -149.543469
            original_index: 0
          - type: break
            lat: 60.53499
            lon: -149.54858
            original_index: 1
          legs:
          - maneuvers:
            - type: 1
              instruction: Drive west on AK 1/Seward Highway.
              verbal_pre_transition_instruction: Drive west on Alaska 1, Seward Highway. Then You will arrive at your destination.
              verbal_post_transition_instruction: Continue for 900 feet.
              street_names:
              - AK 1
              - Seward Highway
              time: 11.487
              length: 0.176
              cost: 15.508
              begin_shape_index: 0
              end_shape_index: 9
              verbal_multi_cue: true
              travel_mode: drive
              travel_type: car
            - type: 4
              instruction: You have arrived at your destination.
              verbal_transition_alert_instruction: You will arrive at your destination.
              verbal_pre_transition_instruction: You have arrived at your destination.
              time: 0
              length: 0
              cost: 0
              begin_shape_index: 9
              end_shape_index: 9
              travel_mode: drive
              travel_type: car
            summary:
              has_time_restrictions: false
              min_lat: 60.534715
              min_lon: -149.54858
              max_lat: 60.535008
              max_lon: -149.543469
              time: 11.487
              length: 0.176
              cost: 15.508
            shape: wzvmrBxalf|GcCrX}A|Nu@jI}@pMkBtZ{@x^_Afj@Inn@`@veB
          summary:
            has_time_restrictions: false
            min_lat: 60.534715
            min_lon: -149.54858
            max_lat: 60.535008
            max_lon: -149.543469
            time: 11.487
            length: 0.176
            cost: 15.508
          status_message: Found route between points
          status: 0
          units: miles
          language: en-US
    routeTrip:
      type: object
      properties:
        status:
          type: integer
          description: The response status code
        status_message:
          type: string
          description: The response status message
        units:
          $ref: '#/components/schemas/valhallaLongUnits'
        language:
          $ref: '#/components/schemas/valhallaLanguages'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/routingResponseWaypoint'
        legs:
          type: array
          items:
            $ref: '#/components/schemas/routeLeg'
        summary:
          $ref: '#/components/schemas/routeSummary'
      required:
      - status
      - status_message
      - units
      - language
      - locations
      - legs
      - summary
    elevation_interval:
      type: number
      format: float
      description: 'If greater than zero, attempts to include elevation along the route at regular intervals. The "native" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted as either meters or feet depending on the unit parameter.

        Elevation for route sections containing a bridge or tunnel is interpolated linearly. This doesn''t always match the true elevation of the bridge/tunnel, but it prevents sharp artifacts from the surrounding terrain. This functionality is unique to the routing endpoints and is not available via the elevation API.

        NOTE: This has no effect on the OSRM response format.'
      default: 0
    motorcycleCostingOptions:
      allOf:
      - $ref: '#/components/schemas/autoCostingOptions'
      - type: object
        properties:
          use_highways:
            type: number
            format: double
            description: A measure of willingness to use highways. Values near 0 attempt to avoid highways and stay on roads with lower speeds, and values near 1 indicate the rider is more comfortable on these roads.
            default: 1
            minimum: 0
            maximum: 1
          use_trails:
            type: number
            format: double
            description: A measure of the rider's sense of adventure. Values near 0 attempt to avoid highways and stay on roads with potentially unsuitable terrain (trails, tracks, unclassified, or bad surfaces), and values near 1 will tend to avoid major roads and route on secondary roads.
            default: 0
            minimum: 0
            maximum: 1
    motorScooterCostingOptions:
      allOf:
      - $ref: '#/components/schemas/autoCostingOptions'
      - type: object
        properties:
          use_primary:
            type: number
            format: double
            description: A measure of willingness to use primary roads. Values near 0 attempt to avoid primary roads and stay on roads with lower speeds, and values near 1 indicate the rider is more comfortable on these roads.
            default: 0.5
            minimum: 0
            maximum: 1
          use_hills:
            type: number
            format: double
            description: A measure of willingness to take tackle hills. Values near 0 attempt to avoid hills and steeper grades even if it means a longer route, and values near 1 indicates that the rider does not fear them. Note that as some routes may be impossible without hills, 0 does not guarantee avoidance of them.
            default: 0.5
            minimum: 0
            maximum: 1
    costingOptions:
      type: object
      properties:
        auto:
          $ref: '#/components/schemas/autoCostingOptions'
        bus:
          $ref: '#/components/schemas/autoCostingOptions'
        taxi:
          $ref: '#/components/schemas/autoCostingOptions'
        truck:
          $ref: '#/components/schemas/truckCostingOptions'
        bicycle:
          $ref: '#/components/schemas/bicycleCostingOptions'
        motor_scooter:
          $ref: '#/components/schemas/motorScooterCostingOptions'
        motorcycle:
          $ref: '#/components/schemas/motorcycleCostingOptions'
        pedestrian:
          $ref: '#/components/schemas/pedestrianCostingOptions'
        low_speed_vehicle:
          $ref: '#/components/schemas/lowSpeedVehicleCostingOptions'
    mapMatchRouteResponse:
      allOf:
      - $ref: '#/components/schemas/routeResponse'
      - type: object
        properties:
          linear_references:
            type: array
            items:
              type: string
              description: A base64-encoded [OpenLR location reference](https://www.openlr-association.com/fileadmin/user_upload/openlr-whitepaper_v1.5.pdf), for a graph edge of the road network matched by the trace.
      example:
        trip:
          locations:
          - type: break
            lat: 37.807744
            lon: -122.4197
          - type: break
            lat: 37.803694
            lon: -122.428416
          legs:
          - maneuvers:
            - type: 1
              instruction: Walk west on the walkway.
              verbal_pre_transition_instruction: Walk west on the walkway.
              verbal_post_transition_instruction: Continue for 200 feet.
              time: 44.733
              length: 0.039
              cost: 44.733
              begin_shape_index: 0
              end_shape_index: 1
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left.
              verbal_transition_alert_instruction: Turn left.
              verbal_pre_transition_instruction: Turn left. Then Turn right onto Jefferson Street.
              verbal_post_transition_instruction: Continue for 20 feet.
              time: 4.941
              length: 0.004
              cost: 4.941
              begin_shape_index: 1
              end_shape_index: 2
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 10
              instruction: Turn right onto Jefferson Street.
              verbal_transition_alert_instruction: Turn right onto Jefferson Street.
              verbal_pre_transition_instruction: Turn right onto Jefferson Street.
              verbal_post_transition_instruction: Continue for 80 feet.
              street_names:
              - Jefferson Street
              time: 16.941
              length: 0.014
              cost: 21.941
              begin_shape_index: 2
              end_shape_index: 3
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto the walkway.
              verbal_transition_alert_instruction: Turn left onto the walkway.
              verbal_pre_transition_instruction: Turn left onto the walkway. Then Turn right onto the walkway.
              verbal_post_transition_instruction: Continue for 20 feet.
              time: 4.941
              length: 0.004
              cost: 9.941
              begin_shape_index: 3
              end_shape_index: 4
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 10
              instruction: Turn right onto the walkway.
              verbal_transition_alert_instruction: Turn right onto the walkway.
              verbal_pre_transition_instruction: Turn right onto the walkway. Then Turn left onto Hyde Street.
              verbal_post_transition_instruction: Continue for 30 feet.
              time: 6.352
              length: 0.005
              cost: 6.352
              begin_shape_index: 4
              end_shape_index: 5
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto Hyde Street.
              verbal_transition_alert_instruction: Turn left onto Hyde Street.
              verbal_pre_transition_instruction: Turn left onto Hyde Street.
              verbal_post_transition_instruction: Continue for 300 feet.
              street_names:
              - Hyde Street
              time: 58.588
              length: 0.051
              cost: 63.588
              begin_shape_index: 5
              end_shape_index: 10
              travel_mode: pedestrian
              travel_type: foot
            - type: 10
              instruction: Turn right onto the walkway.
              verbal_transition_alert_instruction: Turn right onto the walkway.
              verbal_pre_transition_instruction: Turn right onto the walkway. Then Turn left onto the walkway.
              verbal_post_transition_instruction: Continue for 30 feet.
              time: 6.352
              length: 0.005
              cost: 11.352
              begin_shape_index: 10
              end_shape_index: 11
              rough: true
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto the walkway.
              verbal_transition_alert_instruction: Turn left onto the walkway.
              verbal_pre_transition_instruction: Turn left onto the walkway.
              verbal_post_transition_instruction: Continue for 400 feet.
              time: 93.176
              length: 0.082
              cost: 93.176
              begin_shape_index: 11
              end_shape_index: 17
              rough: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto the walkway.
              verbal_transition_alert_instruction: Turn left onto the walkway.
              verbal_pre_transition_instruction: Turn left onto the walkway. Then Turn right onto Beach Street.
              verbal_post_transition_instruction: Continue for 40 feet.
              time: 7.764
              length: 0.006
              cost: 7.764
              begin_shape_index: 17
              end_shape_index: 18
              rough: true
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 10
              instruction: Turn right onto Beach Street.
              verbal_transition_alert_instruction: Turn right onto Beach Street.
              verbal_pre_transition_instruction: Turn right onto Beach Street.
              verbal_post_transition_instruction: Continue for 500 feet.
              street_names:
              - Beach Street
              time: 110.705
              length: 0.095
              cost: 115.705
              begin_shape_index: 18
              end_shape_index: 24
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto Polk Street.
              verbal_transition_alert_instruction: Turn left onto Polk Street.
              verbal_pre_transition_instruction: Turn left onto Polk Street.
              verbal_post_transition_instruction: Continue for 300 feet.
              street_names:
              - Polk Street
              time: 68.058
              length: 0.059
              cost: 73.058
              begin_shape_index: 24
              end_shape_index: 27
              travel_mode: pedestrian
              travel_type: foot
            - type: 10
              instruction: Turn right onto the walkway.
              verbal_transition_alert_instruction: Turn right onto the walkway.
              verbal_pre_transition_instruction: Turn right onto the walkway.
              verbal_post_transition_instruction: Continue for 400 feet.
              time: 98
              length: 0.084
              cost: 103
              begin_shape_index: 27
              end_shape_index: 32
              rough: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto Van Ness Avenue.
              verbal_transition_alert_instruction: Turn left onto Van Ness Avenue.
              verbal_pre_transition_instruction: Turn left onto Van Ness Avenue.
              verbal_post_transition_instruction: Continue for 400 feet.
              street_names:
              - Van Ness Avenue
              time: 83.294
              length: 0.073
              cost: 98.294
              begin_shape_index: 32
              end_shape_index: 38
              travel_mode: pedestrian
              travel_type: foot
            - type: 10
              instruction: Turn right onto the walkway.
              verbal_transition_alert_instruction: Turn right onto the walkway.
              verbal_pre_transition_instruction: Turn right onto the walkway. Then Turn left onto the walkway.
              verbal_post_transition_instruction: Continue for 30 feet.
              time: 7.058
              length: 0.006
              cost: 12.058
              begin_shape_index: 38
              end_shape_index: 39
              rough: true
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto the walkway.
              verbal_transition_alert_instruction: Turn left onto the walkway.
              verbal_pre_transition_instruction: Turn left onto the walkway. Then Turn right onto Bay Street.
              verbal_post_transition_instruction: Continue for 50 feet.
              time: 9.882
              length: 0.008
              cost: 9.882
              begin_shape_index: 39
              end_shape_index: 40
              rough: true
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 10
              instruction: Turn right onto Bay Street.
              verbal_transition_alert_instruction: Turn right onto Bay Street.
              verbal_pre_transition_instruction: Turn right onto Bay Street.
              verbal_post_transition_instruction: Continue for 900 feet.
              street_names:
              - Bay Street
              time: 194.823
              length: 0.171
              cost: 199.823
              begin_shape_index: 40
              end_shape_index: 45
              travel_mode: pedestrian
              travel_type: foot
            - type: 15
              instruction: Turn left onto Gough Street.
              verbal_transition_alert_instruction: Turn left onto Gough Street.
              verbal_pre_transition_instruction: Turn left onto Gough Street. Then You will arrive at your destination.
              verbal_post_transition_instruction: Continue for 20 feet.
              street_names:
              - Gough Street
              time: 3.302
              length: 0.002
              cost: 8.302
              begin_shape_index: 45
              end_shape_index: 46
              verbal_multi_cue: true
              travel_mode: pedestrian
              travel_type: foot
            - type: 4
              instruction: You have arrived at your destination.
              verbal_transition_alert_instruction: You will arrive at your destination.
              verbal_pre_transition_instruction: You have arrived at your destination.
              time: 0
              length: 0
              cost: 0
              begin_shape_index: 46
              end_shape_index: 46
              travel_mode: pedestrian
              travel_type: foot
            summary:
              has_time_restrictions: false
              min_lat: 37.803694
              min_lon: -122.428418
              max_lat: 37.807771
              max_lon: -122.419706
              time: 818.918
              length: 0.716
              cost: 883.918
            shape: uhrbgAt~{nhFrDhk@rBWfAbPvBWXfElAQhAi@dA]d[oDvIaAs@~Dp@n@r@r@^\jAnQfDdh@lBtY`Eg@VzDXxDxAdPrD~j@zBf]TpD|C_@`\uD|QaCZtE`Cp\|A|UdCz^N`ClDJj@dJdDo@vGw@dKmAzWcDRdFpFq@d@dHpH`kAVbEXhEdKj_BpAO
          linear_references:
          - C6jyLBrisjr3Af+4//g6BA==
          - C6jyCxrirjr3AAAA//s6Bw==
          - C6jyDBriqyKUAP/j//0iAg==
          - C6jx/xriqTr3AAAA//w6Ag==
          - C6jx/xripjr0AP/2AAE6Hg==
          - C6jx+xripiKUAQAM/8kiHw==
          - C6jyARrijCKPAAAC/+8iBg==
          - C6jyAxrihDrvAP/0AAM6BQ==
          - C6jx/hrihTrzAP/5//o6Bw==
          - C6jx+xrigjr1AP/h//06Bw==
          - C6jx7RrigDr3Af++//k6Bw==
          - C6jxzxrifDr3AP/T//w6Ag==
          - C6jxuxrieTr3AAAA//g6Bw==
          - C6jxvBridTLSAP/1AAAyBw==
          - C6jxtxridDLSAP/2AAEyBg==
          - C6jxsxridDLWAf+d//MyBw==
          - C6jxhRribjLXAP/P//oyAg==
          - C6jxbxriazLXAP/1//8yHw==
          - C6jxaxriajLXAP////kyHw==
          - C6jxaxriZjLTAAAJ/9MyHw==
          - C6jxbxriUTLPAAAG/+IyBw==
          - C6jxcxriQzrvAP/z//86Bw==
          - C6jxbhriQjryAP/P//s6Bw==
          - C6jxVxriPzr3AP/b//w6Bw==
          - C6jxRhriPTr3AP/N//o6Aw==
          - C6jxLxriOjr3AP/4AAA6Aw==
          - C6jxLBriOTLXAP/9//kyBQ==
          - C6jxKxriNSKTAP/u//8iHw==
          - C6jxIxriNCKWAAAE/+siHw==
          - C6jxJRriKiKPAAAE/+0iHw==
          - C6jxJxriISKPAAAI/9kiAw==
          - C6jxKxriDjrvAP/0AAA6AQ==
          - C6jxJhriDjrzAAAB//Q6Bw==
          - C6jxJxriCBpxAv9s/+8aBw==
          - C6jw4xrh/xp3Av9a/+0aBQ==
          - C6jwlhrh9jLXAAAA//0yBQ==
          summary:
            has_time_restrictions: false
            min_lat: 37.803694
            min_lon: -122.428418
            max_lat: 37.807771
            max_lon: -122.419706
            time: 818.918
            length: 0.716
            cost: 883.918
          status_message: Found route between points
          status: 0
          units: miles
          language: en-US
    maneuverSign:
      type: object
      properties:
        exit_number_elements:
          type: array
          description: A list of exit number elements. This is typically just a single value.
          items:
            $ref: '#/components/schemas/maneuverSignElement'
        exit_branch_elements:
          type: array
          description: A list of exit branch elements. The text is a subsequent road name or route number after the sign.
          items:
            $ref: '#/components/schemas/maneuverSignElement'
        exit_toward_elements:
          type: array
          description: A list of exit name elements. The text is the interchange identifier (used more frequently outside the US).
          items:
            $ref: '#/components/schemas/maneuverSignElement'
        exit_name_elements:
          type: array
          description: A list of exit name elements. The text is the location where the road ahead goes (typically a city, but occasionally a road name or route number).
          items:
            $ref: '#/components/schemas/maneuverSignElement'
    autoCostingOptions:
      allOf:
      - $ref: '#/components/schemas/baseCostingOptions'
      - type: object
        properties:
          height:
            type: number
            format: double
            description: The height of the automobile (in meters).
            default: 1.9
          width:
            type: number
            format: double
            description: The width of the automobile (in meters).
            default: 1.6
          toll_booth_cost:
            type: integer
            description: The estimated cost (in seconds) when a toll booth is encountered.
            default: 15
          toll_booth_penalty:
            type: integer
            description: A penalty (in seconds) applied to the route cost when a toll booth is encountered. This penalty can be used to reduce the likelihood of suggesting a route with toll booths unless absolutely necessary.
            default: 0
          ferry_cost:
            type: integer
            description: The estimated cost (in seconds) when a ferry is encountered.
            default: 300
          use_highways:
            type: number
            format: double
            description: A measure of willingness to take highways. Values near 0 attempt to avoid highways, and values near 1 will favour them. Note that as some routes may be impossible without highways, 0 does not guarantee avoidance of them.
            default: 0.5
            minimum: 0
            maximum: 1
          use_tolls:
            type: number
            format: double
            description: A measure of willingness to take toll roads. Values near 0 attempt to avoid tolls, and values near 1 will favour them. Note that as some routes may be impossible without tolls, 0 does not guarantee avoidance of them.
            default: 0.5
            minimum: 0
            maximum: 1
          use_tracks:
            $ref: '#/components/schemas/useTracksCostingOption'
          top_speed:
            type: integer
            description: The top speed (in kph) that the vehicle is capable of travelling.
            default: 140
            minimum: 10
            maximum: 252
          shortest:
            type: boolean
            description: If true changes the cost metric to be quasi-shortest (pure distance-based) costing. This will disable ALL other costing factors.
            default: false
          ignore_closures:
            type: boolean
            description: If true, ignores all known closures. This option cannot be set if `location.search_filter.exclude_closures` is also specified.
            default: false
          include_hov2:
            type: boolean
            description: If true, indicates the desire to include HOV roads with a 2-occupant requirement in the route when advantageous.
            default: false
          include_hov3:
            type: boolean
            description: If true, indicates the desire to include HOV roads with a 3-occupant requirement in the route when advantageous.
            default: false
          include_hot:
            type: boolean
            description: If true, indicates the desire to include toll roads which require the driver to pay a toll if the occupant requirement isn't met
            default: false
          alley_factor:
            type: number
            format: double
            description: A factor that multiplies the cost when alleys are encountered.
            default: 1
    travelMode:
      type: string
      enum:
      - drive
      - pedestrian
      - bicycle
      - transit
    distanceUnit:
      type: string
      enum:
      - km
      - mi
      default: km
    valhallaLongUnits:
      type: string
      enum:
      - miles
      - kilometers
      default: kilometers
    routeLeg:
      type: object
      properties:
        maneuvers:
          type: array
          items:
            $ref: '#/components/schemas/routeManeuver'
          minItems: 1
        shape:
          type: string
          description: An encoded polyline (https://developers.google.com/maps/documentation/utilities/polylinealgorithm) with 6 digits of decimal precision.
        summary:
          $ref: '#/components/schemas/routeSummary'
        elevation_interval:
          type: number
          format: float
          description: The sampling distance between elevation values along the route. This echoes the request parameter having the same name (converted to `units` if necessary).
        elevation:
          type: array
          items:
            type: number
            format: float
          description: An array of elevation values sampled every `elevation_interval`. Units are either metric or imperial depending on the value of `units`.
      required:
      - maneuvers
      - shape
      - summary
    useTracksCostingOption:
      type: number
      format: double
      description: A measure of willingness to take track roads. Values near 0 attempt to avoid them, and values near 1 will favour them. Note that as some routes may be impossible without track roads, 0 does not guarantee avoidance of them. The default value is 0 for automobiles, busses, and trucks; and 0.5 for all other costing modes.
      minimum: 0
      maximum: 1
    lowSpeedVehicleCostingOptions:
      allOf:
      - $ref: '#/components/schemas/baseCostingOptions'
      - type: object
        properties:
          vehicle_type:
            type: string
            enum:
            - low_speed_vehicle
            - golf_cart
            default: low_speed_vehicle
            description: 'The type of vehicle:

              * low_speed_vehicle (BETA): a low-speed vehicle which falls under a different regulatory and licensing regime than automobiles (ex: LSV in the US and Canada, Quadricycles in the EU, etc.) * golf_cart: a street legal golf cart that is under a similar regulator regime as the generic LSV laws, but may need to follow special paths when available or abide by restrictions specific to golf carts.'
          top_speed:
            type: integer
            description: 'The top speed (in kph) that the vehicle is capable of travelling.

              This impacts travel time calculations as well as which roads are preferred. A very low speed vehicle will tend to prefer lower speed roads even in the presence of other legal routes.'
            default: 35
            minimum: 20
            maximum: 60
          max_allowed_speed_limit:
            type: integer
            description: The maximum speed limit for highways on which it is legal for the vehicle to travel. Defaults to 57 (kph; around 35 mph). Acceptable values range from 20 to 80. Highways with *tagged* speed limits higher than this value will not be routed over (some caveats apply; this feature is still BETA).
            default: 57
            minimum: 20
            maximum: 80
    transitInfo:
      type: object
      description: Public transit info (not currently supported).
      additionalProperties: true
    maneuverSignElement:
      type: object
      properties:
        text:
          type: string
          description: The interchange sign text (varies based on the context; see the `maneuverSign` schema).
        is_route_number:
          type: boolean
          description: True if the sign is a route number.
        consecutive_count:
          type: integer
          description: The frequency of this sign element within a set a consecutive signs.
      require

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stadia-maps/refs/heads/main/openapi/stadia-maps-match-api-openapi.yml