# DigiKey Product

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/digikey/product` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 2 credits per call |
| **Documentation** | https://www.piloterr.com/library/digikey-product |

## Description

Get a DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet and specs via browser rendering.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/digikey/product' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Phoenix Contact 2981965 (FR)

```json
{
  "url": "https://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293",
  "price": 110.05,
  "stock": "49",
  "title": "2981965",
  "images": [
    "https://mm.digikey.com/Volume0/opasdata/d220001/derivates/6/002/833/060/2981965_web%28640x640%29.jpg?hidebanner=true"
  ],
  "locale": "fr",
  "region": "fr",
  "pricing": [
    {
      "packaging": "En vrac",
      "unit_price": 110.05,
      "break_quantity": 1,
      "extended_price": 110.05,
      "digikey_part_number": "277-17389-ND"
    }
  ],
  "currency": "EUR",
  "description": "UNIVERSAL SAFETY RELAY",
  "manufacturer": "Phoenix Contact",
  "datasheet_url": "https://mm.digikey.com/Volume0/opasdata/d220001/medias/docus/692/2981965_Ds.pdf",
  "is_unavailable": false,
  "specifications": {
    "Fabricant": "Phoenix Contact",
    "Conditionnement": "En vrac",
    "Type d'accessoire": "Relais de sécurité",
    "Statut du composant": "Actif"
  },
  "digikey_part_number": "277-17389-ND",
  "detailed_description": "Relais de sécurité",
  "manufacturer_part_number": "2981965"
}
```

## Documentation

## Overview
The **DigiKey Product** endpoint returns a full DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet, breadcrumb and specifications.

Pass a product detail URL (or relative path with `region`). Browser rendering is used. Costs **2 credits** per call.

## Quickstart
```
GET https://api.piloterr.com/v2/digikey/product?query=https://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293
GET https://api.piloterr.com/v2/digikey/product?query=/fr/products/detail/excel-blades/50500/24758728&region=fr
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Full DigiKey product URL, or relative `/…/products/detail/...` path |
| `region` | string | no | Country TLD when `query` is a relative path (`fr`, `com`, …) |
| `return_page_source` | boolean | no | Return rendered HTML instead of JSON |

## Response fields
| Field | Type | Description |
|---|---|---|
| `region` / `locale` | string | Country site and language path |
| `digikey_part_number` / `manufacturer_part_number` / `manufacturer` | string | Identifiers |
| `title` / `description` / `detailed_description` | string | Product text |
| `price` / `currency` | number / string | First price break |
| `pricing` | array | Price breaks by packaging |
| `stock` | string | Available quantity |
| `url` / `datasheet_url` | string | Product and datasheet links |
| `images` | string[] | Image URLs |
| `breadcrumb` | array | Category trail |
| `specifications` | object | Technical attributes |
| `is_unavailable` | boolean | Product unavailable when true |

## Error codes
| Code | Meaning |
|---|---|
| `400` | Empty or invalid `query` |
| `404` | No usable product data |
| `500` | Rendering failed |

## Related endpoints
- [DigiKey Search](https://www.piloterr.com/library/digikey-search)