APIs for Altium

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

Access Altium Developer Center

Technical Documentation

Explore Technical Documentation related to 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…