Altium Design Software API Reference

Created: June 06, 2016 | Updated: September 26, 2016 | Applies to versions: 3.1, 3.2, 4 and 5

Now reading version 4. For the latest, read: Altium Design Software API Reference for version 5

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

Parent page: Altium NEXUS API

Please note that this documentation was last updated for an older version of Altium NEXUS. 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 NEXUS 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 NEXUS. 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

Printer-friendly version

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.

Altium Design Software API Reference

Was this page helpful?