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.
The examples use a time zone of UTC+1.
{{ 1710510600 | timestamp_local }}
2024-03-15T14:50: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 = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.
The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.
How to read a signature
Here is the signature of the round filter as an example:
round(
value: Any,
precision: int = 0,
method: str = "common",
default: Any,
) -> float | int | Any
-
roundis the name of the function. - Between the parentheses are the parameters. Each parameter has a name, followed by a colon and the type of value the parameter expects. The type only tells you what kind of value to pass. For
default: Any, you pass a value of any type, such as0or"unknown", not the wordAny. -
= 0and= "common"are default values. You can leave outprecisionandmethod, androunduses these default values. -
defaulthas no=, but the parameter list marksdefaultas optional. If you leave outdefaultandroundgets a value that isn’t a number,roundraises an error. -
->shows the type of value the function returns. - Inside a signature,
|means “or”. This function returns a decimal number, a whole number, or the value you passed asdefault.
round is a filter, so the first parameter, value, is the value before the |. For example, {{ 3.14159 | round(2) }} returns 3.14.
The types you’ll see most often:
-
str: text, such as"hello" -
int: a whole number, such as5 -
float: a decimal number, such as3.14 -
bool:trueorfalse -
list: a list of values, such as[1, 2, 3].list[str]is a list of texts. -
dict: a set of keys and values, such as{"name": "Kitchen"} -
datetimeandtimedelta: a date and time, and a duration. For details, refer to Dates and times. -
None: no value -
Any: any type of value
Some signatures use special forms:
-
*argsmeans you can pass any number of values, separated by commas. For example,average(1, 2, 3). -
value | name(...)means the function is a filter. The value before the|is passed to the filter as its first parameter. Some filter signatures, like theroundexample, show this value as the first parameter between the parentheses instead.
value | timestamp_local(
default: Any,
) -> 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. float(none) turns invalid text into none, so the default is used.
{{ "invalid" | float(none) | 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_timestampfirst. - The result is a string, not a datetime object. To do datetime math, use
as_localinstead. - The input must be a number, not text. A numeric string such as
"1700000000"fails too. Convert states withfloatorintfirst. - Without a
default, the filter raises an error if the input isn’t a number.
Try it yourself
Ready to test this? Open Settings > 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-15T14: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-15T14: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.
AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.
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.