Skip to main content
The PartFinder REST API gives you programmatic access to composite risk scores, supply availability data, datasheet links, live disruption events, alternate part recommendations, part search and side-by-side part comparison for industrial components. All endpoints are served from https://api.partfinder.dev, versioned under the /v1/ prefix, and communicate exclusively in JSON.

​
Base URL

All endpoints are prefixed with /v1/:

​
OpenAPI Document

A machine-readable OpenAPI 3.1 document is available at:
Use it to generate client SDKs, validate requests in your CI pipeline, or import the collection directly into tools like Postman or Insomnia.

​
Authentication

Every request must include a valid API key as a Bearer token in the Authorization header:
Keys belong to your organization, not to a team member, and keep working when team members change. You create, rotate and revoke keys at console.partfinder.dev. Revocation takes effect within approximately one minute. For full details, see the Authentication page.

​
Request and Response Format

Requests and responses use application/json, except POST /v1/bom/upload, which takes the file as multipart/form-data. Include Content-Type: application/json on every other POST. All timestamps are ISO 8601 UTC strings.

​
Endpoint Summary

The machine-readable description of every endpoint is the OpenAPI document.

​
Common Headers

​
string
required
Your API key as a Bearer token. Example: Bearer ak_7f3a2b1c.... All requests require this header. Missing or invalid keys return 401.
​
string
application/json on every POST except the file upload; multipart/form-data on POST /v1/bom/upload.

​
Response Envelope

Every successful response from the PartFinder API shares the following top-level fields. Errors have their own shape: an error code, usually a summary you can relay, and where useful a reason and did_you_mean (see Errors).
​
string
ISO 8601 UTC timestamp of when the data in this response was produced. It can be earlier than your call.
​
string
Informational-use disclaimer. Always present. Example: "Informational only. Risk scores, stock levels, lead times and alternate-part suggestions may be incomplete, delayed or inaccurate. Independently verify before making procurement, engineering, compliance, safety or sourcing decisions."
​
string
A plain-language summary of the response, which an agent or UI can relay directly rather than re-deriving it from the fields.

​
Score Fields

Every score object in the API follows a consistent structure so you can handle scores generically without endpoint-specific parsing logic:

​
Unknown Values

When a data point cannot be determined, the API returns an explicit null with a reason field saying why, for example "reason": "No distributor quotes a lead time for this line.". Fields are never omitted.

​
Versioning

The current API version is v1. Breaking changes (removed fields, changed meanings, incompatible schema changes) are released under a new version prefix (e.g. /v2/). Non-breaking additions such as new response fields may be added at any time within the same version. Write your clients defensively: ignore unknown fields rather than treating them as errors.