#1 Selection Basics

Let's start with the Selection class so you know how to get elements with code. This is a great first step into API. Afterall, we need to get some elements with code to test all other concepts.

So, here is how to do it:

In the Docs you will find Selection methods to get user selection or prompt certain selection method. But we need a Selection instance related to a project. And we can get it from uidoc variable.

Here is a code sample:

Let me break down what's included:

• Example on getting Selection instance.

• Get User Selection (with optional Filter)

• Pick Single Object

• Pick Multiple Objects

⌨️ Copy one part at the time and test them in your own code.

#2 Master Getting Element

In case you want to get all elements of certain categories (like walls, rooms...) then you would need to use collectors in Revit API.

Here is how it works:

FilteredElementCollector might look and sound intimidating, but it's one of the most repetitive classes in Revit API. So it's easy to remember.

In general there are 4 steps:

• Create collector by connecting to your project (doc)

• Filter with OfCategory or OfClass

• Optionally filter Instances/Types

• Lastly, convert to list of Elements or Element Ids.

That's it. Now you can apply this principle to get any elements in the project.

Here are many examples

💡Notice how repetitive it is. I specifically marked the parts you need to change to get different results. Now it's not so complicated, isn't it?

​

P.S. You can check this free tutorial to learn more.

#3 Look inside Elements

Once you get elements you can look inside of them. But before you pull up your code-editor, make sure you look inside with Revit Lookup.

💡Revit Lookup - is a free Add-In that let's you look inside your elements to understand Revit API names and the values you can get. (Must have for any Revit API Dev)

​

It's simple to use.

• Select elements in Revit UI

• Go to Add-Ins tab

• Select Snoop Selection in RevitLookup

  

And then you will see this UI menu with all the information about selected elements. This is a life saver.

Inside you can navigate and explore your elements:

• Properties

• Methods

• Parameters

• Most importantly - Returned Values

​

💡I always use it before I open my code-editor. It will help you get a better understanding on how to get the right values with API.

#4 Read Values with Code

After I found what I need in RevitLookup I can get the same values using code. And for that you need to understand how to read Properties and Methods in OOP.

Here is an example:

Let's breakdown:

• We need basic imports and variables

• Then we will prompt user to Pick an object

• And we will read various properties.

💡In RevitAPI we often work with ElementId to be memory efficient. Therefore, we need to convert into an actual Element to access all the values it holds. And then it's the basic OOP workkflow.

​

New to OOP? Don't worry, check this tutorial for Revit API beginners.

#5 Parameters in Revit API

Next, you need to keep in mind that Parameters and Properties aren't the same. There is a property called Parameters, which contains a list of element parameters.

Property - Is an attribute associated with a class/instance that can hold data. We can access it like: element.ParamName

Parameter - is similar for Revit users, but for developers it's a completely different object associated with your elements. First you need to get the right parameter and then use Parameter class methods to read its values.

💡Also, keep in mind that Instance and Type parameters are located in different objects (e.g. Wall.Parameters -> Instance / WalLType.Parameters -> Type). This means you can't get TypeParameter from instance and vice-versa. You need to get the right object first.

Here is a code snippet of the basics:

Breakdown:

• Regular Imports and Variables

• 1. PickObject to test code

• 2. How-To Get Built-In Parameters

• 3. How to get Shared Parameters

• 4. How to Read Values

• 5. How to Set New Values

#6 Changes with Revit API

Next you need to understand that to make any changes in Revit API you have to use Transaction Class. It's like a gate keeping for Revit to avoid any accidental changes with code.

It means that beginners can safely explore Revit API without a fear of breaking or changing anything. And even if you try to change something, you will get an error message saying "Attempt to modify project without using Transaction".

And it's also easy to use.

Typically there are 2 ways to use it:

• Regular use

• Context-Manager (using with keyword)

#7 pyRevit UI Forms

Lastly, I want you to be aware that pyRevit comes with a lot of dev features beginners can start using with a few lines of code.

And pyRevit's UI forms is one of those features. It's the best and very beginner friendly.

You can check this page in pyRevit Docs: Effective Inputs that provides you short actionable code-snippets and screenshots of the forms you get. (Bookmark it, you will use it a lot)

To test it, just head over to the link I mentioned, find a form you find interesting and copy the code snippet into your own script. And now you have a custom UI Form for your tool.

Isn't it amazing?

Want help (actually) putting these tips into action?

I hope you found this helpful.

And I want to remind you the most important part: Reading Revit API tips along will NOT help you automate revit like a Pro. You need to actually put them into practice.

And of course, that’s easier said than done.

​

So, if you’d like some help implementing all of these tips (and plenty of other proven frameworks), then I’d love to invite you inside LearnRevitAPI Academy.

​Click Here to join the training that will explain you every single step I mentioned in this email in more depth and with practical examples.

Join today to become 10X more productive in Revit using python.
​See you inside!