Test if integer: integer

The integer test checks whether a value is an integer. It returns true if the value is of integer type and false for any other type, including floats and strings that contain numeric characters.

This test is useful when you need to verify that a value is specifically an integer rather than a float or string. For example, some entityAn 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] attributes return integers for discrete counts (like the number of connected devices) while others return floats for measurements. This test lets you confirm the type before proceeding with type-specific logic.

Usage

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

{% if 42 is integer %}
  It is an integer
{% endif %}

It is an integer

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.

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any

integer(
    value: Any,
) -> bool

Function parameters

The following parameters can be provided to this test.

Good to know

• Booleans do not pass this test. true and false return false.
• Numeric strings like "42" do not pass. Convert with int first. To check whether text contains a number, use the is_number test.

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.

Distinguish integer from float

Check whether a numeric value is specifically an integer.

{{ 42 is integer }}
{{ 42.0 is integer }}
{{ "42" is integer }}

true
false
false

Validate before integer operations

Ensure a value is an integer before using it in an operation that requires whole numbers.

{% set count = state_attr("sensor.devices", "count") %}
{% if count is integer %}
  {{ count }} devices connected
{% else %}
  Invalid count
{% endif %}

5 devices connected

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:

• Convert to integer: int - Converts a value to an integer, with an optional default if conversion fails.

• Get the type of a value: typeof - Returns the type name of a value as a string.