Altium Developer Center

Articles and information related to Altium Developer Center - A collection of tools, approaches and guides for software engineers on how to automate, integrate
and extend Altium products along with public documentation and examples

Access Altium Developer Center

Technical Documentation Stock Locator Tool The Stock Locator Tool is a React component that displays real-time pricing and availability for a given manufacturer part number – stock levels, price breaks, and distributor links – powered by the Octopart API. Embed it in product pages, procurement tools, or any React application. Prerequisites A React project An OAuth 2.0 access token with the supply.domain scope – the same token used for…

Technical Documentation Example Queries Change Your Region Many of our distributor partners provide different inventory levels depending on the user's country. The API defaults to US and USD for country and currency but these can be overridden to get results more suitable to your region. Compare the query for Great Britain: query GBMatch { supMultiMatch( country: "GB" currency: "GBP" queries: [{ mpn: "AR 32 HZL-TT", limit: 3 }] ) {…

Technical Documentation Pagination The Octopart API uses limit/offset pagination. There are no cursors – you control the window into results with two parameters: limit and start. Parameters Parameter Default Maximum Description limit 10 100 Number of results to return start 0 1000 Zero-based offset into the result set How it Works start is an item offset, not a page number. To retrieve a specific page, multiply the page index by…

Technical Documentation Inventory API Inventory vs octopart.com Inventory data returned by the API may differ from what you see on octopart.com. There are two reasons for this: Data freshness – The API returns inventory from regularly ingested distributor data feeds. octopart.com uses live distributor data for some distributors, which can reflect more recent stock changes. Country defaulting – octopart.com detects the user's…

Technical Documentation Search The Octopart API provides three queries for finding parts. Choosing the right one depends on what you know about the part you're looking for. Query Use when... supMultiMatch You have one or more exact MPNs or SKUs and want a precise match for each supSearchMpn You have a single MPN and want ranked MPN-match results supSearch You're searching by keyword, description, or partial part number MPN…

Technical Documentation Authorization The Octopart API uses OAuth 2.0 with the client_credentials grant – a machine-to-machine flow that does not require a user to log in. Your application exchanges a Client ID and Client Secret for a short-lived access token, then includes that token in every API request. Getting Your Credentials Credentials are managed in the developer portal: Sign in to portal.nexar.com. Open your application (or…

Technical Documentation Plans & Subscriptions Please refer to the following sections for details: Subscribing to a Self-Serve Plan Invoices & Billing Managing My Supply Subscription Parts Checking Supply Part Limits & Usage Upgrading or Downgrading Your Plan Getting Free Parts in the API Plan Add-On Specific Data Fields

Technical Documentation Octopart API The Octopart API is a GraphQL API for electronic component supply chain data. It gives you programmatic access to the Octopart database – parts, pricing, inventory levels, distributor offers, factory lead times, and more – across millions of components from thousands of manufacturers and distributors worldwide. New to the Octopart API? Start with the Octopart API Quick Start Guide to get…

Technical Documentation Octopart Octopart.com is the world's largest search engine for electronic components. It aggregates data from thousands of manufacturers and distributors – part specifications, pricing, inventory levels, datasheets, and distributor offers – into a single, continuously updated database covering hundreds of millions of components. For developers, Octopart exposes this data through two integration paths: a…

Technical Documentation Altium Designer Scripting Altium Designer developer documentation is currently being migrated to our new documentation platform. In the meantime, you can access the existing Altium Designer SDK and scripting documentation here: Altium Designer SDK and Scripting Documentation