API Documentation

Get all attributes

Get manufacturer companies

list of company IDs. Omit to fetch all manufacturers.

list of URL slugs for /manufacturers paths

Get seller companies (distributors)

list of company IDs. Omit to fetch all sellers.

list of URL slugs for /distributors paths

Get categories

list of category IDs. Omit to fetch all categories.

list of /electronic-parts SEO page paths for categories.

Get parts by ID.

list of part IDs. APIv3 UIDs are also supported.

user's country

user's currency

fetch latest pricing and stock data from distributor API. Company.is_distributorapi indicates if a distributor supports this feature.

how long to wait for distributor API to respond as a duration string (e.g. 3s or 500ms)

if needed, pass along credentials for API integrations

Attempt to complete a partial query string. Used for autosuggest / typeahead text inputs.

partial query string

category_id to scope suggestions to

only return part number suggestions

Search parts, including filters, pagination, aggregation, sorting

the query to search

user's country

user's currency

offset in the result set

page size of results

field to sort by. See sort values

direction of sort: asc or desc

filter to remove parts with no stocking distributors

a key: value map of filters. See filter values

fetch latest pricing and stock data from distributor API. Company.is_distributorapi indicates if a distributor supports this feature.

how long to wait for distributor API to respond as a duration string (e.g. 3s or 500ms)

if needed, pass along credentials for API integrations

Search parts by mpn only, including filters, pagination, aggregation, sorting

the query to search on mpn

user's country

user's currency

offset in the result set

page size of results

field to sort by. See sort values

direction of sort: asc or desc

filter to remove parts with no stocking distributors

a key: value map of filters. See filter values

fetch latest pricing and stock data from distributor API. Company.is_distributorapi indicates if a distributor supports this feature.

how long to wait for distributor API to respond as a duration string (e.g. 3s or 500ms)

if needed, pass along credentials for API integrations

Suggest an alternate q when no results are found

query string to correct

Match multiple manufacturer + mpn pairs at once. Useful for when you have a list of parts, as with a BOM (Bill of Materials)

list of inputs to attempt to match

options when matching such as applying filters or only including authorized or in-stock parts

user's country

user's currency

fetch latest pricing and stock data from distributor API. Company.is_distributorapi indicates if a distributor supports this feature.

how long to wait for distributor API to respond as a duration string (e.g. 3s or 500ms)

if needed, pass along credentials for API integrations

shortname is the key in the filters Map. Usually an attribute shortname, or manufacturer_id, distributor_id, etc.

human readable name to display in the UI

values in the filter Map.

human readable values to display in the UI

Internal Octopart ID

display name

use as key for sort or filter in part search

use to group together similar attributes, e.g. Technical, Physical, Compliance

The type of the value

The short name of the units

The symbol of the units

Name of group, e.g. Technical, Physical, Compliance

Attributes in group

Category name.

Path to /electronic-parts Category page.

Short description of Category.

Longer description of Category.

Description used in webpage metadata - SEO optimised

Title used in webpage metadata - SEO optimised

Octopart internal id. Root id is 4161

ID of parent category.

Display name

List of all ancestor in category tree.

List of direct children in category tree.

Slash separated path. Can be used to visit URL for category page. (e.g. /electronic-parts/circuit-protection/esd-and-circuit-protection-ics)

List of Attributes deemed to be relevant to this category. (e.g. Resistance for Resistor category). Useful for showing contextual filters in UI.

Blurb for Category, used on /electronic-parts pages.

Number of parts in Category.

Octopart internal id

Display name of company

Aliases of company

The country code for the display flag

Homepage URL of company

Used for URLs like /manufacturers/aimtec or /distributors/digi-key

True if a manufacturer participates in Octopart's Verified Manufacturer program. See verified for more information.

True if a distributor is a broker. See authorized for more information.

⚠️ DEPRECATED

use PartSeller.is_broker instead

True if a distributor has an API integration with Octopart to provide latest pricing and stock data.

True if Octocart is supported for this distributor

Description text

Source of description. Used for attribution.

Source URL of description. Used for attribution.

Name of group, e.g. Datasheets

List of Documents in group

⚠️ DEPRECATED

use url instead

⚠️ DEPRECATED

use url instead

⚠️ DEPRECATED

use url instead

⚠️ DEPRECATED

use url instead

Image URL

Source of description. Used for attribution.

Source URL of description. Used for attribution.

Cache ID

Octopart internal ID for this offer

Stock Keeping Unit used by internally by distributor

The code indicating the region(s) for which offer is valid

Number of units available to be shipped. (aka Stock, Quantity)

Packaging of parts (eg Tape, Reel)

Minimum Order Quantity: smallest number of parts that can be purchased

The price points of the offer, sorted by minimum order quantity

The URL to view offer on distributor website. This will redirect via Octopart's server.

Octopart internal URL for this offer.

The last time data was received from distributor feed or API for this offer.

Number of days to acquire parts from factory.

Number of parts on order from factory.

Order multiple for factory orders.

Number of items which must be ordered together.

The quantity of parts as packaged by the seller.

Whether this offer is specific to the customer making the request.

Cache ID

Octopart internal ID for this part. Appears at the end of PDP URL / slug field.

manufacturer + mpn for easy display

Manufacturer Part Number

Best guess at a generic MPN

Company that manufactures this part

A link to the manufacturer detail page for this part or series.

A link to a manufacturer page to request free sample kits for this part.

Documents including Datasheets, Compliance Documents, PCNs

Best description around 110 characters long, as can be seen on SERP or PDP. May need truncation if all descriptions are long.

All part descriptions from sources

All part images

Attribute values for this part

Path component of PDP URL (e.g. /ad7792bruz-analog+devices-402798)

A link to the part page on Octopart. Do not include rel="nofollow" when linking to this URL.

Parts identified by Octopart to be similar in specs and functionality.

Parts identified by the manufacturer as companion products.

Data about part's CAD model. If null cad_request_url can be used to request a CAD model be made.

URL to request a CAD model from eeconcierge if a part doesn't already have a CAD model. Will be null part is not eligible, e.g. a multimeter

The UID from Octopart APIv3. Provided for backwards compatibility, in general ID should be used.

A Map of number of related objects. Can be used to know the number of images or descriptions without having to request those related objects.

The median USD price at quantity 1,000, discarding outliers. A reasonable estimate of average price for a part.

Sum of stock available across all distributors

The average stock level at each distributor

Companies with Offers for this part

The estimated factory lead time in days derived from trusted distributor offers.

This part might be known by these alternate MPNs

URL to add this part to your Upverter library. Requires an Upverter account.

If true, a STEP model will be included with the tool-specific downloads.

Will match reference supplied in PartMatchQuery.

Number of parts matched

Matched parts (may be subset, based on start + limit)

Possible error message

Cache ID

The part object

⚠️ DEPRECATED

always empty

If the search q is an alternate MPN for this part, the aka_mpn will be populated with this alternate MPN.

Description with query terms highlighted. Often this is the same as part.short_description, but if the search q matched on a different description it may be longer than part.short_description and require truncation.

⚠️ DEPRECATED

use hits instead

Number of parts in result set

Contains nested part along side some fields specific to the query that explain reason for match.

Grouped attributes used to render the columns in specs view.

If an invalid query was modified or rejected, warnings indicate this fact to the user. For example if query contained too many tokens, some tokens may be ignored.

Perform aggregations on Spec values across multiple Attributes. You must specify attribute_names for this field to be populated. attribute_names should be a list of Attribute.shortname values (e.g. capacitance or voltage_rating_dc)

a list of Attribute.shortname values to aggregate on (e.g. capacitance or voltage_rating_dc)

number of spec value buckets to return (default 10)

Aggregate on manufacturers for this result set

number of buckets to return (default 10)

Aggregate on distributors for this result set

number of buckets to return (default 10)

Aggregate on categories for this result set

number of buckets to return (default 10)

Aggregate on the availability of CAD models for the result set

Categories that are determined by search algo to be related to the search term. Useful for suggesting a Category filter in the search UI.

Attributes that are determined by search algo to be related to the search term. Useful for suggesting most relevant filters in the search UI.

Full list of available Attributes in the result set

If a Category filter is applied, this will be the Category

If filters are applied, this will contain display information

Cache ID

The distributor

Distributor's country

List of offers. Multiple offers may exist in different packaging. While multiple geo-targeted offers may exist, currently the API only exposes one geo-targeted offer at a time based on country parameter. Please contact us if you have a need to see all geo-targeted offer variants.

True if the distributor is an authorized distributor for this manufacturer. See authorized for more information.

True if the distributor is a Non-Authorized Dealer. See authorized for more information.

True if you can request a quote from this seller.

List of countries the seller ships to. An empty list represents zero shipping restrictions.

Octopart internal ID for this series

Name of the part series

Octopart URL for this series, specific to the parent part

Cache ID

Minimum purchase quantity to get this price (aka price break)

Price in currency

Currency for price

Price converted to user's currency using foreign exchange rates.

Since this is an estimate, an indicator should be shown to user if currency != converted_currency.

Currency for converted_price. Will match value of currency argument.

The exchange rate used to calculate converted_price

The actual value

The value of the spec in SI base units

The type of the value

The units of the value

The short name of the units

The symbol of the units

The formatted display value

min is the lowest spec value in this result set for numerical attributes

max is the greatest spec value in this result set for numerical attributes

The min value in SI base units

The max value in SI base units

display_min is the formatted string of min

display_max is the formatted string of max

The type of the value

The units of the spec

The short name of the units

The symbol of the units

display_value is the string value. For numerical attributes it is the formatted version of float_value

float_value is populated if the attribute is numeric

count will be null if aggregation timed out

Cache ID

⚠️ DEPRECATED

use part.id instead

⚠️ DEPRECATED

unused

Related part

URL to visit for related part

Suggested text of longer query

If the suggestion should also apply a category_id filter, this is the category name

If the suggestion should also apply a category_id filter, this is the Category ID

The name of the API that you are providing credentials for. An Octopart representative will give this value to you if needed.

Authentication details. client_id and client_secret should be given together when an API requires them.

Authentication details. client_id and client_secret should be given together when an API requires them.

Authentication details. username and password should be given together when an API requires them.

Authentication details. username and password should be given together when an API requires them.

Authentication details. api_key should be given when an API requires it.

If true, only parts with at least one authorized seller will be returned.

If true, only parts with stock available will be returned.

a key: value map of filters. See filter values