Time Zone Info API
Introduction
Our Time Zone Info API is a potent yet straightforward tool that provides in-depth active IANA time zone information, including daylight saving time adjustments if relevant. Additionally, it returns the current local time by default, and if given a UTC reference time, it automatically performs time zone conversion for you.
Get Started
This API is part of the IP Geolocation API Package and is available in free and paid plans. Please visit the IP Geolocation API Package package page for limits and pricing information.
Endpoint
GET
https://api-bdc.net/data/timezone-info
Request
Parameter
Type
Required
Description
Parameter
timeZoneIdType
stringRequired
YesDescription
Time Zone name in IANA format, for example 'Australia/Sydney'Parameter
utcReferenceType
integer (int64)Required
Optional, default value: 0Description
UTC reference in Unix Time Seconds format. When omitted or invalid, the current time is assumedParameter
keyType
stringRequired
YesDescription
Your API keyResponses
200OK
200
OK
Sample Query
GET
https://api-bdc.net/data/timezone-info?timeZoneId=Australia/Sydney&key=[YOUR API KEY]
Schema
application/json
ianaTimeIdstringThe unique identifier of the time zone from the IANA Time Zone Database (e.g., "America/New_York").
ianaTimeIdstring
The unique identifier of the time zone from the IANA Time Zone Database (e.g., "America/New_York").
displayNamestringdisplayName object
displayNamestring
displayName object
effectiveTimeZoneFullstringThe full name of the effective time zone, adjusted for daylight saving (e.g., "Eastern Daylight Time").
effectiveTimeZoneFullstring
The full name of the effective time zone, adjusted for daylight saving (e.g., "Eastern Daylight Time").
effectiveTimeZoneShortstringThe abbreviated name of the effective time zone, adjusted for daylight saving (e.g., "EDT").
effectiveTimeZoneShortstring
The abbreviated name of the effective time zone, adjusted for daylight saving (e.g., "EDT").
utcOffsetSecondsintegerThe effective offset from UTC in seconds, adjusted for daylight saving time.
utcOffsetSecondsinteger
The effective offset from UTC in seconds, adjusted for daylight saving time.
utcOffsetstringThe effective offset from UTC, formatted as a string and adjusted for daylight saving time.
utcOffsetstring
The effective offset from UTC, formatted as a string and adjusted for daylight saving time.
isDaylightSavingTimebooleanA boolean value indicating whether daylight saving time is currently in effect.
isDaylightSavingTimeboolean
A boolean value indicating whether daylight saving time is currently in effect.
localTimestringThe current local time in the specified time zone, formatted in ISO 8601 "O" format.
localTimestring
The current local time in the specified time zone, formatted in ISO 8601 "O" format.
utcTimestringThe corresponding UTC time, formatted in ISO 8601 "O" format. This value is omitted if the 'utcReference' parameter was not supplied or was invalid.
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
400Bad request
400
Bad request
Sample Response
JSON View
403Access denied, or your quota limit has exceeded
403
Access denied, or your quota limit has exceeded
Sample Response
JSON View
404Found no valid entry for the request
404
Found no valid entry for the request
Sample Response
JSON View
500An error has occurred and did not complete your request. Please try again
500
An error has occurred and did not complete your request. Please try again
Sample Response
JSON View
Was this page helpful?