Skip to main content

Octopart API

The Octopart API is a GraphQL API for electronic component supply data: parts, offers, pricing and stock, part families, reference designs, solution templates, software projects and BOM analysis. This site is the reference for every query, mutation and type it exposes, generated nightly from the production schema.

Get started​

Creating an application, obtaining an access token and calling the API for the first time are covered in the Altium Developer Center:

The endpoint, a first query and the Nitro and Voyager tools are in Getting started.

How this reference is organised​

The API is grouped by bounded context: a business area with its own entities and vocabulary. Each context lists its queries, mutations and types. Where an API type represents an entity of the Common Data Model (CDM), its page links to the entity definition.

Guides​

Bounded contexts, Naming conventions, Pagination, Errors and Plans and limits explain how the API is shaped and how to use it.

For AI assistants and code generators​

Start at llms.txt: an index of the bounded contexts, each with its own llms.txt and a compact schema.graphql slice. Every page is also available as Markdown (.md). The schema of everything documented here, in SDL form, is schema.graphql, regenerated together with this site; each bounded context also publishes a smaller slice at /reference/<context>/schema.graphql.


Comments​