FAQ

How much does API access cost and where can I apply for a token?

You can view our subscription plans on the registration page here.

What kind of data is available via the API?

You can access supply chain data using the Nexar Legacy API. If you would like to access additional design and manufacturing data you can sign up for the full Nexar API here.

Why is my credit card information required when applying for a Nexar Legacy API token?

We require that you provide a valid credit card for authentication purposes. This added security layer allows us to offer a free tier while keeping our partners' data secure.

How many API tokens can I have?

At this time, users are permitted a single API token per email address. If you would like to sign up for API access, you can register here. To learn more, please visit our Get Started page. The self service portal allows you to adjust your plan as desired.

Is there a difference between an API token and an API key?

No. They are used interchangeably at Octopart.

I can't find my APIv3 Dashboard. How can I locate my Nexar Legacy API key?

While you can still access your APIv3 Dashboard here, please keep in mind that as of March 31, 2022 this version of the API will no longer be suppored, and as of June 30, 2022 it will be completely disabled. Please sign up for a Nexar Legacy API key here prior to this date.

Can I still use REST on the new API?

Yes, you can use REST on Nexar Legacy API. For future compatibility we recommend moving to GraphQL on Nexar Legacy API. As of June 30, 2022 we will be shutting down APIv3 and support will end on March 31, 2022.

My Nexar Legacy API token won’t let me access APIv3.

The API token that was generated for you is exclusively for Nexar Legacy API. We are no longer accepting new registrations for APIv3. This version of the API will be shut down as of June 30, 2022, and will no longer be supported as of March 31, 2022. Please visit our Get Started to learn more about the differences between APIv3 and the Nexar Legacy API. To find documentation and resources for the Nexar Legacy API, please visit our API documentation.

Please visit our v3 to Nexar Legacy API REST documentation page to learn more about moving to Nexar Legacy API REST.

How do I learn to use the Nexar Legacy API step-by-step?

Please visit our Get Started page to begin. You will be able to view examples in different programming languages. Nexar Legacy API Documentation provides in-depth knowledge of how to make a query with the appropriate fields.

To find documentation and resources for v3 of the Octopart API, please visit our APIv3 documentation. As of March 31, 2022, APIv3 will no longer be supported, and as of June 30, 2022 APIv3 will be completely disabled.

Can you give me an example of how to make a query?

Please visit our Get Started page to view examples in different programming languages.

To find documentation and resources for v3 of the Octopart API, please visit our APIv3 documentation. As of March 31, 2022 APIv3 will no longer be supported, and as of June 30, 2022 APIv3 will be completely disabled.

How do I make a query in C#?

You can use the Nexar Legacy API from any language. We'd love to provide C# code examples but at this time we don't have any. The best place to refine your queries is in the GraphQL Playground. We are hoping to add more examples in the future.

To find documentation and resources for v3 of the Octopart API, please visit our APIv3 documentation. As of March 31, 2022 APIv3 will no longer be supported, and as of June 30, 2022 APIv3 will be completely disabled.

How do I use CURL to make API requests?

Please visit our Get Started page to view examples in different programming languages, including CURL.

To find documentation and resources for v3 of the Octopart API, please visit our APIv3 documentation. As of March 31, 2022 APIv3 will no longer be supported, and as of June 30, 2022 APIv3 will be completely disabled.

How can I get results from a specific manufacturer in the API?

You will have to include the specific manufacturer name and the corresponding ID in the query. We have a list of manufacturers here that you can choose from. The Nexar Legacy API Documentation provides further details on how to call for specific companies here.

How can I get results from a specific distributor in the API?

You will have to include the specific seller company name and its corresponding ID in the query. We have a list of distributors here that you can include in your search. The Nexar Legacy API Documentation provides further details on how to call for companies here.

Is there a way to receive part data exclusively from authorized distributors?

In order to see only authorized distributors in your data results, you must include the is_authorized field in your request. Our API documentation provides more information on filtering through sellers with offers for a given part here. If you would like to learn about distributor classification, you may visit this page.

How can I view category trees in the API playground?

The path field is helpful to see where a category is in the tree. You can learn more about category fields and descriptions here.

I am having trouble using Nexar Legacy API with applications like Partkeepr. Please help?

As of late 2020, PartKeepr is compatible with Nexar Legacy API. We recommend signing up for a Pro tier token to get the most out of the Nexar Legacy API. You can sign up here.

Why can't I access price, availability, or images with the API?

If you are a distributor or affiliated with electronic component distribution, please read our Terms of Use to learn more. Otherwise, please contact us at api@octopart.com.

How are the currencies returned determined?

All currencies returned are original offers from distributors, if you'd like to ensure a specific currency is returned please make sure to include the country_flag and currency in your query.