# revit-extractor

**Repository Path**: alegw/revit-extractor

## Basic Information

- **Project Name**: revit-extractor
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-20
- **Last Updated**: 2026-07-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


![Platform](https://img.shields.io/badge/platform-Windows/MacOS/Linux-lightgray.svg) [![License: GNU v3](https://img.shields.io/badge/License-GNU-yellow.svg)](https://opensource.org/licenses/MIT)


![PyPI](https://img.shields.io/pypi/v/revit-extractor?label=pypi%20revit-extractor-python)
![PyPI - Downloads](https://img.shields.io/pypi/dm/revit-extractor?label=pipy-download)

<a href="https://twitter.com/intent/follow?screen_name=chuongmep">
<img src="https://img.shields.io/twitter/follow/chuongmep?style=social&logo=twitter"
alt="follow on Twitter"></a>

## Revit Extractor

Revit Extractor is a library that allows you to export native data from Revit files without needing to open Revit. It’s particularly useful for extracting data from Revit files and integrating it into other systems.

![](./samples/background.png)


## Requirements

- Make sure you have Revit installed on your machine.
- Make sure you have Python installed on your machine version `3.9` or later.
- Make sure you are running on Windows Platform. MacOS and Linux are not supported. 

## How to use

1. Install the library by using pip:
```bash
pip install revit-extractor --upgrade
```

2. Get Revit Version 

```py
from revit_extract import RevitExtractor
rvt_path = r"D:\_WIP\Download\Sample Office Building Model V1.rvt"
version = RevitExtractor.get_version(rvt_path)
print(version)
```
Bulk Extract All Models Version : 

```python
import os
import pandas as pd
from revit_extract import RevitExtractor
path = "D:\Development\Revit\Project\XXX\Electrical"
def get_files(path):
    df = pd.DataFrame(columns=['File', 'Version'])
    for r, d, f in os.walk(path):
        for file in f:
            if '.rvt' in file:
                version = RevitExtractor.get_version(os.path.join(r, file))
                df.loc[len(df)] = [file, version]
    return df
df = get_files(path)
df.head()
```

3. Use the library in your code:

- Extract all categories from Revit file:

```python
from revit_extract import RevitExtractor
rvt_path = r"D:\_WIP\Download\Sample Office Building Model V1.rvt"
prodb = RevitExtractor(rvt_path).read_prob_data()
categories = prodb.get_all_categories()
for key in categories:
    print(key, categories[key])
```

- Extract data by categories and parameters from Revit file:
```python
from revit_extract import RevitExtractor
rvt_path = r"D:\_WIP\Download\Sample Office Building Model V1.rvt"
prodb = RevitExtractor(rvt_path).read_prob_data()
categories =["Walls", "Doors"]
params = ["Name", "Type", "Level"]
data_frame = prodb.get_data_by_categories_and_params(categories, params)
data_frame.to_excel("output.xlsx", index=False)
```

Check [Example Files](./samples/Demo.ipynb)

## Limitation

- Export Schedule table data is not supported with svf format.

- Geometry data is limit supported to read at the moment (But can export and use APS-Toolkit)


## Development

- Clone the repository
- Install the dependencies by running `pip install -r requirements.txt`
- Run the tests by running `pytest`
- Make your changes

I'm happy to accept pull requests and contributions. If you have any questions, feel free to ask.

## Disclaimer

This is not an official Autodesk product to support for [Autodesk Platform Services](https://aps.autodesk.com/). Use it at your own risk.

I'm not responsible for any data loss or any other issues caused by using this library, some features need require cost for using. Please read carefully the Autodesk Forge and Autodesk Platform Services terms of use. I'm just doing, testing , maintaining in free time, so feel free to contribute and make it better.

## License

This project is licensed under the GNU v3 License - see the [LICENSE](./License.md) file for details

## References

- [Use Revit Extractor](https://chuongmep.com/posts/2024-09-25-revit-extractor.html)

## Disclaimer
This is not an official method recommended by Autodesk, for academic purposes only, please use [Design Automation](https://aps.autodesk.com/en/docs/design-automation/v3/tutorials/revit/) or official support services from Autodesk like [AEC Data Model API](https://aps.autodesk.com/autodesk-aec-data-model-api)