SAsavvycal
Time Zones

Get time zone

get/v1/time_zones/{time_zone}

Request

Path parameters

time_zonestring required

The IANA time zone ID, such as America/Chicago. Send the slashes as-is, not URL-encoded as %2F.

Query parameters

instantstring date-time

The moment to describe the time zone at. Defaults to the current time.

Response

Success

abbreviationstring required

Time zone abbreviation (e.g., 'CST', 'CDT').

aliasesstring[] required

Other IDs for the zone, such as US/Central.

canonicalboolean required

Whether this is the canonical time zone identifier in the IANA database.

dstboolean required

Whether daylight saving time is in effect at instant.

formatted_offsetstring required

Human-readable offset (e.g., '-06:00').

generic_long_namestring required

The generic name of the time zone's metazone (absent of any daylight saving time modifiers). For example, the generic name for US Central Time is Central Time, whereas the non-generic is either Central Daylight Time or Central Standard Time, depending on the time of year.

goldenboolean required

Whether the time zone is considered a golden zone in the CLDR database.

idstring required

The IANA (Olson) time zone ID, such as America/Chicago.

legacyboolean required

Whether the time zone is a "legacy" zone that does not conform to the standard Olson identifier format.

long_namestring required

The most specific name for the time zone's metazone, which may include daylight saving time modifiers at the specified instant. For example, the long name for US Central Time is either "Central Daylight Time" or "Central Standard Time", depending on the time of year.

offsetinteger required

Seconds offset from UTC at instant, including any daylight saving time shift.

offset_stdinteger required

Seconds of daylight saving time shift at instant. Zero in standard time.

offset_utcinteger required

Seconds offset from UTC in standard time.

Example response

{
  "abbreviation": "CST",
  "aliases": [
    "US/Central"
  ],
  "canonical": true,
  "dst": false,
  "formatted_offset": "-06:00",
  "generic_long_name": "Central Time",
  "golden": true,
  "id": "America/Chicago",
  "legacy": false,
  "long_name": "Central Standard Time",
  "metazone": {
    "exemplar_city": null,
    "long": {
      "current": "Central Standard Time",
      "daylight": "Central Daylight Time",
      "generic": "Central Time",
      "standard": "Central Standard Time"
    },
    "name": "America_Central",
    "short": {
      "current": "CST",
      "daylight": "CDT",
      "generic": "CT",
      "standard": "CST"
    },
    "territories": [
      "001"
    ]
  },
  "offset": -21600,
  "offset_std": 0,
  "offset_utc": -21600,
  "period": {
    "from": "2023-11-05T01:00:00-05:00",
    "until": "2024-03-10T01:59:59.999999-06:00"
  },
  "windows_zone": {
    "name": "Central Standard Time"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.