The call
mpn is the only required parameter. country is optional: see Buying near you.
The first request for a part can take tens of seconds; later ones answer quickly. Set your client
timeout to 90 seconds.
What comes back
notice, risk.why_at_risk, risk.drivers_detail, disruption_events and
recommended_actions are omitted, and distributors, nearby.distributors and alternates are cut to their first entry.
Every field is listed in
the reference.
Reading it without parsing it
summary is one sentence covering the score, the drivers flagged medium or above and the stock position, taken
from the same supply figures returned in this response. If you are relaying to a person or a
model, that line is enough on its own.
The risk score
risk.composite combines the four drivers under risk.drivers, and risk.tier is the band it
falls in: low, medium, high or critical.
Each is a band (
tier: low, medium, high or critical) and an interpretation, one sentence
about this part, not a generic description of the driver. Drivers carry no number; the composite
does. tier is null when there is no data for a driver, and the sentence says why.
A part in a BOM can score differently: see BOM analysis.
Disruption events
disruption_events lists the reported events and shipping conditions that most affect
disruption_exposure, strongest first: ordered by effect on this part’s score, not by severity.
severity is how serious the event or slowdown is in itself, not its effect on this part. Each item
has a kind:
For
port_activity and sea_route, id and url are null, and published_date is the last day
of the week the figure covers. The list is empty when nothing affects the score noticeably.
Supply
stock and the lead times can be more recent than as_of. distributor_count is the number of distributors holding stock of this part.
distributors lists those holding the most, largest first, and is not exhaustive.
lead_time_min and lead_time_max are the 25th and 75th percentiles of the quoted lead times:
the middle half of quotes. They come back null with a reason when that middle half is a single
figure: there is no range to report.
Buying near you
Send the buyer’s country as a two-letter ISO 3166-1 code,country=SG, and supply.nearby lists
the distributors holding stock in that country first, then elsewhere in its region, with a
summary sentence you can relay as it is:
nearby.distributors carries proximity: same_country or same_region. Every
distributor, here and in supply.distributors, also carries regions and subregion, the parts of
the world its listing serves, following the UN geographic regions: a storefront that states a
wider area than one country, such as Europe, Middle East and Africa, lists each region it covers,
and subregion is null when no country is known. These are not the region values of the
events feed; to find events affecting a distributor, filter events by its country_code. The
nearby list is empty, and the sentence says so, when nobody near the buyer holds stock. The risk score and
every other field are the same with or without country; without it, nearby is null. A value
that is not a country code answers 400.
Alternates
alternates lists up to five parts that could replace this one: the same list, in the same shape,
as Find alternate parts. Each carries how a supplier catalogue classifies it
(match), its lifecycle and what distributors hold now. The same part in another package or
ordering variant is never an alternate, the list is not ranked, and it can be empty. Confirm fit
against the datasheets before substituting.
Datasheet
datasheet.url links to this part number’s datasheet: a PDF where one is published, otherwise a
page carrying it. It may be hosted by a distributor rather than the manufacturer. null when no
datasheet was found.
When the part number is not right
Three refusals, and none of them returns a report.The input is not a specific part: 422
No supplier lists that part number: 404
did_you_mean carries real part numbers on both refusals: parts of the kind you described on a
422, and the listed part numbers your input is a prefix of on a 404. TPS5433 is not an
orderable part; TPS54331 and TPS54332 are.
We could not check: 503
404. Here
the part could not be checked.
Parts several manufacturers make
Some part numbers are made by more than one company.NE555N is listed by
STMicroelectronics, Philips, Signetics and others.
notes is always present and empty when there is nothing to note.
Freshness
as_of is when the report was produced, up to 48 hours before your call. Read as_of rather than
assuming the report was produced for your call.
Supply figures are at most 24 hours old.
Responses carry Cache-Control: no-store; what that means and what you may store is in Freshness.
Conventions
How scores, units and nulls work across every response.
Errors
Every status code and what to do about it.