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.

Endpoints

IPv4 only API Endpoint

Use this endpoint to force API calls routed over the IPv4 network only

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

Dual-Stack API Endpoint

This endpoint has native IPv6 support and backs the API calls routed over both IPv4 and IPv6 networks

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
Success

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
Time Zone name in IANA format
displayNamestring
Display name
effectiveTimeZoneFullstring
Effective time zone full name (adjusted to the daylight saving status)
effectiveTimeZoneShortstring
Effective time zone short name (adjusted to the daylight saving status)
utcOffsetSecondsinteger
Effective offset from UTC time in seconds
utcOffsetstring
Effective offset from UTC time
isDaylightSavingTimeboolean
Indicates if the daylight saving is on
localTimestring
Local time in ISO 8601 format
utcTimestring
UTC time in ISO 8601 format. Omitted when utcReference parameter was not supplied, or 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?