get_properties
Search Archicad properties by keyword, group, or exact name to retrieve GUIDs needed for querying element values.
Instructions
Search and discover Archicad element properties.
Properties are attributes like area, length, volume that you query on elements. Use this to find property GUIDs needed for GetPropertyValuesOfElements.
WHEN TO USE:
"Get wall areas" → get_properties(search="area", group="Wall")
"What properties can I query on zones?" → get_properties(group="Zone")
"Find custom/user-defined properties" → get_properties(property_type="Custom")
MODES: get_properties(port) # Overview of all groups get_properties(port, search="length") # Search by keyword get_properties(port, group="Wall") # All properties for element type get_properties(port, property="Length of Reference Line") # Exact lookup
Args: port: Archicad instance port (from list_instances) search: Search property names (e.g., "area", "length", "surface") group: Filter by group/element type (e.g., "Wall", "Zone", "Geometry") property_type: Filter by type: "StaticBuiltIn", "DynamicBuiltIn", "Custom" measure_type: Filter by unit: "Length", "Area", "Volume", "Angle" property: Exact property name lookup (returns single match with GUID) limit: Max results (default 50, max 200)
Returns: Properties with GUIDs ready for GetPropertyValuesOfElements.
NOTE: For command documentation (API schemas), use get_docs instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| port | Yes | ||
| group | No | ||
| limit | No | ||
| search | No | ||
| property | No | ||
| measure_type | No | ||
| property_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||