canonical: https://jentic.com/apis/digikey.com/digikey

# Digi-Key Product Information API

The Digi-Key Product Information API gives programmatic access to Digi-Key's catalogue of millions of electronic components - keyword search, part-number lookup, product details, and category browsing. It supports both 2-legged client-credentials and 3-legged authorization-code OAuth 2.0 flows, and exposes a sandbox base URL alongside production. Engineering teams use it to embed Digi-Key data into design tools, BOM managers, and procurement systems.

## For AI agents

Search Digi-Key's electronic component catalogue, look up parts by manufacturer or Digi-Key number, and browse product categories through OAuth 2.0 authenticated endpoints.

## Scope

Does not handle order placement, account management, or shipping - use for Digi-Key product search and detail lookups only.

## Capabilities

- Search the Digi-Key catalogue by keyword and filter by parametric attributes
- Look up part details by Digi-Key part number or manufacturer part number
- Browse the product category tree to navigate available components
- Retrieve detailed product specifications, datasheets, and pricing for a part
- Authenticate via 2-legged client credentials or 3-legged authorization code flow

## Use cases

### BOM Cost and Availability Lookup

Resolve a bill of materials against Digi-Key by looking up each manufacturer part number and pulling current price, stock, and lead time. The `/products/v4/search/manufacturerproductnumber` endpoint accepts a manufacturer part and returns matching Digi-Key parts with their pricing tiers, so a procurement tool can rebuild costed BOMs daily without scraping the website.

Example prompt: For each row in the BOM CSV, call `/products/v4/search/manufacturerproductnumber` with the manufacturer part number and record the Digi-Key part, unit price, and stock

### Component Search Inside Design Tools

Embed component search into an EDA tool or part picker so engineers can find resistors, capacitors, and ICs without leaving the design environment. The `/products/v4/search/keyword` endpoint accepts a keyword and parametric filters such as resistance value or package, returning matching parts with their Digi-Key part numbers ready to drop into a schematic.

Example prompt: When the engineer searches "10k 0603 1% resistor", call `/products/v4/search/keyword` with the query and filters and return the top 20 results sorted by stock

### Datasheet and Spec Retrieval

Pull canonical datasheets and detailed parametric specifications for a part by Digi-Key number. The `/products/v4/search/{partNumber}/productdetails` endpoint returns the full product detail block including datasheet URLs, RoHS status, lifecycle status, and quantity-break pricing - useful for compliance and engineering review systems.

Example prompt: Given Digi-Key part 296-1234-1-ND, fetch product details and store the datasheet URL, lifecycle status, and quantity-break pricing in the engineering database

### AI Agent Procurement Assistant

An AI procurement assistant can take a partial part description, search Digi-Key, evaluate alternatives by stock and price, and propose substitutions. Through Jentic the agent searches for "search Digi-Key by keyword", loads the input schema, and executes - without learning OAuth flows or reading the Digi-Key spec.

Example prompt: When a BOM line is out of stock, call `/products/v4/search/keyword` with the parametric profile of the original part and propose three in-stock alternatives sorted by unit price

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/oauth2/token` | Exchange a code or client credentials for an access token |
| GET | `/products/v4/search/{partNumber}/productdetails` | Retrieve product details by Digi-Key part number |
| GET | `/products/v4/search/keyword` | Search the catalogue by keyword and filters |
| GET | `/products/v4/search/digikeynumber/{digiKeyPartNumber}` | Look up a part by Digi-Key number |
| GET | `/products/v4/search/manufacturerproductnumber` | Look up parts by manufacturer part number |
| GET | `/products/v4/categories` | Browse the product category tree |

## Key resources

- **Product Search** — Search the catalogue by keyword, manufacturer part number, or Digi-Key part number
- **Product Details** — Retrieve detailed parametric data, datasheets, and pricing for a part
- **Categories** — Browse the Digi-Key product category tree
- **OAuth** — Authorize and exchange tokens via 2-legged or 3-legged OAuth 2.0 flows

## Why Jentic

- **Setup:** Wiring Digi-Key by hand means implementing its OAuth 2.0 client-credentials flow, refreshing tokens, and choosing the production or sandbox host yourself. Through Jentic you install once, import the Digi-Key Product Information API from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** Digi-Key product search is read-only, so scope your agent to the lookup operations it needs, such as keyword search or fetching product details by part number. You choose the operations it may call, so category browsing is not included unless you add it.
- **Credential handling:** Your Digi-Key OAuth client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'look up an electronic component' or 'find a part by manufacturer number', and Jentic returns the matching Digi-Key operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Octopart API** — Multi-distributor component search aggregating Digi-Key, Mouser, and others
- **Shopify Admin API** — E-commerce backend that consumes Digi-Key pricing for resold electronic kits
- **Stripe API** — Payment side of a procurement workflow built on Digi-Key prices

## FAQ

### What authentication does the Digi-Key Product Information API use?

Digi-Key uses OAuth 2.0 with both 2-legged client-credentials and 3-legged authorization-code flows. Tokens are obtained from `/v1/oauth2/token.` Through Jentic the client id, secret, and refresh token live in the encrypted vault, so the agent never handles them directly.

### Can I look up a part by manufacturer part number rather than Digi-Key number?

Yes. GET `/products/v4/search/manufacturerproductnumber` accepts a manufacturer part number and returns matching Digi-Key listings with pricing and stock. This is the primary endpoint for BOM resolution.

### What are the rate limits for the Digi-Key Product Information API?

Digi-Key applies per-application rate limits assigned at registration in the Digi-Key Developer Portal. Sandbox keys have lower limits than production keys, and the current ceiling is reported in response headers when throttling occurs.

### How do I run a keyword search through Jentic?

Run a Jentic search for "search Digi-Key by keyword". Jentic returns GET `/products/v4/search/keyword` with its input schema (keyword query plus filter parameters). Load the schema, populate the fields, and execute.

### Does the API expose datasheets and lifecycle status?

Yes. GET `/products/v4/search/{partNumber}/productdetails` returns datasheet URLs, lifecycle status, RoHS status, and quantity-break pricing alongside the parametric data block.

### How do I install the Jentic SDK to call Digi-Key?

Run pip install jentic, set JENTIC_AGENT_API_KEY to your ak_* key, then use Jentic with SearchRequest, LoadRequest, and ExecutionRequest. Get started with Jentic One, the self-hosted execution layer.

### Can I limit what my agent is allowed to do with the Digi-Key Product Information API?

Yes. Because you run Jentic One yourself, your own rules decide which Digi-Key operations and credentials the agent may use, so you can grant only the read-only lookups it needs, such as keyword search at `/products/v4/search/keyword` or product details at `/products/v4/search/{partNumber}/productdetails.` You choose the operations it may call, so category browsing at `/products/v4/categories` is not available to the agent unless you add it. Your Digi-Key OAuth client credentials are injected at execution time and never enter the agent's prompt or logs.