Timezone - Get Timezone By Coordinates

Use to get the current, historical, and future time zone information for the specified latitude-longitude pair.
The Get Timezone By Coordinates API is an HTTP GET request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location, with the exception of regions that observe solar days.

GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&query={query}

GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}

URI Parameters

Request Header

Responses

Security

AadToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.\n* \nThe Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. \n* \nThe Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see Microsoft identity platform overview.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

subscription-key

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: header

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

Successfully retrieve timezone by coordinates

GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122

{
  "referenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z",
  "timeZones": [
    {
      "aliases": [
        "US/Pacific",
        "US/Pacific-New"
      ],
      "countries": [
        {
          "code": "US",
          "name": "United States"
        }
      ],
      "id": "America/Los_Angeles",
      "names": {
        "daylight": "Pacific Daylight Time",
        "generic": "Pacific Time",
        "iso6391LanguageCode": "en",
        "standard": "Pacific Standard Time"
      },
      "referenceTime": {
        "daylightSavings": "01:00:00",
        "posixTz": "PST+8PDT,M3.2.0,M11.1.0",
        "posixTzValidYear": 2019,
        "standardOffset": "-08:00:00",
        "sunrise": "2019-06-17T05:12:21.267-07:00",
        "sunset": "2019-06-17T21:05:18.017-07:00",
        "tag": "PDT",
        "wallTime": "2019-06-17T15:16:59.0765556-07:00"
      },
      "representativePoint": {
        "latitude": 34.05222222222222,
        "longitude": -118.24277777777777
      },
      "timeTransitions": [
        {
          "daylightSavings": "01:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PDT",
          "utcEnd": "2019-11-03T09:00:00Z",
          "utcStart": "2019-03-10T10:00:00Z"
        },
        {
          "daylightSavings": "00:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PST",
          "utcEnd": "2020-03-08T10:00:00Z",
          "utcStart": "2019-11-03T09:00:00Z"
        },
        {
          "daylightSavings": "01:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PDT",
          "utcEnd": "2020-11-01T09:00:00Z",
          "utcStart": "2020-03-08T10:00:00Z"
        }
      ]
    }
  ],
  "version": "2019a"
}

Definitions

CountryRecord

A country/region record.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

JsonFormat

Desired format of the response. Only json format is supported.

ReferenceTime

Details in effect at the local time.

RepresentativePoint

Representative point property

TimeTransition

Represents a time zone transition.

TimezoneId

Timezone ID information.

TimezoneNames

Timezone names object.

TimezoneOptions

Options for timezone information returned in the result.

TimezoneResult

This object is returned from a successful Timezone By ID call or By Coordinates call