Format timestamp as local time: timestamp_local

The timestamp_local filter formats a UNIX timestamp as a datetime string in your local time zone. It returns the date and time in the standard ISO-like format, automatically converting from UTC to the time zone configured in Home Assistant.

This is a quick way to turn a UNIX timestamp into a readable local date and time without needing to specify a format string. If you need a custom format, use timestamp_custom instead. If you want the UTC representation, use timestamp_utc. This filter is particularly useful for displaying sensor attributes or API responses that provide times as UNIX timestamps.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

{{ 1710510600 | timestamp_local }}

2024-03-15 14:30:00+01:00

Function signature

The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).

Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically. Function parameters without a default are required.

value | timestamp_local(
    default: Any = None,
) -> str | Any

Function parameters

The following parameters can be provided to this filter.

Using a default value

If the input might not be a valid timestamp, provide a default to avoid errors.

{{ "invalid" | float(0) | timestamp_local(default="unknown") }}

unknown

Good to know

• The input must be a UNIX timestamp (a number of seconds). Pass a datetime object through as_timestamp first.
• The result is a string, not a datetime object. To do datetime math, use as_local instead.
• Without a default, the filter raises an error for non-numeric inputs.

Try it yourself

Ready to test this? Open Developer tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more].

More examples

Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.

Display a sensor’s last changed time

Convert the last changed timestamp of an entity to a readable local time string.

{{ as_timestamp(states.sensor.temperature.last_changed) | timestamp_local }}

2024-03-15 14:30:00+01:00

Show the current time as a formatted string

Convert the current UNIX timestamp to a local datetime string.

{{ as_timestamp(now()) | timestamp_local }}

2024-03-15 14:30:00+01:00

Use in a notification

Include a formatted local timestamp in a notificationYou can use notifications to send messages, pictures, and more, to devices. [Learn more] message.

action:
  - action: notify.mobile
    data:
      message: >
        Motion detected at
        {{
          as_timestamp(states.binary_sensor.motion.last_changed)
          | timestamp_local
        }}

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.

Related template functions

These functions work well alongside this one:

• Format timestamp as UTC time: timestamp_utc - Formats a UNIX timestamp as a UTC datetime string.

• Format timestamp with custom format: timestamp_custom - Formats a UNIX timestamp as a string using a custom format.

• Convert to UNIX timestamp: as_timestamp - Converts a datetime object or string to a UNIX timestamp.

• Convert to local time zone: as_local - Converts a datetime object to your local time zone.