Making your first Supply Data Query

Contents

• Signing Up Process
• Create your first Application
• Making your first Query
• Next Steps

This guide will cover how to set up your Nexar account to query the Supply API with some pre-made example queries.

Signing Up Process

If you have already signed up for Nexar you can skip this section. If your team has already accessed Nexar please ask them to invite you to their Organization. They can do this by:

1. Go to portal.nexar.com
2. On the "Dashboard" tab scroll down to "Team"
3. Click on "Invite member" and then enter your email address.

You'll receive an invitation email which you can then accept and it will then take you through the Nexar sign-up process.

If not, please follow the following steps. If you ever get stuck we have a specific sign-up process guide with screenshots. 

1. Go to nexar.com
2. At the time of writing offer SSO, Google, and Facebook sign-in options. If you are going to use one of those you can click on the sign-in button in the top right. Otherwise, please click on the create an account button in the middle
3. Once you have created your account, verified your email, etc you'll be taken back to the login page. Login with your new details
4. If you aren't joining an existing organization you will be asked to create one with some basic details.

Create your first Application

Applications are key to the Nexar API. Once you have signed up and are logged in to portal.nexar.com you are ready to create your first one.

1. Go to the "Applications" tab on the left-hand side
2. Click on "Create app"
3. Fill in an app name and description then make sure to select the supply scope
4. Optionally you may add the design scope. This will allow you to work with Altium 365 data in this application
5. Click "Create"

Making your first Query

Select the application you want to query with by clicking "Details". 

Then click on "IDE". 

On this page, you are able to query the Supply API. There are some pre-made examples of queries for categories, parts, and multi-match searches. The "Part Search" and "Multi Match Search" will count against the applications part limit. The default part limit is 1000 which you get with a free evaluation app. If you want to increase this, you can sign up for a self-serve plan. If you want an enterprise plan, click "Get in touch" on the settings page. Once your query is ready, click the blue arrow to run your query. The results will be displayed on the right. 

That's it, you have successfully queried the Supply API.

Next Steps

Have a play around with the queries in this editor. We have a visual representation of our schema that will help you to build new queries or check out the "Data Model" section of our documentation.

Please see our folder containing more articles about how you can use the API to access supply data.

To query supply data in an IDE, we have a guide on querying with Banana Cake Pop.

To query supply data in various languages, we have examples in C#, javascript, and python.