---
openapi: 3.1.0
info:
  title: Google Maps Directions — SearchApi
  version: 3.1.0
  description: Generated from the SearchApi engine catalog. Parameters marked in the
    catalog as unverified are described from its records rather than from the vendor's
    specification.
servers:
- url: https://www.searchapi.io/api/v1
paths:
  "/search":
    get:
      operationId: google_maps_directions
      summary: Google Maps Directions
      parameters:
      - name: engine
        in: query
        required: true
        description: Engine that retrieves the data; fixed per API (see Apis::BY_ENGINE
          keys).
        schema:
          type: string
          const: google_maps_directions
      - name: api_key
        in: query
        required: true
        description: 'SearchApi.io API key; alternatively send ''Authorization: Bearer
          <key>''.'
        schema:
          type: string
      - name: zero_retention
        in: query
        required: false
        description: 'Enterprise-only: disables all logging and persistent storage
          of the search.'
        schema:
          type: boolean
          default: false
      - name: start_addr
        in: query
        required: true
        description: Origin address of the route.
        schema:
          type: string
      - name: end_addr
        in: query
        required: true
        description: Destination address of the route.
        schema:
          type: string
      - name: travel_mode
        in: query
        required: false
        description: Travel mode of the route.
        schema:
          type: string
          enum:
          - best
          - driving
          - two_wheeler
          - transit
          - walking
          - cycling
          - flight
      - name: gl
        in: query
        required: false
        description: Country of the search (two-letter country code).
        schema:
          type: string
          enum:
          - af
          - al
          - dz
          - as
          - ad
          - ao
          - ai
          - aq
          - ag
          - ar
          - am
          - aw
          - au
          - at
          - az
          - bs
          - bh
          - bd
          - bb
          - by
          - be
          - bz
          - bj
          - bm
          - bt
          - bo
          - ba
          - bw
          - bv
          - br
          - io
          - bn
          - bg
          - bf
          - bi
          - kh
          - cm
          - ca
          - cv
          - ky
          - cf
          - td
          - cl
          - cn
          - cx
          - cc
          - co
          - km
          - cg
          - cd
          - ck
          - cr
          - ci
          - hr
          - cu
          - cy
          - cz
          - dk
          - dj
          - dm
          - do
          - ec
          - eg
          - sv
          - gq
          - er
          - ee
          - et
          - fk
          - fo
          - fj
          - fi
          - fr
          - gf
          - pf
          - tf
          - ga
          - gm
          - ge
          - de
          - gh
          - gi
          - gr
          - gl
          - gd
          - gp
          - gu
          - gt
          - gn
          - gw
          - gy
          - ht
          - hm
          - va
          - hn
          - hk
          - hu
          - is
          - in
          - id
          - ir
          - iq
          - ie
          - il
          - it
          - jm
          - jp
          - jo
          - kz
          - ke
          - ki
          - kp
          - kr
          - kw
          - kg
          - la
          - lv
          - lb
          - ls
          - lr
          - ly
          - li
          - lt
          - lu
          - mo
          - mk
          - mg
          - mw
          - my
          - mv
          - ml
          - mt
          - mh
          - mq
          - mr
          - mu
          - yt
          - mx
          - fm
          - md
          - mc
          - mn
          - ms
          - ma
          - mz
          - mm
          - na
          - nr
          - np
          - nl
          - an
          - nc
          - nz
          - ni
          - ne
          - ng
          - nu
          - nf
          - mp
          - 'no'
          - om
          - pk
          - pw
          - ps
          - pa
          - pg
          - py
          - pe
          - ph
          - pn
          - pl
          - pt
          - pr
          - qa
          - re
          - ro
          - ru
          - rw
          - sh
          - kn
          - lc
          - pm
          - vc
          - ws
          - sm
          - st
          - sa
          - sn
          - rs
          - sc
          - sl
          - sg
          - sk
          - si
          - sb
          - so
          - za
          - gs
          - es
          - lk
          - sd
          - sr
          - sj
          - sz
          - se
          - ch
          - sy
          - tw
          - tj
          - tz
          - th
          - tg
          - tk
          - to
          - tt
          - tn
          - tr
          - tm
          - tc
          - tv
          - ug
          - ua
          - ae
          - uk
          - gb
          - us
          - um
          - uy
          - uz
          - vu
          - ve
          - vn
          - vg
          - vi
          - wf
          - eh
          - ye
          - zm
          - zw
          default: us
      - name: hl
        in: query
        required: false
        description: Interface language of the search (two-letter language code).
        schema:
          type: string
          enum:
          - af
          - ak
          - sq
          - am
          - ar
          - hy
          - az
          - eu
          - be
          - bem
          - bn
          - bh
          - bs
          - br
          - bg
          - km
          - ca
          - chr
          - ny
          - zh-CN
          - zh-TW
          - co
          - hr
          - cs
          - da
          - nl
          - en
          - eo
          - et
          - ee
          - fo
          - tl
          - fi
          - fr
          - fy
          - gaa
          - gl
          - ka
          - de
          - el
          - gn
          - gu
          - ht
          - ha
          - haw
          - iw
          - hi
          - hu
          - is
          - ig
          - id
          - ia
          - ga
          - it
          - ja
          - jw
          - kn
          - kk
          - rw
          - rn
          - kg
          - ko
          - kri
          - ku
          - ckb
          - ky
          - lo
          - la
          - lv
          - ln
          - lt
          - loz
          - lg
          - ach
          - mk
          - mg
          - ms
          - ml
          - mt
          - mi
          - mr
          - mfe
          - mo
          - mn
          - sr-ME
          - my
          - ne
          - pcm
          - nso
          - 'no'
          - nn
          - oc
          - or
          - om
          - ps
          - fa
          - pl
          - pt
          - pt-BR
          - pt-PT
          - pa
          - qu
          - ro
          - rm
          - nyn
          - ru
          - gd
          - sr
          - sh
          - st
          - tn
          - crs
          - sn
          - sd
          - si
          - sk
          - sl
          - so
          - es
          - es-419
          - su
          - sw
          - sv
          - tg
          - ta
          - tt
          - te
          - th
          - ti
          - to
          - lua
          - tum
          - tr
          - tk
          - tw
          - ug
          - uk
          - ur
          - uz
          - vi
          - cy
          - wo
          - xh
          - yi
          - yo
          - zu
          default: en
      responses:
        '200':
          description: A Google Maps Directions result envelope.
