Reference: Get Time Zone

http://api.timezonedb.com/v2.1/get-time-zone

Get local time of a city by its name, time zone, latitude & longtiude, or IP address.

Other End Points

Parameters

Parameter Description
key
REQUIRED
Your unique API key you get after register your account.
format
OPTIONAL
The response format from API. It can be either xml or json.

DEFAULT: xml
callback
OPTIONAL
Use for JavaScript JSON callback.
fields
OPTIONAL
Customize the field to display in response. Use commas ("," without spaces) to separate the field names.

FIELDS: countryCode, countryName, regionName, cityName, zoneName, abbreviation, gmtOffset, dst, zoneStart, zoneEnd, nextAbbreviation, timestamp, formatted
DEFAULT: all
by
REQUIRED
The method of lookup.
  • zone - Lookup local time by using a time zone name.
  • position - Lookup local time by using latitude & longitude of a city.
  • PREMIUM
    city - Lookup time zone by searching city name.
  • PREMIUM
    ip - Lookup time zone based on visitor IP address.
zone
REQUIRED
A time zone abbreviation or time zone name. Required if lookup by zone method.
lat
REQUIRED
Latitude of a city. Required if lookup by position method.
lng
REQUIRED
Longitude of a city. Required if lookup by position method.
country
REQUIRED
A valid ISO 3166 country code. Required if lookup by city method.
region
OPTIONAL
A valid region code of United States. Optional when lookup by city method to limit the search result.
city
REQUIRED
The name of a city. Use asterisk (*) for wildcard search. Required if lookup by city method.
page
OPTIONAL
Navigate to other page when result is more than 10 records.
time
OPTIONAL
Unix time in UTC.

DEFAULT: Current UTC time.

Responses

Field Description
status Status of the API query. Either OK or FAILED.
message Error message. Empty if no error.
countryCode Country code of the time zone.
countryName Country name of the time zone.
regionName
PREMIUM
Region / State name of the time zone.
cityName
PREMIUM
City / Place name of the time zone.
zoneName The time zone name.
abbreviation Abbreviation of the time zone.
gmtOffset The time offset in seconds based on UTC time.
dst Whether Daylight Saving Time (DST) is used. Either 0 (No) or 1 (Yes).
zoneStart The Unix time in UTC when current time zone start.
zoneEnd The Unix time in UTC when current time zone end.
timestamp Current local time in Unix time. Minus the value with gmtOffset to get UTC time.
formatted Formatted timestamp in Y-m-d h:i:s format. E.g.: 2020-11-27 21:17:43
totalPage The total page of result when exceed 25 records.
currentPage Current page when navigating.

Usage Examples

Get current local time at Statue of Liberty using latitude & longitude

Query
http://api.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=xml&by=position&lat=40.689247&lng=-74.044502
Response
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <status>OK</status>
  <message/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>New York</regionName>
  <cityName>Statue of Liberty</cityName>
  <zoneName>America/New_York</zoneName>
  <abbreviation>EST</abbreviation>
  <gmtOffset>-18000</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604210400</zoneStart>
  <zoneEnd>1615705200</zoneEnd>
  <nextAbbreviation>EDT</nextAbbreviation>
  <timestamp>1606493863</timestamp>
  <formatted>2020-11-27 16:17:43</formatted>
</result>
Query
http://api.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=json&by=position&lat=40.689247&lng=-74.044502
Response
{
    "status": "OK",
    "message": "",
    "countryCode": "US",
    "countryName": "United States",
    "regionName": "New York",
    "cityName": "Statue of Liberty",
    "zoneName": "America\/New_York",
    "abbreviation": "EST",
    "gmtOffset": -18000,
    "dst": "0",
    "zoneStart": 1604210400,
    "zoneEnd": 1615705200,
    "nextAbbreviation": "EDT",
    "timestamp": 1606493864,
    "formatted": "2020-11-27 16:17:44"
}

 

Get current local time in Chicago, USA

Query
http://api.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=xml&by=zone&zone=America/Chicago
Response
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <status>OK</status>
  <message/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName/>
  <cityName/>
  <zoneName>America/Chicago</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>-21600</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604214000</zoneStart>
  <zoneEnd>1615708800</zoneEnd>
  <nextAbbreviation>CDT</nextAbbreviation>
  <timestamp>1606490264</timestamp>
  <formatted>2020-11-27 15:17:44</formatted>
</result>
Query
http://api.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=json&by=zone&zone=America/Chicago
Response
{
    "status": "OK",
    "message": "",
    "countryCode": "US",
    "countryName": "United States",
    "regionName": "",
    "cityName": "",
    "zoneName": "America\/Chicago",
    "abbreviation": "CST",
    "gmtOffset": -21600,
    "dst": "0",
    "zoneStart": 1604214000,
    "zoneEnd": 1615708800,
    "nextAbbreviation": "CDT",
    "timestamp": 1606490265,
    "formatted": "2020-11-27 15:17:45"
}

 

Get current local time in Taipei, Taiwan when UTC is 27 November, 2020 09:17:45 PM

Query
http://api.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=xml&by=zone&zone=Asia/Taipei&time=1606511865
Response
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <status>OK</status>
  <message/>
  <countryCode>TW</countryCode>
  <countryName>Taiwan</countryName>
  <regionName/>
  <cityName/>
  <zoneName>Asia/Taipei</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>28800</gmtOffset>
  <dst>0</dst>
  <zoneStart>307551600</zoneStart>
  <zoneEnd/>
  <nextAbbreviation/>
  <timestamp>1606540665</timestamp>
  <formatted>2020-11-28 05:17:45</formatted>
</result>
Query
http://api.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=json&by=zone&zone=Asia/Taipei&time=1606511865
Response
{
    "status": "OK",
    "message": "",
    "countryCode": "TW",
    "countryName": "Taiwan",
    "regionName": "",
    "cityName": "",
    "zoneName": "Asia\/Taipei",
    "abbreviation": "CST",
    "gmtOffset": 28800,
    "dst": "0",
    "zoneStart": 307551600,
    "zoneEnd": null,
    "nextAbbreviation": null,
    "timestamp": 1606540665,
    "formatted": "2020-11-28 05:17:45"
}

 

Get local time zone for City of Buffalo in US (Premium Subscription Only)

Query
http://vip.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=xml&by=city&city=City+of+Buffalo&country=US
Response
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <status>OK</status>
  <message/>
  <totalPage>1</totalPage>
  <currentPage>1</currentPage>
  <zones/>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>Iowa</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/Chicago</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>-21600</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604214000</zoneStart>
  <timestamp>1606490266</timestamp>
  <formatted>2020-11-27 15:17:46</formatted>
  <zoneEnd>1615708800</zoneEnd>
  <nextAbbreviation>CDT</nextAbbreviation>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>Kansas</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/Chicago</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>-21600</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604214000</zoneStart>
  <timestamp>1606490266</timestamp>
  <formatted>2020-11-27 15:17:46</formatted>
  <zoneEnd>1615708800</zoneEnd>
  <nextAbbreviation>CDT</nextAbbreviation>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>Minnesota</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/Chicago</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>-21600</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604214000</zoneStart>
  <timestamp>1606490266</timestamp>
  <formatted>2020-11-27 15:17:46</formatted>
  <zoneEnd>1615708800</zoneEnd>
  <nextAbbreviation>CDT</nextAbbreviation>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>Missouri</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/Chicago</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>-21600</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604214000</zoneStart>
  <timestamp>1606490266</timestamp>
  <formatted>2020-11-27 15:17:46</formatted>
  <zoneEnd>1615708800</zoneEnd>
  <nextAbbreviation>CDT</nextAbbreviation>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>North Dakota</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/Chicago</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>-21600</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604214000</zoneStart>
  <timestamp>1606490266</timestamp>
  <formatted>2020-11-27 15:17:46</formatted>
  <zoneEnd>1615708800</zoneEnd>
  <nextAbbreviation>CDT</nextAbbreviation>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>New York</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/New_York</zoneName>
  <abbreviation>EST</abbreviation>
  <gmtOffset>-18000</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604210400</zoneStart>
  <timestamp>1606493866</timestamp>
  <formatted>2020-11-27 16:17:46</formatted>
  <zoneEnd>1615705200</zoneEnd>
  <nextAbbreviation>EDT</nextAbbreviation>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>Texas</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/Chicago</zoneName>
  <abbreviation>CST</abbreviation>
  <gmtOffset>-21600</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604214000</zoneStart>
  <timestamp>1606490266</timestamp>
  <formatted>2020-11-27 15:17:46</formatted>
  <zoneEnd>1615708800</zoneEnd>
  <nextAbbreviation>CDT</nextAbbreviation>
  <zone/>
  <countryCode>US</countryCode>
  <countryName>United States</countryName>
  <regionName>Wyoming</regionName>
  <cityName>City of Buffalo</cityName>
  <zoneName>America/Denver</zoneName>
  <abbreviation>MST</abbreviation>
  <gmtOffset>-25200</gmtOffset>
  <dst>0</dst>
  <zoneStart>1604217600</zoneStart>
  <timestamp>1606486666</timestamp>
  <formatted>2020-11-27 14:17:46</formatted>
  <zoneEnd>1615712400</zoneEnd>
  <nextAbbreviation>MDT</nextAbbreviation>
</result>
Query
http://vip.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=json&by=city&city=City+of+Buffalo&country=US
Response
{
    "status": "OK",
    "message": "",
    "totalPage": 1,
    "currentPage": 1,
    "zones": [
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "Iowa",
            "cityName": "City of Buffalo",
            "zoneName": "America\/Chicago",
            "abbreviation": "CST",
            "gmtOffset": -21600,
            "dst": "0",
            "zoneStart": 1604214000,
            "timestamp": 1606490267,
            "formatted": "2020-11-27 15:17:47",
            "zoneEnd": 1615708800,
            "nextAbbreviation": "CDT"
        },
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "Kansas",
            "cityName": "City of Buffalo",
            "zoneName": "America\/Chicago",
            "abbreviation": "CST",
            "gmtOffset": -21600,
            "dst": "0",
            "zoneStart": 1604214000,
            "timestamp": 1606490267,
            "formatted": "2020-11-27 15:17:47",
            "zoneEnd": 1615708800,
            "nextAbbreviation": "CDT"
        },
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "Minnesota",
            "cityName": "City of Buffalo",
            "zoneName": "America\/Chicago",
            "abbreviation": "CST",
            "gmtOffset": -21600,
            "dst": "0",
            "zoneStart": 1604214000,
            "timestamp": 1606490267,
            "formatted": "2020-11-27 15:17:47",
            "zoneEnd": 1615708800,
            "nextAbbreviation": "CDT"
        },
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "Missouri",
            "cityName": "City of Buffalo",
            "zoneName": "America\/Chicago",
            "abbreviation": "CST",
            "gmtOffset": -21600,
            "dst": "0",
            "zoneStart": 1604214000,
            "timestamp": 1606490267,
            "formatted": "2020-11-27 15:17:47",
            "zoneEnd": 1615708800,
            "nextAbbreviation": "CDT"
        },
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "North Dakota",
            "cityName": "City of Buffalo",
            "zoneName": "America\/Chicago",
            "abbreviation": "CST",
            "gmtOffset": -21600,
            "dst": "0",
            "zoneStart": 1604214000,
            "timestamp": 1606490267,
            "formatted": "2020-11-27 15:17:47",
            "zoneEnd": 1615708800,
            "nextAbbreviation": "CDT"
        },
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "New York",
            "cityName": "City of Buffalo",
            "zoneName": "America\/New_York",
            "abbreviation": "EST",
            "gmtOffset": -18000,
            "dst": "0",
            "zoneStart": 1604210400,
            "timestamp": 1606493867,
            "formatted": "2020-11-27 16:17:47",
            "zoneEnd": 1615705200,
            "nextAbbreviation": "EDT"
        },
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "Texas",
            "cityName": "City of Buffalo",
            "zoneName": "America\/Chicago",
            "abbreviation": "CST",
            "gmtOffset": -21600,
            "dst": "0",
            "zoneStart": 1604214000,
            "timestamp": 1606490267,
            "formatted": "2020-11-27 15:17:47",
            "zoneEnd": 1615708800,
            "nextAbbreviation": "CDT"
        },
        {
            "countryCode": "US",
            "countryName": "United States",
            "regionName": "Wyoming",
            "cityName": "City of Buffalo",
            "zoneName": "America\/Denver",
            "abbreviation": "MST",
            "gmtOffset": -25200,
            "dst": "0",
            "zoneStart": 1604217600,
            "timestamp": 1606486667,
            "formatted": "2020-11-27 14:17:47",
            "zoneEnd": 1615712400,
            "nextAbbreviation": "MDT"
        }
    ]
}

 

Get time zone by IP address with custom fields (Premium Subscription Only)

Query
http://vip.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=xml&by=ip&ip=3.94.21.209&fields=countryCode,cityName,gmtOffset,dst
Response
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <status>OK</status>
  <message/>
  <countryCode>US</countryCode>
  <cityName>Ashburn</cityName>
  <gmtOffset>-18000</gmtOffset>
  <dst>0</dst>
</result>
Query
http://vip.timezonedb.com/v2.1/get-time-zone?key=YOUR_API_KEY&format=json&by=ip&ip=3.94.21.209&fields=countryCode,cityName,gmtOffset,dst
Response
{
    "status": "OK",
    "message": "",
    "countryCode": "US",
    "cityName": "Ashburn",
    "gmtOffset": -18000,
    "dst": "0"
}