Search In: Doc:Documentation: Altium Designer
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 17.1
222120.220.1
Close
Search Search on Documentation

Altium Design Software API Reference

Created: June 06, 2016 | Updated: September 26, 2016 | Applies to versions: 20.1, 20.2 and 21
Now reading version 17.1. For the latest, read: Altium Design Software API Reference for version 22

Parent page: Altium Designer API

Please note that this documentation was last updated for an older version of Altium Designer. While many of the principles and approaches will remain the same, be aware that interfaces, objects, methods, properties, and the like will have changed since then, and will not reflect the entirety of those found in later versions of the software.

The Altium Designer Application Programming Interface (API) is composed of several APIs that are associated with specific document kinds and design object types.

The System API deals with low level objects and routines used by Altium Designer. The Schematic API deals with Schematic documents and design objects. The PCB API deals with PCB documents and design objects. The Workspace Manager API deals with Projects, Connectivity Information and so on.

Technical Reference - System API

Technical Reference - Integrated Library API

Technical Reference - PCB API

Technical Reference - Schematic API

Technical Reference - Workspace Manager API
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Note

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.