Working with Altium 365 & Design Data

Modified on Tue, 28 Mar 2023 at 12:56 PM

The design side of our API (queries prefixed "des") provides data on your Altium 365 account and workspaces. Examples of this data would be library components and part choices, projects with their releases, or workflows.

To access this data you will need to be signed up for a Nexar account and have an application with the design scope enabled. You will also need to be a member of an Altium 365 workspace otherwise there is no data to retrieve.

Important Links:

  • Nexar Portal - for managing your account, applications, and testing queries
  • Banana Cake Pop - our IDE (integrated development environment), which allows you to develop and save queries. It also includes our schema
  • Voyager - a visual representation of our API's schema showing how it all links together
  • Altium 365 - for managing your account and workspaces

Our NexarDeveloper GitHub is home to many of our examples in varying languages such as javascript or python. A good place to start would be our first-design-query example which is a console app that looks up projects in an Altium 365 workspace.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article