BigDataCloud Logo

Time Zone by Location API

Introduction

BigDataCloud’s Time Zone by Location API is a useful API that takes latitude/longitude coordinates as input and provides detailed Time Zone information, such as offsets for UTC and daylight savings time.

By utilising this Time Zone API, you can develop features to display time zone IDs and local times for your user’s locations and provide time-based data corresponding to the user's location on websites or mobile applications.

Additionally, daylight saving time information from the API can be utilised to automatically update your application's time zone data, ensuring accuracy and precision.

Get Started

This API is part of the Reverse Geocoding API Package and is available in free and paid plans. Please visit the Reverse Geocoding API Package package page for limits and pricing information.

Endpoint

GET
https://api-bdc.net/data/timezone-by-location

Request

Parameter
latitude
Type
number (double)
Required
Yes
Description
Latitude value as per WGS 84 reference system (GPS system). Expected values are in [-90, 90] range
Parameter
longitude
Type
number (double)
Required
Yes
Description
Longitude value as per WGS 84 reference system (GPS system). Expected values are in [-180, 180] range
Parameter
utcReference
Type
integer (int64)
Required
Optional, default value: 0
Description
UTC time reference in Unix Time Seconds format. When omitted or invalid, the current time is assumed
Parameter
key
Type
string
Required
Yes
Description
Your API key

Responses

200
OK

Sample Query

GET
https://api-bdc.net/data/timezone-by-location?latitude=-34.9313&longitude=138.59669&key=[YOUR API KEY]

Schema

application/json
ianaTimeIdstring
The unique identifier of the time zone from the IANA Time Zone Database (e.g., "America/New_York").
displayNamestring
displayName object
effectiveTimeZoneFullstring
The full name of the effective time zone, adjusted for daylight saving (e.g., "Eastern Daylight Time").
effectiveTimeZoneShortstring
The abbreviated name of the effective time zone, adjusted for daylight saving (e.g., "EDT").
utcOffsetSecondsinteger
The effective offset from UTC in seconds, adjusted for daylight saving time.
utcOffsetstring
The effective offset from UTC, formatted as a string and adjusted for daylight saving time.
isDaylightSavingTimeboolean
A boolean value indicating whether daylight saving time is currently in effect.
localTimestring
The current local time in the specified time zone, formatted in ISO 8601 "O" format.
utcTimestring
The corresponding UTC time, formatted in ISO 8601 "O" format. This value is omitted if the 'utcReference' parameter was not supplied or was invalid.

Sample Response

JSON View
400
Bad request

Sample Response

JSON View
401
Invalid coordinates

Sample Response

JSON View
403
Access denied, or your quota limit has exceeded

Sample Response

JSON View
404
Found no valid entry for the request

Sample Response

JSON View
500
An error has occurred and did not complete your request. Please try again

Sample Response

JSON View
Was this page helpful?