Welcome to the QGIS Python API documentation project

Introduction

QGIS is a user friendly Open Source Geographic Information System (GIS) that runs on Linux, Unix, macOS, and Windows. QGIS supports vector, raster, and database formats. QGIS is licensed under the GNU General Public License. QGIS lets you browse and create map data on your computer. It supports many common spatial data formats (e.g. ESRI ShapeFile, GeoPackage, PostGIS, geotiff). QGIS supports plugins to do things like display tracks from your GPS. QGIS is Open Source software and it is free of cost (download here). We welcome contributions from our user community in the form of code contributions, bug fixes, bug reports, contributed documentation, advocacy and supporting other users on our mailing lists and forums. Financial contributions are also welcome.

QGIS source code is available at https://github.com/qgis/QGIS. There is also a C++ version of the API documentation available.

Earlier versions of the API

See Backwards Incompatible Changes for information about incompatible changes to API between releases.

Earlier versions of the documentation are also available on the QGIS website: 3.32, 3.30, 3.28 (LTR), 3.26, 3.24, 3.22 (LTR), 3.20, 3.18, 3.16 (LTR), 3.14, 3.12, 3.10 (LTR), 3.8, 3.6, 3.4 (LTR), 3.2, and 3.0.

Communication channels

For support we encourage you to join our mailing lists for users and developers. Some QGIS users and developers can also often be found in channels such as Matrix, Telegram,…

Bug Reporting

If you think you have found a bug in the documentation, please report it using our bug tracker. When reporting bugs, please be available to follow up on your initial report.

Contents:

Indices and tables