Google Maps Platform Time Zone API

openapi: 3.2.0
info:
  title: Google Maps Platform Time Zone API
  description: API Specification for Google Maps Platform
  version: 1.22.3
servers:
- url: https://www.googleapis.com
security:
- ApiKeyAuth: []
tags:
- name: Time Zone API
paths:
  /maps/api/timezone/json:
    get:
      operationId: timezone
      servers:
      - url: https://maps.googleapis.com
      tags:
      - Time Zone API
      description: The Time Zone API provides a simple interface to request the time zone for locations on the surface of the earth, as well as the time offset from UTC for each of those locations. You request the time zone information for a specific latitude/longitude pair and date. The API returns the name of that time zone, the time offset from UTC, and the daylight savings offset.
      parameters:
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/timezone_location'
      - $ref: '#/components/parameters/timezone_timestamp'
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              examples:
                timezone:
                  value:
                    dstOffset: 0
                    rawOffset: -28800
                    status: OK
                    timeZoneId: America/Los_Angeles
                    timeZoneName: Pacific Standard Time
                timezone_dstoffset:
                  value:
                    dstOffset: 3600
                    rawOffset: -28800
                    status: OK
                    timeZoneId: America/Los_Angeles
                    timeZoneName: Pacific Daylight Time
                timezone_invalid:
                  value:
                    status: INVALID_REQUEST
                timezone_not_found:
                  value:
                    status: ZERO_RESULTS
                timezone_request_denied_response:
                  value:
                    errorMessage: You must use an API key to authenticate each request to Google Maps Platform APIs. For additional information, please refer to http://g.co/dev/maps-no-account
                    status: REQUEST_DENIED
              schema:
                $ref: '#/components/schemas/TimeZoneResponse'
      summary: Timezone
      x-summary-source: derived
components:
  parameters:
    language:
      name: language
      in: query
      description: 'The language in which to return results.


        * See the [list of supported languages](https://developers.google.com/maps/faq#languagesupport). Google often updates the supported languages, so this list may not be exhaustive.

        * If `language` is not supplied, the API attempts to use the preferred language as specified in the `Accept-Language` header.

        * The API does its best to provide a street address that is readable for both the user and locals. To achieve that goal, it returns street addresses in the local language, transliterated to a script readable by the user if necessary, observing the preferred language. All other addresses are returned in the preferred language. Address components are all returned in the same language, which is chosen from the first component.

        * If a name is not available in the preferred language, the API uses the closest match.

        * The preferred language has a small influence on the set of results that the API chooses to return, and the order in which they are returned. The geocoder interprets abbreviations differently depending on language, such as the abbreviations for street types, or synonyms that may be valid in one language but not in another. For example, _utca_ and _tér_ are synonyms for street in Hungarian.'
      schema:
        type: string
        default: en
        enum:
        - ar
        - bg
        - bn
        - ca
        - cs
        - da
        - de
        - el
        - en
        - en-AU
        - en-GB
        - es
        - eu
        - fa
        - fi
        - fil
        - fr
        - gl
        - gu
        - hi
        - hr
        - hu
        - id
        - it
        - iw
        - ja
        - kn
        - ko
        - lt
        - lv
        - ml
        - mr
        - nl
        - 'no'
        - pl
        - pt
        - pt-BR
        - pt-PT
        - ro
        - ru
        - sk
        - sl
        - sr
        - sv
        - ta
        - te
        - th
        - tl
        - tr
        - uk
        - vi
        - zh-CN
        - zh-TW
    timezone_location:
      name: location
      description: 'A comma-separated latitude,longitude tuple, `location=39.6034810,-119.6822510`, representing the location to look up.

        '
      schema:
        type: string
      required: true
      in: query
      example: 39.6034810,-119.6822510
    timezone_timestamp:
      name: timestamp
      in: query
      description: "The desired time as seconds since midnight, January 1, 1970 UTC. The Time Zone API uses the `timestamp` to determine whether or not Daylight Savings should be applied, based on the time zone of the `location`. \n\nNote that the API does not take historical time zones into account. That is, if you specify a past timestamp, the API does not take into account the possibility that the location was previously in a different time zone.\n"
      schema:
        type: number
      required: true
      example: 1331161200
  schemas:
    TimeZoneStatus:
      type: string
      title: TimeZoneStatus
      description: "The `status` field within the Time Zone response object contains the status of the request. The `status` field may contain the following values:\n\n- `OK` indicates that the request was successful.\n- `INVALID_REQUEST` indicates that the request was malformed.\n- `OVER_DAILY_LIMIT` indicates any of the following:\n  - The API key is missing or invalid.\n  - Billing has not been enabled on your account.\n  - A self-imposed usage cap has been exceeded.\n  - The provided method of payment is no longer valid (for example, a credit card has expired).\n\n- `OVER_QUERY_LIMIT` indicates the requestor has exceeded quota.\n- `REQUEST_DENIED` indicates that the API did not complete the request. Confirm that the request was sent over HTTPS instead of HTTP.\n- `UNKNOWN_ERROR` indicates an unknown error.\n- `ZERO_RESULTS` indicates that no time zone data could be found for the specified position or time. Confirm that the request is for a location on land, and not over water.\n"
      enum:
      - OK
      - INVALID_REQUEST
      - OVER_DAILY_LIMIT
      - OVER_QUERY_LIMIT
      - REQUEST_DENIED
      - UNKNOWN_ERROR
      - ZERO_RESULTS
    TimeZoneResponse:
      type: object
      title: TimeZoneResponse
      required:
      - status
      properties:
        dstOffset:
          description: The offset for daylight-savings time in seconds. This will be zero if the time zone is not in Daylight Savings Time during the specified `timestamp`.
          type: number
        rawOffset:
          description: The offset from UTC (in seconds) for the given location. This does not take into effect daylight savings.
          type: number
        timeZoneId:
          description: a string containing the ID of the time zone, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR) project](http://cldr.unicode.org/), and currently available in file timezone.xml. When a timezone has several IDs, the canonical one is returned. In xml responses, this is the first alias of each timezone. For example, "Asia/Calcutta" is returned, not "Asia/Kolkata".
          type: string
        timeZoneName:
          description: The long form name of the time zone. This field will be localized if the language parameter is set. eg. `Pacific Daylight Time` or `Australian Eastern Daylight Time`.
          type: string
        status:
          $ref: '#/components/schemas/TimeZoneStatus'
        errorMessage:
          description: Detailed information about the reasons behind the given status code. Included if status other than `Ok`.
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: key