GraphQL is for Nexar migration only

Use the GraphQL API only as a drop-in replacement for Nexar's GraphQL when migrating existing integrations. For new projects and full platform capabilities, use the REST API— it's the actively maintained, modern interface.

Queries

Search queries

Arguments, warnings, and examples for supSearchMpn and supSearch, including manufacturer, category, and spec aggregations.

Search parts by manufacturer part number (supSearchMpn) or keyword (supSearch). Both accept the same arguments and return SupPartResultSet.

part_match (paid)

Arguments

Both queries share these arguments:

Parameter	Type	Required	Description
`q`	String	Optional	Search string — MPN for supSearchMpn, keyword for supSearch
`start`	Int	Optional	Offset into the result set
`limit`	Int	Optional	Page size (clamped to 1–100)
`filters`	JSON	Optional	Filter map (attribute shortname, manufacturerId, distributorId, etc.) — may surface warnings if not implemented
`country`	String	Optional	Country context (accepted for API parity)
`currency`	String	Optional	Currency context (accepted for API parity)
`sort`	String	Optional	Sort field (may warn if not implemented)
`sortDir`	SupSortDirection	Optional	ASC or DESC
`inStockOnly`	Boolean	Optional	Only parts with available stock
`hasDatasheetOnly`	Boolean	Optional	Only parts with a datasheet
`distributorApi`	Boolean	Optional	Live distributor pricing/stock where supported
`distributorApiTimeout`	String	Optional	Duration string, e.g. 3s or 500ms
`customPricingCredentials`	[SupApiCredentials]	Optional	Optional distributor API credentials
`rankingMethod`	SupSearchRankingMethod	Optional	Ranking strategy

Unimplemented or partially supported options appear as human-readable strings in the result warnings list.

MPN search

GRAPHQL

1{
2  supSearchMpn(q: "LM358", limit: 5) {
3    hits
4    warnings
5    results {
6      description
7      part {
8        mpn
9        shortDescription
10        manufacturer {
11          name
12          slug
13        }
14      }
15    }
16  }
17}

Keyword search

GRAPHQL

1{
2  supSearch(q: "5V LDO regulator", start: 0, limit: 10) {
3    hits
4    results {
5      part {
6        mpn
7        slug
8        sellers {
9          company {
10            name
11          }
12        }
13      }
14    }
15  }
16}

Aggregations

Aggregations are resolver fields on SupPartResultSet — request them in the same query as search results:

GRAPHQL

1{
2  supSearch(q: "op-amp", limit: 20) {
3    hits
4    manufacturerAgg(size: 10) {
5      count
6      company {
7        name
8      }
9    }
10    categoryAgg(size: 5) {
11      count
12      category {
13        name
14      }
15    }
16    specAggs(
17      attributeNames: ["Supply Voltage", "Package Type"]
18      specAggSize: 10
19    ) {
20      attribute {
21        name
22        shortname
23      }
24      buckets {
25        displayValue
26        count
27      }
28    }
29  }
30}

manufacturerAgg, categoryAgg, and specAggs are only available on supSearchMpn and supSearch results — not on supParts.

SupPartResultSet — full return type
Multi-match — BOM-style batch matching
Usage billing — metering for paid queries

Next Multi-match