Equipment Manager

Manage household equipment — list, get by ID or name.

Access via grocy.equipment.

for e in grocy.equipment.list(get_details=True):
    print(f"{e.name}: {e.description}")

Class Reference

EquipmentManager(api_client)

Manage equipment items and their details.

Access via grocy.equipment.

list(query_filters=None, get_details=False)

Get all equipment items.

Parameters:

Name	Type	Description	Default
query_filters	list[str] | None	Optional Grocy API query filters.	None
get_details	bool	Fetch full details for each item.	False

get(equipment_id)

Get a single equipment item by ID.

Parameters:

Name	Type	Description	Default
equipment_id	int	The Grocy equipment ID.	required

get_by_name(name)

Get a single equipment item by name.

Parameters:

Name	Type	Description	Default
name	str	The equipment name to search for.	required

get_all_objects()

Get all equipment items with full details fetched from the API.