Blender 2.83.10 Python API Documentation

Welcome to the Python API documentation for Blender, the free and open source 3D creation suite.

This site can be used offline: Download the full documentation (zipped HTML files)

Documentation

• Quickstart: new to Blender or scripting and want to get your feet wet?
• API Overview: a more complete explanation of Python integration
• API Reference Usage: examples of how to use the API reference docs
• Best Practice: Conventions to follow for writing good scripts
• Tips and Tricks: Hints to help you while writing scripts for Blender
• Gotcha's: some of the problems you may come up against when writing scripts
• List of changes since last Blender release

Application Modules

• Context Access (bpy.context)
• Data Access (bpy.data)
• Message Bus (bpy.msgbus)
• Operators (bpy.ops)
• Types (bpy.types)
• Utilities (bpy.utils)
• bpy.utils submodule (bpy.utils.previews)
• Path Utilities (bpy.path)
• Application Data (bpy.app)
• Property Definitions (bpy.props)

Standalone Modules

• Math Types & Utilities (mathutils)
• Freestyle Module (freestyle)
• OpenGL Wrapper (bgl)
• Font Drawing (blf)
• Image Buffer (imbuf)
• GPU Shader Module (gpu)
• GPU Utilities (gpu_extras)
• Audio System (aud)
• Extra Utilities (bpy_extras)
• ID Property Access (idprop.types)
• BMesh Module (bmesh)