Skip to main content

✈️ REST API

The REST API is a basic configurable fetch wrapper, tuned for some useful REST API endpoints in Home Assistant.

🛠 Methods

Exported Function NameDescription
calendarSearchSearches for calendar events within a specified date range and returns them sorted by start date.
callServiceCalls a Home Assistant service with the specified parameters and returns the entity state changes.
checkConfigChecks the Home Assistant configuration for errors and returns the result.
checkCredentialsVerifies if the current credentials are valid.
downloadDownloads files from the Home Assistant server with specified fetch arguments.
fetchEntityCustomizationsFetches entity customizations, either global or local, for specified entity IDs.
fetchEntityHistoryRetrieves the history of an entity within a specified time frame and returns it.
fireEventFires a custom event in Home Assistant with optional data.
getAllEntitiesFetches the current state of all entities in Home Assistant.
getHassConfigRetrieves the current Home Assistant configuration.
getLogsFetches the Home Assistant server logs and adjusts the timestamps.
getRawLogsRetrieves the raw Home Assistant server logs as a string.
listServicesLists all available services in Home Assistant.
updateEntityUpdates the state and/or attributes of a specified entity.
webhookSends a request to a specified webhook in Home Assistant with optional data.