Extract room data from Revit models using SpecklePy.
This workflow reads versions published before 2026.9 with operations.receive. It does not read
versions published with a 2026.9 connector. For new work, use the 2026.9 path in Migrate a
specklepy script to 2026.9.
In this workflow, we will demonstrate how to extract room data from Revit models using SpecklePy SDK to a Pandas DataFrame.
Prerequisites
Before you begin, ensure you have the following:
A Revit model with room data.
Send your model to Speckle using the Speckle Revit Connector. See Revit.
First, import the required libraries and authenticate with Speckle.
import osfrom typing import Iterablefrom dotenv import load_dotenvfrom specklepy.api.client import SpeckleClientfrom specklepy.api import operationsfrom specklepy.objects import Basefrom specklepy.transports.server import ServerTransportimport pandas as pdload_dotenv()SPECKLE_TOKEN = os.getenv("SPECKLE_TOKEN")# you can generate a new token from the DEVELOPER SETTINGSSPECKLE_SERVER_URL = os.getenv("SPECKLE_SERVER_URL", "https://app.speckle.systems")if not SPECKLE_TOKEN: raise EnvironmentError("SPECKLE_TOKEN is not set. Add it to your .env file.")client = SpeckleClient(host=SPECKLE_SERVER_URL)# here add your custom server URLclient.authenticate_with_token(SPECKLE_TOKEN)
Step 3: Retrieve the full object graph
Next, we will retrieve the full object graph of the Revit model that contains the room data. To do this, we need the project ID and version ID of the model we sent to Speckle. You can find these IDs in the URL of your project and version in the Speckle web interface.
project_id = "your_project_id" # here add your project ID, you can find it in the URL of your project, after "projects/", for example in "https://app.speckle.systems/projects/e23d2d5041/models/ab02b98507" the project ID is "e23d2d5041"version_id = "your_version_id" # here add your version ID, you can find it under Share > Copy ID in the web 3D viewer# Get version metadata to find the referenced object IDversion = client.version.get(version_id, project_id)referenced_object_id = version.referenced_object# next create a server transport - this is the vehicle through which you will send and receivetransport = ServerTransport(stream_id=project_id, client=client)# Download the full object graph. Note that this is an expensive operation, as it retrieves all objects in the model, so it may take some time for large models.received_base = operations.receive(referenced_object_id, transport)
Step 4: Flatten the object graph to a list of objects
# Flatten root object and get all objects in a listdef flatten_base(base: Base) -> Iterable[Base]: """Flatten a base object into an iterable of bases. This function recursively traverses the `elements` or `@elements` attribute of the base object, yielding each nested base object. Args: base (Base): The base object to flatten. Yields: Base: Each nested base object in the hierarchy. """ # Attempt to get the elements attribute, fallback to @elements if necessary elements = getattr(base, "elements", getattr(base, "@elements", None)) if elements is not None: for element in elements: yield from flatten_base(element) yield baseall_objects = list(flatten_base(received_base))
Step 5: Create helper functions to filter objects by category and extract nested values
In this step, we will define helper functions to filter objects by category and to extract nested values from the properties of the objects. These functions will be used in the next step to extract the desired data from the room objects.
# Helper function to filter objects by categorydef filter_objects_by_category(all_objects, filter_categories): """ Filters objects by category and returns a list of matching objects and their IDs. Parameters: all_objects (list): List of objects to filter. filter_categories (list): List of categories to filter by. Returns: list: filtered_objects """ filtered_objects = [] items = [] for i in all_objects: if hasattr(i, "category"): # Check if the object has the "category" attribute if i.category in filter_categories: # Check if the category matches the filter list filtered_objects.append(i) # Append the whole object to the items list else: continue # Skip if "category" does not exist return filtered_objects# Helper function to get nested value from a dict using a path of keysdef get_nested_value(data, path, extract_value=True): """ Navigate a nested dict using a list of keys. If the final node is a Revit parameter dict (has a 'value' key), returns its value. Parameters: data (dict): The dict to traverse (typically obj.properties). path (list[str]): Ordered list of keys, e.g. ['Parameters', 'Instance Parameters', 'Identity Data', 'Number'] extract_value (bool): If True and the leaf node contains a 'value' key, return that. Returns: The resolved value, or None if any key in the path is missing. """ current = data for key in path: if not isinstance(current, dict): return None current = current.get(key) if current is None: return None # If any key is missing, return NaN in the DataFrame if extract_value and isinstance(current, dict) and 'value' in current: return current['value'] return current# Helper function to extract specified fields from a list of objects using flexible nested pathsdef extract_object_data(objects, field_paths, include_defaults=True): """ Extract data from a list of DataObjects using flexible nested field paths. Returns: list[dict]: One dict per object with the resolved values. """ results = [] for obj in objects: properties = getattr(obj, 'properties', {}) or {} row = {} if include_defaults: row['id'] = getattr(obj, 'id', None) # Include the object ID by default, or other parameters like 'type' if needed. for col_name, path in field_paths.items(): row[col_name] = get_nested_value(properties, path) results.append(row) return results
Step 6: Filter room objects and extract desired data into a DataFrame
In this step, we will define the field paths for the desired parameters and extract the data for the room objects into a Pandas DataFrame. You can use the Speckle 3D Viewer to inspect the structure of the properties and adjust the paths as needed.
# Define the field paths for the desired parameters, use the Speckle 3D Viewer to inspect the structure of the properties and adjust paths as needed.# Select one of the rooms in the viewer, inspect its properties and find the path to the parameters you want to extract.# The path is a list of keys to navigate through the nested dictionaries in obj.properties. For example, if the parameter is located at obj.properties['Parameters']['Instance Parameters']['Identity Data']['Number'],# then the path would be ['Parameters', 'Instance Parameters', 'Identity Data', 'Number'].field_paths = { 'Number': ['Parameters', 'Instance Parameters', 'Identity Data', 'Number'], 'Name': ['Parameters', 'Instance Parameters', 'Identity Data', 'Name'], 'Occupant': ['Parameters', 'Instance Parameters', 'Identity Data', 'Occupant'], 'Floor Finish': ['Parameters', 'Instance Parameters', 'Identity Data', 'Floor Finish'], 'Level': ['Parameters', 'Instance Parameters', 'Constraints', 'Level'], 'Area': ['Parameters', 'Instance Parameters', 'Dimensions', 'Area'], 'Volume': ['Parameters', 'Instance Parameters', 'Dimensions', 'Volume'], 'Perimeter': ['Parameters', 'Instance Parameters', 'Dimensions', 'Perimeter'], 'Unbounded Height': ['Parameters', 'Instance Parameters', 'Dimensions', 'Unbounded Height'],}room_data = filter_objects_by_category(all_objects, ['Rooms']) # Make sure to extract only roomsdata = extract_object_data(room_data, field_paths) # Extract the data using the defined field pathsdf_rooms = pd.DataFrame(data)df_rooms.head()
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Speckle Docs","colors":{"primary":"#155DFC","light":"#51A2FF","dark":"#2B7FFF"},"logo":{"light":"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/light.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=9fc87cac252fa8cc443a9828ecbace70","dark":"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/dark.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=560ffcf355d3abfde56e5f8e514a64b7"},"favicon":"https://mintcdn.com/speckle/H0UAly7sy_Ci378-/favicon-docs.svg?fit=max\u0026auto=format\u0026n=H0UAly7sy_Ci378-\u0026q=85\u0026s=024a646efe6d1f271e2e537e4e58a606","background":{"color":{"light":"#FAFAFA","dark":"#09090B"}},"navbar":{"links":[{"href":"https://speckle.systems/","label":"Website"},{"href":"https://speckle.community/","label":"Community"}],"primary":{"type":"button","label":"Open Speckle","href":"https://app.speckle.systems/?utm_source=Docs\u0026utm_medium=SignUp\u0026utm_campaign=Docs"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/specklesystems","youtube":"https://www.youtube.com/@SpeckleSystems","github":"https://github.com/specklesystems","instagram":"https://www.instagram.com/specklesystems"}},"icons":{"library":"fontawesome"},"integrations":{"ga4":{"measurementId":"G-05WEYFZ28C"},"intercom":{"appId":"hoiaq4wn"},"mixpanel":{"projectToken":"acd87c5a50b56df91a795e999812a3a4"}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":["These docs describe Speckle as it works today, including everything released in 2026.9. Treat page content as current unless the page or section says it applies only to versions published before 2026.9.","Content scoped to versions published before 2026.9 (the object graph and root object, Proxies, Receive2, operations.receive, object.children) applies only to model versions in that earlier data format. For versions published in 2026.9, answer from the Object model pages and the SDK migration guides.","The What's new pages summarise what changed in 2026.9 and link to the page that documents each change. Answer from the linked page rather than from the summary. Legacy (v2) connectors are retired; send questions about them to the community help forum.","Match guidance to the customer's deployment, model data format, connector, plan and permissions. Self-hosted servers on a release before 2026.9 follow Data model migration for developers. If an unknown version or data format changes the answer, ask one focused question; do not infer the deployment version from the date alone."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"speckle","hasAudioNarration":false,"actualSubdomain":"speckle","customDomains":["docs.speckle.systems"],"gitSource":{"type":"github","owner":"specklesystems","repo":"speckle-docs-new","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"issues":true},"entitlements":{},"buildId":"6b008de1a4b04c90ff544085","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Developers","count":213},{"language":"default","tag":"User Guides","count":96},{"language":"default","tag":"SDKs","count":65},{"language":"default","tag":"API Reference","count":54},{"language":"default","tag":"Viewer","count":50},{"language":"default","tag":"Connectors","count":40},{"language":"default","tag":"Publishing \u0026 Loading","count":38},{"language":"default","tag":"C# .NET","count":33},{"language":"default","tag":"Python","count":30},{"language":"default","tag":"Interfaces","count":29}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#footer div:first-child>div:first-child>div:first-child{display:none}.header-link+p{margin-top:0.6rem}li .frame{margin-top:1rem;margin-bottom:1.5rem}div:has(>.frame)+div:has(>.frame){margin-top:0.75rem}:root{--sp-surface-0: #fafafa;--sp-surface-1: #fcfcfc;--sp-border: #e4e4e7;--sp-bg-elevated: #f4f4f5;--sp-text-highlighted: #18181b;--sp-text-muted: #71717b;--sp-header-height: 56px}:root.dark{--sp-surface-0: #09090b;--sp-surface-1: #111113;--sp-border: #27272a;--sp-bg-elevated: #27272a;--sp-text-highlighted: #ffffff;--sp-text-muted: #9f9fa9}#sidebar [class*=\"bg-linear-to-b\"]{background-image:linear-gradient(to bottom, var(--sp-surface-1), transparent)!important}#sidebar [class*=\"bg-neutral-50\"][class*=\"rounded-full\"]{background:transparent!important}#sidebar li[data-active]>a{background:var(--sp-bg-elevated)!important;color:var(--sp-text-highlighted)!important}@media (min-width: 1024px){:root{--mintlify-slot-header-height: calc(var(--sp-header-height) + var(--topbar-tabs-height, 0rem))}div:has(>#sidebar){max-width:none!important;margin-left:0!important;margin-right:0!important;padding-left:0!important}#sidebar{background:var(--sp-surface-1);border-right:1px solid var(--sp-border)}#sidebar>div{left:16px!important;right:8px!important}div:has(>[data-layout-item=\"content\"]){max-width:1184px;margin-left:auto;margin-right:auto;padding-inline:48px}#navbar [class*=\"max-w-8xl\"]{max-width:none!important}body:has(#sidebar) #navbar #navbar-transition{border-bottom:1px solid var(--sp-border)!important;background:linear-gradient(\n to right,\n var(--sp-surface-1) 0,\n var(--sp-surface-1) calc(var(--sidebar-width, 18rem) - 1px),\n var(--sp-border) calc(var(--sidebar-width, 18rem) - 1px),\n var(--sp-border) var(--sidebar-width, 18rem),\n var(--sp-surface-0) var(--sidebar-width, 18rem)\n )!important}#navbar div:has(>div>div>a>img.nav-logo){height:var(--sp-header-height)!important;padding-left:32px!important}#navbar div:has(>div>div>a>img.nav-logo)>div{border-bottom:0!important}#navbar img.nav-logo{height:28px!important}#navbar div:has(>div>div>a>img.nav-logo)>div>div:first-child{flex:1 1 auto!important}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(2){flex:0 0 auto!important;margin-left:auto;width:32px}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(3){flex:0 0 auto!important;margin-left:16px}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(3) a:has(>[class*=\"bg-primary\"]){height:32px!important;padding-top:0!important;padding-bottom:0!important}#search-bar-entry{width:32px!important;height:32px!important;padding:0!important;justify-content:center!important;border:0!important;border-radius:6px!important;background:transparent!important;box-shadow:none!important}#search-bar-entry:hover{background:var(--sp-bg-elevated)!important}#search-bar-entry [data-search-item=\"trigger-icon\"]{width:16px!important;height:16px!important;color:var(--sp-text-muted)!important}#search-bar-entry:hover [data-search-item=\"trigger-icon\"]{color:var(--sp-text-highlighted)!important}#search-bar-entry [data-search-item=\"trigger-label\"],#search-bar-entry [data-search-item=\"trigger-hint\"]{display:none!important}body:has(#sidebar) #navbar div:has(>.nav-tabs){padding-left:calc(var(--sidebar-width, 18rem) + 32px)!important}}@media (min-width: 1440px){:root,body,body *{--topbar-tabs-height: 0rem !important}body:has(.nav-tabs) #navbar div:has(>div>.nav-tabs){display:grid!important}body:has(.nav-tabs) #navbar div:has(>div>.nav-tabs)>*{grid-area:1 / 1}#navbar div:has(>.nav-tabs){height:var(--sp-header-height)!important;pointer-events:none;align-items:stretch}#navbar .nav-tabs{pointer-events:auto}#content-side-layout{top:calc(var(--sp-header-height) + 48px)!important}}"}]}
{"page":{"pagePath":"workflows/revit-room-data-extraction-specklepy","slug":"/workflows/revit-room-data-extraction-specklepy","pageMetadata":{"title":"Extract Revit room data with SpecklePy","sidebarTitle":"Revit room data extraction","description":"Extract room data from Revit models using SpecklePy.","href":"/workflows/revit-room-data-extraction-specklepy"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Extract room data from Revit models using SpecklePy.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`This workflow reads versions published before 2026.9 with `,_jsx(_components.code,{children:`operations.receive`}),`. It does not read\nversions published with a 2026.9 connector. For new work, use the 2026.9 path in `,_jsx(_components.a,{href:`/developers/sdks/python/migrate-to-2026-9`,children:`Migrate a\nspecklepy script to 2026.9`}),`.`]})}),`\n`,_jsx(_components.p,{children:`In this workflow, we will demonstrate how to extract room data from Revit models using SpecklePy SDK to a Pandas DataFrame.`}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsx(_components.p,{children:`Before you begin, ensure you have the following:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`A Revit model with room data.`}),`\n`,_jsxs(_components.li,{children:[`Send your model to Speckle using the Speckle Revit Connector. See `,_jsx(_components.a,{href:`/connectors/revit/revit`,children:`Revit`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/developers/sdks/python/introduction`,children:`SpecklePy SDK`}),` installed in your Python environment.`]}),`\n`,_jsx(_components.li,{children:`Pandas library for data manipulation.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`step-1-install-specklepy-sdk-and-pandas`,children:`Step 1: Install SpecklePy SDK and Pandas`}),`\n`,_jsx(_components.p,{children:`You can install the required libraries using pip:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` specklepy`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` pandas`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`step-2-connect-to-speckle`,children:`Step 2: Connect to Speckle`}),`\n`,_jsx(_components.p,{children:`First, import the required libraries and authenticate with Speckle.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`21`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`21`,children:[_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` typing `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Iterable`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` dotenv `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` load_dotenv`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` specklepy.api.client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SpeckleClient`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` specklepy.api `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` operations`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` specklepy.objects `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Base`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` specklepy.transports.server `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ServerTransport`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` pandas `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`as`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` pd`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`load_dotenv()`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`SPECKLE_TOKEN`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os.getenv(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SPECKLE_TOKEN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# you can generate a new token from the DEVELOPER SETTINGS`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`SPECKLE_SERVER_URL`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os.getenv(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SPECKLE_SERVER_URL\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://app.speckle.systems\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` not`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:` SPECKLE_TOKEN`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` raise`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` EnvironmentError`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SPECKLE_TOKEN is not set. Add it to your .env file.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SpeckleClient(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`host`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`SPECKLE_SERVER_URL`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# here add your custom server URL`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client.authenticate_with_token(`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`SPECKLE_TOKEN`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`step-3-retrieve-the-full-object-graph`,children:`Step 3: Retrieve the full object graph`}),`\n`,_jsx(_components.p,{children:`Next, we will retrieve the full object graph of the Revit model that contains the room data. To do this, we need the project ID and version ID of the model we sent to Speckle. You can find these IDs in the URL of your project and version in the Speckle web interface.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`project_id `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"your_project_id\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # here add your project ID, you can find it in the URL of your project, after \"projects/\", for example in \"https://app.speckle.systems/projects/e23d2d5041/models/ab02b98507\" the project ID is \"e23d2d5041\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`version_id `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"your_version_id\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # here add your version ID, you can find it under Share > Copy ID in the web 3D viewer`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Get version metadata to find the referenced object ID`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`version `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` client.version.get(version_id, project_id)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`referenced_object_id `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` version.referenced_object`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# next create a server transport - this is the vehicle through which you will send and receive`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`transport `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ServerTransport(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`stream_id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`project_id, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`client`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Download the full object graph. Note that this is an expensive operation, as it retrieves all objects in the model, so it may take some time for large models.`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`received_base `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` operations.receive(referenced_object_id, transport)`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`step-4-flatten-the-object-graph-to-a-list-of-objects`,children:`Step 4: Flatten the object graph to a list of objects`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`23`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`23`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Flatten root object and get all objects in a list`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` flatten_base`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`base`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: Base) -> Iterable[Base]:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"Flatten a base object into an iterable of bases.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\" This function recursively traverses the `elements` or `@elements` attribute of the\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` base object, yielding each nested base object.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` base (Base): The base object to flatten.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Yields:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Base: Each nested base object in the hierarchy.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Attempt to get the elements attribute, fallback to @elements if necessary`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` elements `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` getattr`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(base, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"elements\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`getattr`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(base, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"@elements\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`))`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` elements `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`is`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` not`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` element `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` elements:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` yield from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` flatten_base(element)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` yield`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` base`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`all_objects `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` list`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(flatten_base(received_base))`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`step-5-create-helper-functions-to-filter-objects-by-category-and-extract-nested-values`,children:`Step 5: Create helper functions to filter objects by category and extract nested values`}),`\n`,_jsx(_components.p,{children:`In this step, we will define helper functions to filter objects by category and to extract nested values from the properties of the objects. These functions will be used in the next step to extract the desired data from the room objects.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`72`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`72`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Helper function to filter objects by category`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` filter_objects_by_category`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`all_objects`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`filter_categories`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Filters objects by category and returns a list of matching objects and their IDs.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Parameters:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` all_objects (list): List of objects to filter.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` filter_categories (list): List of categories to filter by.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` list: filtered_objects`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filtered_objects `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` []`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` items `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` []`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` i `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` all_objects:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` hasattr`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(i, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"category\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`): `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Check if the object has the \"category\" attribute`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` i.category `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filter_categories: `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Check if the category matches the filter list`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filtered_objects.append(i) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Append the whole object to the items list`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` else`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` continue`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Skip if \"category\" does not exist`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filtered_objects`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Helper function to get nested value from a dict using a path of keys`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` get_nested_value`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`extract_value`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`True`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Navigate a nested dict using a list of keys.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` If the final node is a Revit parameter dict (has a 'value' key), returns its value.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Parameters:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` data (dict): The dict to traverse (typically obj.properties).`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` path (list[str]): Ordered list of keys, e.g.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ['Parameters', 'Instance Parameters', 'Identity Data', 'Number']`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` extract_value (bool): If True and the leaf node contains a 'value' key, return that.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` The resolved value, or None if any key in the path is missing.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` current `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` data`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` path:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` not`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` isinstance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(current, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`dict`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` current `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` current.get(key)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` current `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`is`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # If any key is missing, return NaN in the DataFrame`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` extract_value `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`and`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` isinstance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(current, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`dict`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`and`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'value'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` current:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` current[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'value'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` current`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Helper function to extract specified fields from a list of objects using flexible nested paths`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` extract_object_data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`objects`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`field_paths`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`include_defaults`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`True`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Extract data from a list of DataObjects using flexible nested field paths.`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` list[dict]: One dict per object with the resolved values.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` results `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` []`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` obj `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` objects:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` properties `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` getattr`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(obj, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'properties'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {}) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`or`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` row `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {}`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` include_defaults:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` row[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'id'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` getattr`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(obj, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'id'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Include the object ID by default, or other parameters like 'type' if needed.`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` col_name, path `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` field_paths.items():`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` row[col_name] `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` get_nested_value(properties, path)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` results.append(row)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` results`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`step-6-filter-room-objects-and-extract-desired-data-into-a-dataframe`,children:`Step 6: Filter room objects and extract desired data into a DataFrame`}),`\n`,_jsx(_components.p,{children:`In this step, we will define the field paths for the desired parameters and extract the data for the room objects into a Pandas DataFrame. You can use the Speckle 3D Viewer to inspect the structure of the properties and adjust the paths as needed.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`20`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`20`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Define the field paths for the desired parameters, use the Speckle 3D Viewer to inspect the structure of the properties and adjust paths as needed.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Select one of the rooms in the viewer, inspect its properties and find the path to the parameters you want to extract.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# The path is a list of keys to navigate through the nested dictionaries in obj.properties. For example, if the parameter is located at obj.properties['Parameters']['Instance Parameters']['Identity Data']['Number'],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# then the path would be ['Parameters', 'Instance Parameters', 'Identity Data', 'Number'].`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`field_paths `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Number'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Identity Data'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Number'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Name'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Identity Data'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Name'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Occupant'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Identity Data'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Occupant'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Floor Finish'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Identity Data'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Floor Finish'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Level'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Constraints'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Level'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Area'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Dimensions'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Area'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Volume'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Dimensions'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Volume'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Perimeter'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Dimensions'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Perimeter'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Unbounded Height'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Instance Parameters'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Dimensions'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Unbounded Height'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`room_data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` filter_objects_by_category(all_objects, [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Rooms'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Make sure to extract only rooms`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` extract_object_data(room_data, field_paths) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Extract the data using the defined field paths`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`df_rooms `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` pd.DataFrame(data)`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`df_rooms.head()`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`check-the-results`,children:`Check the results`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`id`}),_jsx(_components.th,{children:`Number`}),_jsx(_components.th,{children:`Name`}),_jsx(_components.th,{children:`Occupant`}),_jsx(_components.th,{children:`Floor Finish`}),_jsx(_components.th,{children:`Level`}),_jsx(_components.th,{children:`Area`}),_jsx(_components.th,{children:`Volume`}),_jsx(_components.th,{children:`Perimeter`}),_jsx(_components.th,{children:`Unbounded Height`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`ab37495bf07f97 6aae3c55e3cc2617f9`}),_jsx(_components.td,{children:`S1`}),_jsx(_components.td,{children:`Stair`}),_jsx(_components.td,{children:`None`}),_jsx(_components.td,{children:`Concrete`}),_jsx(_components.td,{children:`L1 - Block 35`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`184.598958`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`15891.467781`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`60.833333`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`87.666667`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`00b6189ecb67a54f09e47cda717295a3`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`101`}),_jsx(_components.td,{children:`Café`}),_jsx(_components.td,{children:`Restaurant`}),_jsx(_components.td,{children:`Polished Concrete/LVT`}),_jsx(_components.td,{children:`L1 - Block 35`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`642.967568`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`13276.052784`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`196.655657`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`24.250000`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`42ba7c725016f8ef7458065b7824fbc2`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`102`}),_jsx(_components.td,{children:`Café Kitchen`}),_jsx(_components.td,{children:`Restaurant`}),_jsx(_components.td,{children:`Polished Concrete/LVT`}),_jsx(_components.td,{children:`L1 - Block 35`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`433.370768`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`4730.964220`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`137.312500`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`10.916667`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`77aacf2216a7c55cdc72ef5f118f3113`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`103`}),_jsx(_components.td,{children:`Outdoor Covered Dining`}),_jsx(_components.td,{children:`Restaurant`}),_jsx(_components.td,{children:`Polished Concrete/LVT`}),_jsx(_components.td,{children:`L1 - Block 35`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`674.576823`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`14316.140687`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`114.583333`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`22.750000`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`f71f1d3a62b5457de25061e025a8f2c9`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`104`}),_jsx(_components.td,{children:`Pocket Park`}),_jsx(_components.td,{children:`Outdoor Public`}),_jsx(_components.td,{children:`Varies see Plan`}),_jsx(_components.td,{children:`L1 - Block 35`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`1775.819324`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`39490.443882`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`225.443711`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`22.750000`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`c825211befa4530a133cf44fd21084cc`}),_jsx(_components.td,{children:`S3`}),_jsx(_components.td,{children:`Stair`}),_jsx(_components.td,{children:`None`}),_jsx(_components.td,{children:`Concrete`}),_jsx(_components.td,{children:`L2`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`180.062500`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`15500.451922`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`59.750000`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`87.708333`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Extract Revit room data with SpecklePy","sidebarTitle":"Revit room data extraction","description":"Extract room data from Revit models using SpecklePy.","href":"/workflows/revit-room-data-extraction-specklepy"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Step 1: Install SpecklePy SDK and Pandas","slug":"step-1-install-specklepy-sdk-and-pandas","depth":2,"children":[]},{"title":"Step 2: Connect to Speckle","slug":"step-2-connect-to-speckle","depth":2,"children":[]},{"title":"Step 3: Retrieve the full object graph","slug":"step-3-retrieve-the-full-object-graph","depth":2,"children":[]},{"title":"Step 4: Flatten the object graph to a list of objects","slug":"step-4-flatten-the-object-graph-to-a-list-of-objects","depth":2,"children":[]},{"title":"Step 5: Create helper functions to filter objects by category and extract nested values","slug":"step-5-create-helper-functions-to-filter-objects-by-category-and-extract-nested-values","depth":2,"children":[]},{"title":"Step 6: Filter room objects and extract desired data into a DataFrame","slug":"step-6-filter-room-objects-and-extract-desired-data-into-a-dataframe","depth":2,"children":[]},{"title":"Check the results","slug":"check-the-results","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/speckle/338e4d421a1293df/.omp/extensions/atlas-sync.js"],"subdomain":"speckle","siteName":"Speckle Docs","title":"Extract Revit room data with SpecklePy - Speckle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T15:48:40.853Z","gitLastModified":"2026-10-19T08:27:13.000Z","originalFileLocation":"workflows/revit-room-data-extraction-specklepy.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Extract room data from Revit models using SpecklePy.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Speckle Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Extract Revit room data with SpecklePy - Speckle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Extract room data from Revit models using SpecklePy.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Speckle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://speckle.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Extract+Revit+room+data+with+SpecklePy\u0026amp;description=Extract+room+data+from+Revit+models+using+SpecklePy.\u0026amp;theme=3e6fae5609aa483790e4f77c\u0026amp;signature=d86850b9f16e731fb0bffb1fcb6316bac058e7f5347fdc2cf8159719d417d053\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Extract Revit room data with SpecklePy - Speckle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Extract room data from Revit models using SpecklePy.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://speckle.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Extract+Revit+room+data+with+SpecklePy\u0026amp;description=Extract+room+data+from+Revit+models+using+SpecklePy.\u0026amp;theme=3e6fae5609aa483790e4f77c\u0026amp;signature=d86850b9f16e731fb0bffb1fcb6316bac058e7f5347fdc2cf8159719d417d053\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Speckle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#155DFC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/workflows/revit-room-data-extraction-specklepy.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.speckle.systems/#organization\",\"name\":\"Speckle Docs\",\"url\":\"https://docs.speckle.systems\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/light.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=9fc87cac252fa8cc443a9828ecbace70\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.speckle.systems#website\",\"name\":\"Speckle Docs\",\"url\":\"https://docs.speckle.systems\",\"publisher\":{\"@id\":\"https://docs.speckle.systems/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy#webpage\",\"url\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy\",\"name\":\"Extract Revit room data with SpecklePy\",\"description\":\"Extract room data from Revit models using SpecklePy.\",\"dateModified\":\"2026-10-19T08:27:13.000Z\",\"isPartOf\":{\"@id\":\"https://docs.speckle.systems#website\"},\"breadcrumb\":{\"@id\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workflows\",\"item\":\"https://docs.speckle.systems/workflows/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Extract Revit room data with SpecklePy\",\"item\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy#article\",\"headline\":\"Extract Revit room data with SpecklePy\",\"name\":\"Extract Revit room data with SpecklePy\",\"description\":\"Extract room data from Revit models using SpecklePy.\",\"url\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy\",\"mainEntityOfPage\":{\"@id\":\"https://docs.speckle.systems/workflows/revit-room-data-extraction-specklepy#webpage\"},\"dateModified\":\"2026-10-19T08:27:13.000Z\",\"publisher\":{\"@id\":\"https://docs.speckle.systems/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.speckle.systems#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Speckle Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Speckle Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/workflows/revit-room-data-extraction-specklepy.md","siteName":"Speckle Docs","nav":{"global":null,"dropdowns":[{"dropdown":"User Guides","icon":"book-open","groups":[{"group":"Quick Reference","pages":[{"title":"Welcome to Speckle","sidebarTitle":"Welcome","href":"/quickstart/welcome"},{"title":"Speckle's new data model: what has changed for you","sidebarTitle":"Data model migration","href":"/workspaces/data-model-migration"},{"title":"Quickstart Guide","href":"/quickstart/quickstart"},{"title":"Frequently Asked Questions","href":"/quickstart/faq"},{"title":"What's new in 2026.9 for workspace users","sidebarTitle":"What's new","href":"/whats-new/users"}]},{"group":"Your Speckle Workspace","pages":[{"title":"Organize teams and projects","sidebarTitle":"Overview","href":"/workspaces/introduction"},{"group":"Projects, Models, and Versions","pages":[{"title":"Projects","href":"/workspaces/projects"},{"title":"Models","href":"/workspaces/models"},{"title":"Version Control","href":"/workspaces/versions"}]},{"group":"Access and Identity","pages":[{"title":"Roles and permissions","href":"/workspaces/roles-and-seats"},{"title":"Invite to Workspace","href":"/workspaces/inviting"},{"title":"Workspace Discoverability","href":"/workspaces/workspace-discoverability"},{"title":"Domain Protection","href":"/workspaces/domain-protection"},{"title":"Single Sign-On (SSO)","tag":"Enterprise","href":"/workspaces/sso"},{"title":"User provisioning (SCIM)","sidebarTitle":"Provisioning (SCIM)","tag":"Enterprise","href":"/workspaces/scim"}]},{"group":"Plans and Governance","pages":[{"title":"Plans and Governance","sidebarTitle":"Overview","href":"/workspaces/plans-and-governance"},{"title":"Billing","href":"/workspaces/billing"},{"title":"Data Residency","tag":"Enterprise","href":"/workspaces/data-residency"}]},{"group":"Configuration","pages":[{"title":"Configuration","href":"/workspaces/configuration"},{"title":"Check workspace activity, plan limits, and AI spend","sidebarTitle":"Usage","href":"/workspaces/usage"},{"title":"Project metadata","tag":"Enterprise","href":"/workspaces/configuration/project-metadata"}]}]},{"group":"Viewing \u0026 Sharing","pages":[{"title":"Open and explore models in the 3D viewer","sidebarTitle":"Overview","href":"/3d-viewer/introduction"},{"title":"Interface and navigation","href":"/3d-viewer/interface-nav"},{"group":"Inspect and Compare","pages":[{"title":"Filter, browse, and measure your model","sidebarTitle":"Exploration","href":"/3d-viewer/exploration"},{"title":"Compare versions","href":"/3d-viewer/compare-versions"},{"title":"Combine models in one scene","sidebarTitle":"Model federation","href":"/3d-viewer/federation"}]},{"group":"Feedback and Tracking","pages":[{"title":"Issues","href":"/3d-viewer/issues"},{"title":"Sketch on your model","sidebarTitle":"Sketch","href":"/3d-viewer/markups"},{"title":"Saved views","href":"/3d-viewer/saved-views"}]},{"group":"Present and Share","pages":[{"title":"Present a model with saved views","sidebarTitle":"Presentation","href":"/3d-viewer/presentation"},{"title":"Share your models","href":"/3d-viewer/sharing"}]}]},{"group":"Publishing \u0026 Loading","pages":[{"title":"Connectors, cloud integrations, and file uploads","sidebarTitle":"Overview","href":"/connectors/overview"},{"group":"Connectors","pages":[{"title":"Installing Connectors","href":"/connectors/installation"},{"title":"Connector Assets \u0026 Templates","sidebarTitle":"Assets \u0026 Templates","href":"/connectors/assets"},{"group":"Revit","pages":[{"title":"How to use Speckle for Revit","sidebarTitle":"Quickstart","href":"/connectors/revit/revit"},{"title":"Loading blocks as families in Revit","sidebarTitle":"Blocks as Families","href":"/connectors/revit/blocks-to-families"},{"title":"Linked Revit models","href":"/connectors/revit/linked-models"}]},{"group":"Rhino","pages":[{"title":"How to use Speckle for Rhino","sidebarTitle":"Quickstart","href":"/connectors/rhino/rhino"},{"title":"Revit Categorization","href":"/connectors/rhino/rhino-revit"},{"title":"RhinoInside","sidebarTitle":"RhinoInside","href":"/connectors/grasshopper/grasshopper-integrations"}]},{"group":"Grasshopper","pages":[{"title":"How to use Speckle for Grasshopper","sidebarTitle":"Quickstart","href":"/connectors/grasshopper/grasshopper"},{"title":"Explore what an object is connected to","sidebarTitle":"Explore","href":"/connectors/grasshopper/explore"},{"title":"Models","href":"/connectors/grasshopper/grasshopper-models"},{"title":"Collections","href":"/connectors/grasshopper/grasshopper-collections"},{"title":"Objects","href":"/connectors/grasshopper/grasshopper-objects"},{"title":"Properties","href":"/connectors/grasshopper/grasshopper-properties"},{"title":"Developer Nodes","href":"/connectors/grasshopper/grasshopper-developer"},{"title":"Recommendations","href":"/connectors/grasshopper/grasshopper-recommendations"},{"title":"Karamba3D","sidebarTitle":"Karamba3D","tag":"Third-Party","href":"/connectors/third-party/karamba3d"},{"title":"ShapeDiver","sidebarTitle":"ShapeDiver","tag":"Third-Party","href":"/connectors/third-party/shapediver"}]},{"title":"How to use Speckle for SketchUp","sidebarTitle":"SketchUp","href":"/connectors/sketchup"},{"group":"Power BI","pages":[{"title":"How to use Speckle for Power BI","sidebarTitle":"Quickstart","href":"/connectors/power-bi/power-bi"},{"title":"Power BI Data Gateway","sidebarTitle":"Data Gateway","href":"/connectors/power-bi/gateway"}]},{"title":"How to use Speckle for Archicad","sidebarTitle":"Archicad","href":"/connectors/archicad"},{"title":"Publish Navisworks models to Speckle","sidebarTitle":"Navisworks","href":"/connectors/navisworks"},{"title":"How to use Speckle for Blender","sidebarTitle":"Blender","href":"/connectors/blender"},{"title":"How to use Speckle for Civil 3D","sidebarTitle":"Civil 3D","href":"/connectors/civil3d"},{"title":"How to use Speckle for Plant 3D","sidebarTitle":"Plant 3D","href":"/connectors/plant3d"},{"title":"How to use Speckle for AutoCAD","sidebarTitle":"AutoCAD","href":"/connectors/autocad"},{"title":"How to use Speckle for ETABS","sidebarTitle":"ETABS","href":"/connectors/etabs"},{"title":"How to use Speckle for Tekla Structures","sidebarTitle":"Tekla Structures","href":"/connectors/teklastructures"},{"title":"How to use Speckle for Vectorworks","sidebarTitle":"Vectorworks","tag":"Third-Party","href":"/connectors/third-party/vectorworks"}]},{"group":"Cloud Integrations","pages":[{"title":"Autodesk Forma Data Management","sidebarTitle":"Forma Data Management (ACC)","tag":"Enterprise","href":"/connectors/cloud-integrations/acc"},{"title":"Sync models from Trimble Connect","sidebarTitle":"Trimble Connect","tag":"Enterprise","href":"/connectors/cloud-integrations/trimble-connect"},{"title":"Sync models from SharePoint","sidebarTitle":"SharePoint","href":"/connectors/cloud-integrations/sharepoint"},{"title":"Bentley ProjectWise","sidebarTitle":"Bentley ProjectWise","tag":"Enterprise","href":"/connectors/cloud-integrations/projectwise"},{"title":"Databricks","sidebarTitle":"Databricks","href":"/connectors/cloud-integrations/databricks"},{"title":"Snowflake","sidebarTitle":"Snowflake","href":"/connectors/cloud-integrations/snowflake"}]},{"title":"Direct uploads","href":"/connectors/direct-uploads/introduction"}]},{"group":"Analytics \u0026 Intelligence","pages":[{"group":"Intelligence","pages":[{"title":"Ask questions about your models with Speckle Intelligence","sidebarTitle":"Speckle Intelligence","href":"/analytics/intelligence"},{"title":"Reuse organisation playbooks with Intelligence skills","sidebarTitle":"Skills","href":"/analytics/intelligence-skills"},{"title":"Set standing AI Rules for the workspace","sidebarTitle":"AI Rules","href":"/analytics/intelligence-rules"},{"title":"Create and share Intelligence Reports","sidebarTitle":"Reports","href":"/analytics/reports"}]},{"group":"Dashboards","pages":[{"title":"Intelligence Dashboards","sidebarTitle":"Overview","href":"/analytics/intelligence-dashboards"},{"title":"Retired and replaced dashboard widgets","sidebarTitle":"Widget availability","href":"/analytics/dashboards-widget-availability"},{"title":"Layout","sidebarTitle":"Layout","href":"/analytics/dashboards/layout"},{"title":"Sharing","sidebarTitle":"Sharing","href":"/analytics/dashboards/sharing"},{"title":"Filters","sidebarTitle":"Filters","href":"/analytics/dashboards/filters"},{"title":"Lookup tables","sidebarTitle":"Lookup tables","href":"/analytics/dashboards/lookup-tables"},{"title":"Calculated fields","sidebarTitle":"Calculated fields","href":"/analytics/dashboards/calculated-fields"},{"title":"Common workflows","sidebarTitle":"Common workflows","href":"/analytics/dashboards/common-workflows"}]},{"group":"Data Validation","pages":[{"title":"Data Validation","sidebarTitle":"Overview","href":"/analytics/data-validation/overview"},{"title":"Checks","sidebarTitle":"Checks","href":"/analytics/data-validation/checks"},{"title":"Project standards","sidebarTitle":"Standards","href":"/analytics/data-validation/standards"},{"title":"Viewing Results","sidebarTitle":"Viewing Results","href":"/analytics/data-validation/viewing-results"},{"title":"Validation Widgets in Dashboards","sidebarTitle":"Validation Widgets","href":"/analytics/dashboards/validation-widgets"}]},{"group":"Data Conditioning","pages":[{"title":"Update parameters from the model viewer","sidebarTitle":"Parameter Updater","href":"/beta/parameter-updater"}]}]},{"group":"Workflows","pages":[{"title":"Combine capabilities into outcomes","sidebarTitle":"Overview","href":"/workflows/overview"},{"title":"Assess model changes with Speckle Intelligence","sidebarTitle":"Compare versions with Intelligence","href":"/workflows/assess-model-changes"},{"title":"Take off quantities and cost with Speckle Intelligence","sidebarTitle":"Quantity \u0026 cost takeoff","href":"/workflows/take-off-quantities"},{"title":"Benchmark a project against your portfolio with Speckle Intelligence","sidebarTitle":"Portfolio benchmarking","href":"/workflows/benchmark-against-your-portfolio"},{"title":"Validate incoming models automatically","sidebarTitle":"Automatic model validation","href":"/workflows/validate-incoming-models-automatically"},{"title":"Design review workflow","sidebarTitle":"Design Review","href":"/workflows/design-review-workflow"},{"title":"Componentised Grasshopper workflow","sidebarTitle":"Grasshopper","href":"/workflows/grasshopper-componentised-workflow"},{"title":"Compare parametric design options from Grasshopper","sidebarTitle":"Design Explorer","description":"Publish Grasshopper design options and compare their geometry and numeric properties in a dashboard.","href":"/workflows/grasshopper-design-explorer"},{"title":"Extract Revit room data with SpecklePy","sidebarTitle":"Revit room data extraction","href":"/workflows/revit-room-data-extraction-specklepy"},{"title":"Analyse model data with SpecklePy and DuckDB","sidebarTitle":"SpecklePy analytics","description":"Use SpecklePy to prepare queryable model datasets for analytics workflows.","href":"/workflows/specklepy-model-data-analytics"}]}],"global":{"anchors":[]}},{"dropdown":"Developers","icon":"code","tabs":[{"tab":"Build with Speckle","groups":[{"group":"Overview","pages":[{"title":"Developer documentation","sidebarTitle":"Introduction","href":"/developers/introduction"},{"title":"What's new in 2026.9 for developers","sidebarTitle":"What's new","href":"/whats-new/developers"}]},{"group":"Getting Started","pages":[{"title":"Your learning path","sidebarTitle":"Your Learning Path","href":"/developers/getting-started"},{"group":"Authentication","pages":[{"title":"Authenticating with Speckle","sidebarTitle":"Introduction","href":"/developers/authentication/introduction"},{"title":"Building with PATs","sidebarTitle":"PATs","href":"/developers/authentication/pats"},{"title":"Building with OAuth2","sidebarTitle":"OAuth2 and PKCE","href":"/developers/authentication/oauth2"},{"title":"Single Sign-On (SSO) Authentication","sidebarTitle":"SSO Authentication","href":"/developers/authentication/sso"}]},{"title":"Key Concepts","sidebarTitle":"Key Concepts","href":"/developers/key-concepts"}]},{"group":"Building Custom Apps","pages":[{"title":"Building Custom Applications","sidebarTitle":"Building Custom Apps","href":"/developers/building-apps"}]},{"group":"Building Integrations","pages":[{"title":"Add Speckle connectivity to your authoring applications","sidebarTitle":"Overview","href":"/developers/building-integrations"},{"title":"Build integrations on the bundle format","sidebarTitle":"Bundles","href":"/developers/building-integrations/bundles"},{"title":"Publish a bundle from your own code","sidebarTitle":"Publish","href":"/developers/building-integrations/publish"},{"title":"Load a bundle in your own code","sidebarTitle":"Load","href":"/developers/building-integrations/load"},{"title":"Publish, load, and integration depth","sidebarTitle":"Publish \u0026 Load","href":"/developers/connectivity/integration-depth"},{"title":"Desktop host connectivity","sidebarTitle":"Desktop Host","href":"/developers/connectivity/desktop-host"},{"title":"Cloud and automation connectivity","sidebarTitle":"Cloud \u0026 Automation","href":"/developers/connectivity/cloud-automation"},{"title":"Middleware and orchestration","sidebarTitle":"Middleware","href":"/developers/connectivity/middleware"},{"title":"Hybrid connectivity","sidebarTitle":"Hybrid","href":"/developers/connectivity/hybrid"},{"title":"Data model and build order","sidebarTitle":"Data \u0026 Build Order","href":"/developers/connectivity/data-and-build"},{"title":"Connectivity resources","sidebarTitle":"Resources","href":"/developers/connectivity/resources"}]},{"group":"Migration notices","hidden":true,"pages":[{"title":"Speckle's new data model: what has changed for developers","sidebarTitle":"Data model migration","href":"/developers/migration/data-model-migration"},{"title":"Publish through model ingestions, not legacy send","sidebarTitle":"Publish via ingestions","href":"/developers/migration/publish-through-ingestions"}]}]},{"tab":"Data Schema","groups":[{"group":"Object model","pages":[{"title":"Object model","sidebarTitle":"Overview","href":"/developers/object-model/overview"},{"title":"Relations","sidebarTitle":"Relations","href":"/developers/object-model/relations"},{"title":"Where version metadata lives","sidebarTitle":"Version metadata","href":"/developers/object-model/version-metadata"},{"title":"Geometry encoding","sidebarTitle":"Geometry encoding","href":"/developers/object-model/geometry-encoding"}]},{"group":"Object graph (before 2026.9)","pages":[{"title":"Data schema","href":"/developers/data-schema/overview"},{"title":"Core Concepts","href":"/developers/data-schema/concepts"},{"title":"Versions and the root object","href":"/developers/data-schema/version-root-object"},{"title":"Object Schema","href":"/developers/data-schema/object-schema"},{"title":"Traversal Recipes","href":"/developers/data-schema/traversal-recipes"},{"title":"Geometry Schema","href":"/developers/data-schema/geometry-schema"},{"title":"Proxy Schemas","href":"/developers/data-schema/proxy-schema"}]},{"group":"Connectors","pages":[{"title":"Object Types by Connector","sidebarTitle":"Object Types","href":"/developers/data-schema/connector-index"},{"group":"Schemas by Data Source","pages":[{"title":"ArchiCAD Schema","href":"/developers/data-schema/connectors/archicad-schema"},{"title":"IFC Schema","href":"/developers/data-schema/connectors/ifc-schema"},{"title":"Navisworks Schema","href":"/developers/data-schema/connectors/navisworks-schema"},{"title":"Revit Schema","href":"/developers/data-schema/connectors/revit-schema"},{"title":"Tekla Schema","href":"/developers/data-schema/connectors/tekla-schema"},{"title":"AutoCAD Schema","href":"/developers/data-schema/connectors/autocad-schema"},{"title":"Civil 3D Schema","href":"/developers/data-schema/connectors/civil3d-schema"},{"title":"ETABS Schema","href":"/developers/data-schema/connectors/etabs-schema"},{"title":"Rhino Schema","href":"/developers/data-schema/connectors/rhino-schema"}]}]}]},{"tab":"Interfaces","groups":[{"group":"GraphQL","pages":[{"title":"API reference","href":"/developers/api/graphql"},{"title":"Subscriptions","href":"/developers/api/subscriptions"},{"title":"GraphQL Endpoint","deprecated":null,"version":null,"openapi":"/developers/api/graphql-openapi.json post /graphql","href":"/api-reference/graphql/graphql-endpoint"}]},{"group":"REST","pages":[{"title":"API reference","href":"/developers/api/rest"},{"group":"Previews","pages":[{"title":"Get preview images of models and versions","sidebarTitle":"Overview","href":"/developers/api/previews/preview-service"},{"title":"Get a Project's Latest Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}","href":"/api-reference/previews/get-a-projects-latest-preview"},{"title":"Get a Model's Latest Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}/branches/{branchName}","href":"/api-reference/previews/get-a-models-latest-preview"},{"title":"Get a Version's Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}/commits/{commitId}","href":"/api-reference/previews/get-a-versions-preview"},{"title":"Get an Object's Preview","deprecated":null,"version":null,"openapi":"/developers/api/previews/preview-openapi.json get /preview/{streamId}/objects/{objectId}","href":"/api-reference/previews/get-an-objects-preview"}]},{"group":"Bundles and properties","pages":[{"title":"List a Version's Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/versions/{versionId}/artifacts","href":"/api-reference/bundles/list-a-versions-bundle-files"},{"title":"List a Model's Latest Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/artifacts","href":"/api-reference/bundles/list-a-models-latest-bundle-files"},{"title":"Export a Version's Properties","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/query","href":"/api-reference/properties/export-a-versions-properties"},{"title":"Download a Version's Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/download","href":"/api-reference/properties/download-a-versions-properties-database"},{"title":"Download a Model's Latest Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/eav/download","href":"/api-reference/properties/download-a-models-latest-properties-database"}]},{"group":"Object endpoints (legacy)","pages":[{"title":"Download a Single Object","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}/single","href":"/api-reference/objects/download-a-single-object"},{"title":"Download an Object and All its Children","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}","href":"/api-reference/objects/download-an-object-and-all-its-children"}]},{"group":"Objects","pages":[{"title":"Check if the Server Contains a List of Objects","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/diff/{projectId}","href":"/api-reference/objects/check-if-the-server-contains-a-list-of-objects"},{"title":"Upload a Batch of Objects","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json post /objects/{projectId}","href":"/api-reference/objects/upload-a-batch-of-objects"},{"title":"Download a Single Object","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}/single","href":"/api-reference/objects/download-a-single-object"},{"title":"Download a List of Objects","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/getobjects/{projectId}","href":"/api-reference/objects/download-a-list-of-objects"},{"title":"Download an Object and All its Children","deprecated":true,"version":null,"openapi":"/developers/api/rest-openapi.json get /objects/{projectId}/{objectId}","href":"/api-reference/objects/download-an-object-and-all-its-children"}]},{"group":"Bundles","pages":[{"title":"List a Version's Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/versions/{versionId}/artifacts","href":"/api-reference/bundles/list-a-versions-bundle-files"},{"title":"List a Model's Latest Bundle Files","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v2/projects/{projectId}/models/{modelId}/artifacts","href":"/api-reference/bundles/list-a-models-latest-bundle-files"}]},{"group":"Properties","pages":[{"title":"Export a Version's Properties","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json post /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/query","href":"/api-reference/properties/export-a-versions-properties"},{"title":"Download a Version's Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/versions/{versionId}/eav/download","href":"/api-reference/properties/download-a-versions-properties-database"},{"title":"Download a Model's Latest Properties Database","deprecated":null,"version":null,"openapi":"/developers/api/rest-openapi.json get /api/v1/projects/{projectId}/models/{modelId}/eav/download","href":"/api-reference/properties/download-a-models-latest-properties-database"}]}]},{"group":"Webhooks","pages":[{"title":"Broadcast and Subscribe to Speckle Events with Webhooks","sidebarTitle":"Webhooks Overview","href":"/developers/api/webhooks"},{"title":"Events and Payloads","href":"/developers/api/webhooks/events"},{"title":"Creating and Managing Webhooks","href":"/developers/api/webhooks/management"},{"title":"Webhook Security","href":"/developers/api/webhooks/security"}]},{"group":"Guides","pages":[{"title":"Use model properties in Power Automate, Zapier, or n8n","sidebarTitle":"Low-code flows","href":"/developers/api/guides/low-code-properties"},{"title":"Upload IFC and other files to Speckle","sidebarTitle":"Upload files","href":"/developers/api/guides/file-uploads"},{"title":"Read and Write Project Metadata via GraphQL","sidebarTitle":"Project metadata","tag":"Enterprise","href":"/developers/api/guides/project-metadata"},{"title":"Updating Cloud Integration Syncs via GraphQL","sidebarTitle":"Updating Syncs","href":"/developers/api/guides/updating-syncs"},{"title":"Get Data Validation Results with GraphQL","sidebarTitle":"Validation Results","href":"/developers/api/guides/data-validation-results"},{"title":"Send Slack Notifications from Speckle Webhooks","sidebarTitle":"Slack Notifications","href":"/developers/api/guides/slack-notifications"}]}]},{"tab":"SDKs","groups":[{"group":"Speckle SDKs","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/developers/sdks/introduction"}]},{"group":"Python","icon":"python","pages":[{"title":"specklepy","href":"/developers/sdks/python/introduction"},{"title":"Migrate a specklepy script to 2026.9","sidebarTitle":"Migrate to 2026.9","href":"/developers/sdks/python/migrate-to-2026-9"},{"group":"Getting Started","pages":[{"title":"Installation","href":"/developers/sdks/python/getting-started/installation"},{"title":"Authentication","href":"/developers/sdks/python/getting-started/authentication"},{"title":"Quickstart","href":"/developers/sdks/python/getting-started/quickstart"}]},{"group":"Core Concepts","pages":[{"title":"Python SDK concepts","href":"/developers/sdks/python/concepts/overview"},{"title":"Data Types in Speckle","href":"/developers/sdks/python/concepts/data-types"},{"title":"Objects \u0026 Base Class","href":"/developers/sdks/python/concepts/objects"},{"title":"Data Traversal","href":"/developers/sdks/python/concepts/data-traversal"},{"title":"Display Values","href":"/developers/sdks/python/concepts/display-values"},{"title":"Proxification","href":"/developers/sdks/python/concepts/proxification"}]},{"group":"API Reference","pages":[{"title":"SpeckleClient","href":"/developers/sdks/python/api-reference/client"},{"title":"Operations","href":"/developers/sdks/python/api-reference/operations"},{"group":"Resources","pages":[{"title":"ProjectResource","href":"/developers/sdks/python/api-reference/resources/project"},{"title":"ModelResource","href":"/developers/sdks/python/api-reference/resources/model"},{"title":"VersionResource","href":"/developers/sdks/python/api-reference/resources/version"},{"title":"ActiveUserResource","href":"/developers/sdks/python/api-reference/resources/active-user"},{"title":"OtherUserResource","href":"/developers/sdks/python/api-reference/resources/other-user"},{"title":"WorkspaceResource","href":"/developers/sdks/python/api-reference/resources/workspace"},{"title":"ServerResource","href":"/developers/sdks/python/api-reference/resources/server"}]},{"title":"Transports","href":"/developers/sdks/python/api-reference/transports"},{"title":"Exceptions","href":"/developers/sdks/python/api-reference/exceptions"}]},{"group":"Guides","pages":[{"title":"Working with Speckle Objects","href":"/developers/sdks/python/guides/how-to-work-with-objects"},{"title":"Finding and Extracting Data","href":"/developers/sdks/python/guides/how-to-find-and-extract-data"},{"title":"Performance and Complex Patterns","href":"/developers/sdks/python/guides/how-to-optimize-and-handle-complexity"},{"title":"Simple Data Patterns","href":"/developers/sdks/python/guides/simple-data-patterns"},{"title":"BIM Data Patterns","href":"/developers/sdks/python/guides/bim-data-patterns"},{"title":"Extracting Display Values and Transform Instances","href":"/developers/sdks/python/guides/working-with-proxies"},{"title":"Understanding Speckle Mesh","href":"/developers/sdks/python/guides/understanding-speckle-mesh"},{"title":"Working with Geometry","href":"/developers/sdks/python/guides/working-with-geometry"}]}]},{"group":"C# .NET","icon":"microsoft","pages":[{"title":"speckle-sharp","sidebarTitle":"speckle-sharp","href":"/developers/sdks/dotnet/introduction"},{"title":"Migrate a Speckle.Sdk script to 2026.9","sidebarTitle":"Migrate to 2026.9","href":"/developers/sdks/dotnet/migrate-to-2026-9"},{"group":"Getting Started","pages":[{"title":"Installation","sidebarTitle":"Installation","href":"/developers/sdks/dotnet/getting-started/installation"},{"title":"Build your first model analysis tool","sidebarTitle":"First analysis tool","href":"/developers/sdks/dotnet/guides/build-your-first-model-analysis-tool"},{"title":"Automate with scripts and notebooks","sidebarTitle":"Scripts","href":"/developers/sdks/dotnet/getting-started/scripts-and-notebooks"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/developers/sdks/dotnet/getting-started/authentication"},{"title":"Publish and load a model from C#","sidebarTitle":"Quickstart","href":"/developers/sdks/dotnet/getting-started/quickstart"}]},{"group":"Guides","pages":[{"title":"Use SpeckleSharp in a Grasshopper C# node","sidebarTitle":"Grasshopper C#","href":"/developers/sdks/dotnet/guides/use-speckle-sdk-in-grasshopper-csharp"},{"title":"Find objects by property","sidebarTitle":"Find \u0026 extract","href":"/developers/sdks/dotnet/guides/finding-and-extracting-data"},{"title":"Export model data to CSV","sidebarTitle":"Export to CSV","href":"/developers/sdks/dotnet/guides/export-model-data-to-csv"},{"title":"Send analysis results back to Speckle","sidebarTitle":"Send results back","href":"/developers/sdks/dotnet/guides/send-analysis-results-back"},{"title":"BIM data patterns","sidebarTitle":"BIM patterns","href":"/developers/sdks/dotnet/guides/bim-data-patterns"},{"title":"Compare two model versions","sidebarTitle":"Compare versions","href":"/developers/sdks/dotnet/guides/compare-two-model-versions"},{"title":"Resolve groups and instances","sidebarTitle":"Proxies","href":"/developers/sdks/dotnet/guides/working-with-proxies"},{"title":"Read and create geometry","sidebarTitle":"Geometry","href":"/developers/sdks/dotnet/guides/working-with-geometry"},{"title":"Handling server capabilities","href":"/developers/sdks/dotnet/guides/handling-server-capabilities"},{"title":"Publish large models (connectors)","sidebarTitle":"Connector sends","href":"/developers/sdks/dotnet/guides/building-connector-scale-sends"}]},{"group":"Concepts","pages":[{"title":"How your code talks to Speckle Server","sidebarTitle":"Core concepts","href":"/developers/sdks/dotnet/concepts/overview"},{"title":"Work with model objects","sidebarTitle":"Objects","href":"/developers/sdks/dotnet/concepts/objects-and-traversal"},{"title":"Load and publish model data","sidebarTitle":"Send \u0026 receive","href":"/developers/sdks/dotnet/concepts/send-and-receive-paths"},{"title":"Dependency injection (connectors)","sidebarTitle":"DI (advanced)","href":"/developers/sdks/dotnet/concepts/dependency-injection"}]},{"group":"API Reference","pages":[{"title":"Client","sidebarTitle":"Client","href":"/developers/sdks/dotnet/api-reference/client"},{"title":"Service registration","sidebarTitle":"Registration","href":"/developers/sdks/dotnet/api-reference/service-registration"},{"title":"Operations","sidebarTitle":"Operations","href":"/developers/sdks/dotnet/api-reference/operations"},{"group":"Resources","pages":[{"title":"Project","sidebarTitle":"Project","href":"/developers/sdks/dotnet/api-reference/resources/project"},{"title":"Model","sidebarTitle":"Model","href":"/developers/sdks/dotnet/api-reference/resources/model"},{"title":"Version","sidebarTitle":"Version","href":"/developers/sdks/dotnet/api-reference/resources/version"},{"title":"Users","sidebarTitle":"Users","href":"/developers/sdks/dotnet/api-reference/resources/users"},{"title":"Workspace","sidebarTitle":"Workspace","href":"/developers/sdks/dotnet/api-reference/resources/workspace"},{"title":"Server","sidebarTitle":"Server","href":"/developers/sdks/dotnet/api-reference/resources/server"},{"title":"Model ingestion","sidebarTitle":"Ingestion","href":"/developers/sdks/dotnet/api-reference/resources/ingestion"}]},{"title":"Transports","sidebarTitle":"Transports","href":"/developers/sdks/dotnet/api-reference/transports"},{"title":"Exceptions","sidebarTitle":"Exceptions","href":"/developers/sdks/dotnet/api-reference/exceptions"}]}]},{"group":"JS/TS","icon":"javascript","pages":[{"title":"speckle.js","href":"/developers/sdks/typescript/introduction"}]}]},{"tab":"Viewer","groups":[{"group":"Speckle Viewer","pages":[{"title":"Developers Guide","sidebarTitle":"Getting Started","href":"/developers/viewer/introduction"},{"title":"Load a bundle in your Viewer app","sidebarTitle":"Loading bundles","href":"/developers/viewer/loading-bundles"},{"title":"Installation","href":"/developers/viewer/installation"},{"title":"Basic Setup","href":"/developers/viewer/basic-setup"},{"title":"Advanced Setup","href":"/developers/viewer/advanced-setup"}]},{"group":"Core Concepts","pages":[{"title":"3D Viewer","href":"/developers/viewer/overview"},{"title":"Data Tree","href":"/developers/viewer/viewer-data"},{"title":"Rendering","href":"/developers/viewer/viewer-rendering"},{"title":"Loaders","href":"/developers/viewer/loaders"}]},{"group":"API Reference","pages":[{"group":"Viewer Core","pages":[{"title":"AccelerationStructure","href":"/developers/viewer/acceleration-structure-api"},{"title":"Batch","href":"/developers/viewer/batch-api"},{"title":"BatchObject","href":"/developers/viewer/batch-object-api"},{"title":"GeometryConverter","href":"/developers/viewer/geometry-converter-api"},{"title":"Input","href":"/developers/viewer/input-api"},{"title":"Intersections","href":"/developers/viewer/intersections-api"},{"title":"Loader","href":"/developers/viewer/loader-api"},{"title":"Queries","href":"/developers/viewer/queries-api"},{"title":"NodeRenderView","href":"/developers/viewer/render-view-api"},{"title":"RenderTree","href":"/developers/viewer/render-tree-api"},{"group":"Rendering Pipelines","pages":[{"title":"Pipeline","href":"/developers/viewer/rendering-pipeline-api/pipeline-api"},{"title":"ProgressivePipeline","href":"/developers/viewer/rendering-pipeline-api/progressive-pipeline-api"},{"title":"GPass","href":"/developers/viewer/rendering-pipeline-api/g-pass-api"},{"title":"BaseGPass","href":"/developers/viewer/rendering-pipeline-api/base-g-pass-api"},{"title":"ProgressiveGPass","href":"/developers/viewer/rendering-pipeline-api/progressive-g-pass-api"}]},{"title":"SpeckleMaterial","href":"/developers/viewer/speckle-material-api"},{"title":"SpeckleRenderer","href":"/developers/viewer/speckle-renderer-api"},{"title":"TopLevelAccelerationStructure","href":"/developers/viewer/top-level-acceleration-structure-api"},{"title":"Viewer","href":"/developers/viewer/viewer-api"},{"title":"WorldTree","href":"/developers/viewer/world-tree-api"}]},{"group":"Extensions","pages":[{"title":"Extension","href":"/developers/viewer/extensions/extension-api"},{"title":"CameraController","href":"/developers/viewer/extensions/camera-controller-api"},{"title":"DifExtension","href":"/developers/viewer/extensions/diff-extension-api"},{"title":"FilteringExtension","href":"/developers/viewer/extensions/filtering-extension-api"},{"title":"MeasurementsTool","href":"/developers/viewer/extensions/measurements-tool-api"},{"title":"SelectionExtension","href":"/developers/viewer/extensions/selection-extension-api"},{"title":"SectionTool","href":"/developers/viewer/extensions/section-tool-api"},{"title":"SectionToolOutlines","href":"/developers/viewer/extensions/section-tool-outlines-api"},{"title":"SpeckleControls","href":"/developers/viewer/extensions/speckle-controls-api"},{"title":"SmoothOrbitControls","href":"/developers/viewer/extensions/smooth-orbit-controls-api"},{"title":"ViewModes","href":"/developers/viewer/extensions/view-modes-api"}]}]},{"group":"Examples","pages":[{"title":"Basic Example","href":"/developers/viewer/examples/basic-example"},{"title":"More Extensions","href":"/developers/viewer/examples/more-extensions-example"},{"title":"Filtering","href":"/developers/viewer/examples/filtering-example"},{"title":"Loading Data","href":"/developers/viewer/examples/loading-example"},{"title":"Object Manipulation","href":"/developers/viewer/examples/object-manipulation-example"},{"title":"Box Selection","href":"/developers/viewer/examples/box-selection-example"},{"title":"Animation \u0026 Custom Text","href":"/developers/viewer/examples/categorize-example"}]},{"group":"Reference","pages":[{"title":"Migration Guide","href":"/developers/viewer/migration-guide"},{"title":"Backwards Compatibility","href":"/developers/viewer/migration-guide-compatibility"},{"title":"API 1.0 Full Migration","href":"/developers/viewer/migration-guide-v1"}]}]},{"tab":"Server","groups":[{"group":"Speckle Server","pages":[{"title":"Hosting Your Own Speckle Server","sidebarTitle":"Overview","href":"/developers/server/introduction"},{"title":"Choosing a Speckle Deployment","sidebarTitle":"Choosing a Deployment","href":"/developers/server/self-hosted-vs-cloud-hosted-speckle"},{"title":"Docker Compose Quickstart","sidebarTitle":"Getting Started","href":"/developers/server/getting-started"},{"title":"Server Architecture","href":"/developers/server/architecture"},{"title":"Self-Hosted Deployment Options","href":"/developers/server/deployment-options"}]},{"group":"Deployment","pages":[{"title":"Deploy to Kubernetes","href":"/developers/server/deployment/kubernetes-with-helm"},{"title":"Server Maintenance","href":"/developers/server/deployment/backup-upgrade-restore"},{"title":"Deploying a Speckle Enterprise licensed server","sidebarTitle":"Enterprise Servers","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license"},{"title":"Deploying a Speckle Enterprise licensed Automate server","sidebarTitle":"Enterprise Automate","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license-automate"},{"title":"Deploying a Speckle Enterprise licensed Intelligence server","sidebarTitle":"Enterprise Intelligence","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license-intelligence"},{"title":"Deploying a Speckle Enterprise licensed Desktop UI server","sidebarTitle":"Enterprise licensed Desktop UI","tag":"Enterprise","href":"/developers/server/deployment/enterprise-license-desktop-ui"}]},{"group":"Local Development","pages":[{"title":"Environment Setup","href":"/developers/server/development/setup"}]}]},{"tab":"Automate","groups":[{"group":"Speckle Automate","pages":[{"title":"Powering Your Automation Workflows","sidebarTitle":"Overview","tag":"Enterprise","href":"/developers/automate/introduction"},{"title":"Quickstart Guide","href":"/developers/automate/quickstart"},{"title":"API Reference","href":"/developers/automate/api-reference"},{"title":"Frequently Asked Questions","href":"/developers/automate/faq"}]},{"group":"Automate Functions","pages":[{"title":"Create an Automate function","sidebarTitle":"Creating Functions","href":"/developers/automate/create-function"},{"title":"Making Your Function","href":"/developers/automate/making-your-function"},{"title":"Function Inputs","href":"/developers/automate/function-inputs"},{"title":"Releasing a New Version","href":"/developers/automate/release-function-version"},{"title":"Publishing Automate Functions without the GitHub App","sidebarTitle":"Publish without GitHub","href":"/developers/automate/publishing-without-github"}]},{"group":"Working with Data","pages":[{"title":"Handling Data in Functions","href":"/developers/automate/function-data"},{"title":"AutomationContext","href":"/developers/automate/function-context"},{"title":"Annotating Function Results","href":"/developers/automate/function-results"},{"title":"Reporting Success","href":"/developers/automate/function-success"},{"title":"Function Artefacts","href":"/developers/automate/function-artefacts"}]},{"group":"Creating Automations","pages":[{"title":"Creating Automations","href":"/developers/automate/create-automation"},{"title":"Viewing Automation Results","href":"/developers/automate/viewing-results"},{"title":"Update an Automation","href":"/developers/automate/update-automation"}]},{"group":"Testing \u0026 Development","pages":[{"title":"Testing Your Functions","href":"/developers/automate/function-testing"},{"title":"Troubleshooting Automations","href":"/developers/automate/troubleshooting"}]},{"group":"Reference","pages":[{"title":"Considerations \u0026 Limitations","href":"/developers/automate/important-considerations"},{"title":"Function Specification","href":"/developers/automate/function-specification"}]}]}],"global":{"anchors":[]}},{"dropdown":"IT Administrators","icon":"wrench","groups":[{"group":"Deployment \u0026 Maintenance","pages":[{"title":"IT setup guide","href":"/it-admin/setup"},{"title":"Keep connectors current across your estate","sidebarTitle":"Connector updates","href":"/it-admin/connector-updates"},{"title":"Security","href":"/it-admin/security"},{"group":"Cloud Integrations","pages":[{"title":"Cloud Integrations: Access and Governance","sidebarTitle":"Introduction","href":"/it-admin/integrations/introduction"},{"title":"Enable Autodesk Forma Data Management integration","sidebarTitle":"Forma Data Management (ACC)","tag":"Enterprise","href":"/it-admin/integrations/acc"},{"title":"Configure Bentley ProjectWise Integration","sidebarTitle":"Bentley ProjectWise","tag":"Enterprise","href":"/it-admin/integrations/projectwise"},{"title":"Approve Speckle for SharePoint","sidebarTitle":"SharePoint","href":"/it-admin/integrations/sharepoint"},{"title":"Enable Databricks Integration","sidebarTitle":"Databricks","href":"/it-admin/integrations/databricks"},{"title":"Enable Snowflake Integration","sidebarTitle":"Snowflake","href":"/it-admin/integrations/snowflake"}]},{"title":"Admin Support Mode","href":"/it-admin/support-mode"},{"title":"Archive and unarchive projects","sidebarTitle":"Project Archival","tag":"Enterprise","href":"/it-admin/archived-projects"},{"title":"What's new in 2026.9 for IT admins","sidebarTitle":"What's new","href":"/whats-new/it-admins"}]},{"group":"Manual Connector Installation","pages":[{"title":"Manual installation","sidebarTitle":"Overview","href":"/connectors/manual-installation/introduction"},{"title":"Desktop Services","sidebarTitle":"Desktop Services (deprecated)","href":"/connectors/manual-installation/desktop-services"},{"title":"Archicad","href":"/connectors/manual-installation/archicad"},{"title":"AutoCAD","href":"/connectors/manual-installation/autocad"},{"title":"Blender","href":"/connectors/manual-installation/blender"},{"title":"Civil 3D","href":"/connectors/manual-installation/civil3d"},{"title":"ETABS","href":"/connectors/manual-installation/etabs"},{"title":"Navisworks","href":"/connectors/manual-installation/navisworks"},{"title":"Power BI","href":"/connectors/manual-installation/powerbi"},{"title":"Revit","href":"/connectors/manual-installation/revit"},{"title":"Rhino \u0026 Grasshopper","href":"/connectors/manual-installation/rhino-grasshopper"},{"title":"SketchUp","href":"/connectors/manual-installation/sketchup"},{"title":"Tekla Structures","href":"/connectors/manual-installation/teklastructures"}]}],"global":{"anchors":[]}},{"dropdown":"Get Involved","icon":"users","groups":[{"group":"Ways to get involved","pages":[{"title":"User testing and feedback","sidebarTitle":"User Testing","href":"/get-involved/user-testing"},{"title":"Join the Speckle Community","sidebarTitle":"Community","href":"/get-involved/community"},{"title":"Open source at Speckle","sidebarTitle":"Open source","href":"/get-involved/open-source"}]}],"global":{"anchors":[]}},{"dropdown":"Changelog","icon":"history","pages":[{"title":"Changelog — November 2026","sidebarTitle":"November 2026","href":"/technical-changelog/2026-11"},{"title":"Changelog — October 2026","sidebarTitle":"October 2026","href":"/technical-changelog/2026-10"},{"title":"Changelog — September 2026","sidebarTitle":"September 2026","href":"/technical-changelog/2026-09"}],"global":{"anchors":[]}}]},"basePath":"","title":"Extract Revit room data with SpecklePy - Speckle Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}