Piloterr Digikey API
The Digikey API from Piloterr — 2 operation(s) for digikey.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-digikey-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Piloterr API Reference Digikey API
description: Complete API reference documentation.
version: 1.0.0
servers:
- url: https://api.piloterr.com
description: API Server
tags:
- name: Digikey
paths:
/v2/digikey/product:
get:
summary: DigiKey Product
description: 'Get a DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet and specs via browser rendering.
**Credit cost:** 2 credits per call'
operationId: get-digikey-product
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: 'Full DigiKey product detail URL, or relative path.
**Examples:**
```
https://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293
```
```
/fr/products/detail/excel-blades/50500/24758728
```
Relative paths require `region`.'
schema:
type: string
description: 'Full DigiKey product detail URL, or relative path.
**Examples:**
```
https://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293
```
```
/fr/products/detail/excel-blades/50500/24758728
```
Relative paths require `region`.'
- name: region
in: query
required: false
description: 'DigiKey country TLD when `query` is a relative path.
**Examples:** `fr`, `com`, `de`, `co.uk`'
schema:
type: string
description: 'DigiKey country TLD when `query` is a relative path.
**Examples:** `fr`, `com`, `de`, `co.uk`'
- name: return_page_source
in: query
required: false
description: 'When `true`, return rendered HTML as `{"result": "..."}` instead of JSON. Defaults to `false`.'
schema:
type: boolean
description: 'When `true`, return rendered HTML as `{"result": "..."}` instead of JSON. Defaults to `false`.'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
url:
type: string
price:
type: number
stock:
type: string
title:
type: string
images:
type: array
items:
type: string
locale:
type: string
region:
type: string
pricing:
type: array
items:
type: object
properties:
packaging:
type: string
unit_price:
type: number
break_quantity:
type: integer
extended_price:
type: number
digikey_part_number:
type: string
currency:
type: string
description:
type: string
manufacturer:
type: string
datasheet_url:
type: string
is_unavailable:
type: boolean
specifications:
type: object
properties:
Fabricant:
type: string
Conditionnement:
type: string
Type d'accessoire:
type: string
Statut du composant:
type: string
digikey_part_number:
type: string
detailed_description:
type: string
manufacturer_part_number:
type: string
examples:
Phoenix Contact 2981965 (FR):
value:
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'
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Digikey
post:
summary: DigiKey Product
description: 'Get a DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet and specs via browser rendering.
**Credit cost:** 2 credits per call'
operationId: post-digikey-product
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: 'Full DigiKey product detail URL, or relative path.
**Examples:**
```
https://www.digikey.fr/fr/products/detail/phoenix-contact/2981965/3604293
```
```
/fr/products/detail/excel-blades/50500/24758728
```
Relative paths require `region`.'
region:
type: string
description: 'DigiKey country TLD when `query` is a relative path.
**Examples:** `fr`, `com`, `de`, `co.uk`'
return_page_source:
type: boolean
description: 'When `true`, return rendered HTML as `{"result": "..."}` instead of JSON. Defaults to `false`.'
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
url:
type: string
price:
type: number
stock:
type: string
title:
type: string
images:
type: array
items:
type: string
locale:
type: string
region:
type: string
pricing:
type: array
items:
type: object
properties:
packaging:
type: string
unit_price:
type: number
break_quantity:
type: integer
extended_price:
type: number
digikey_part_number:
type: string
currency:
type: string
description:
type: string
manufacturer:
type: string
datasheet_url:
type: string
is_unavailable:
type: boolean
specifications:
type: object
properties:
Fabricant:
type: string
Conditionnement:
type: string
Type d'accessoire:
type: string
Statut du composant:
type: string
digikey_part_number:
type: string
detailed_description:
type: string
manufacturer_part_number:
type: string
examples:
Phoenix Contact 2981965 (FR):
value:
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'
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Digikey
/v2/digikey/search:
get:
summary: DigiKey Search
description: 'Search DigiKey country sites by keyword or result/filter URL. Returns category branches or product listings with pagination via browser rendering.
**Credit cost:** 2 credits per call'
operationId: get-digikey-search
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: 'Keyword, DigiKey result/filter URL, or relative path.
**Examples:**
```
phoenix contact
```
```
https://www.digikey.fr/fr/products/result?keywords=phoenix+contact
```
```
https://www.digikey.fr/fr/products/filter/marteaux/246
```
```
/fr/products/filter/marteaux/246
```
A full DigiKey URL auto-detects `region`.'
schema:
type: string
description: 'Keyword, DigiKey result/filter URL, or relative path.
**Examples:**
```
phoenix contact
```
```
https://www.digikey.fr/fr/products/result?keywords=phoenix+contact
```
```
https://www.digikey.fr/fr/products/filter/marteaux/246
```
```
/fr/products/filter/marteaux/246
```
A full DigiKey URL auto-detects `region`.'
- name: region
in: query
required: false
description: 'DigiKey country TLD when `query` is not a full URL.
**Examples:** `fr`, `com`, `de`, `co.uk`, `com.au`, `ca`, `jp`
Aliases: `uk`/`gb` → `co.uk`, `au` → `com.au`.'
schema:
type: string
description: 'DigiKey country TLD when `query` is not a full URL.
**Examples:** `fr`, `com`, `de`, `co.uk`, `com.au`, `ca`, `jp`
Aliases: `uk`/`gb` → `co.uk`, `au` → `com.au`.'
- name: return_page_source
in: query
required: false
description: 'When `true`, return rendered HTML as `{"result": "..."}` instead of JSON. Defaults to `false`.'
schema:
type: boolean
description: 'When `true`, return rendered HTML as `{"result": "..."}` instead of JSON. Defaults to `false`.'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: string
url:
type: string
type:
type: string
title:
type: string
image_url:
type: string
product_count:
type: integer
parent_category:
type: string
pagination:
type: object
properties:
page:
type: integer
per_page:
type: integer
total_pages:
type: integer
has_next_page:
type: boolean
total_results:
type: integer
examples:
Keyword phoenix contact (FR categories):
value:
results:
- id: '370'
url: https://www.digikey.fr/fr/products/filter/embases-fiches-et-prises/370
type: category
title: Embases, fiches et prises
image_url: https://mm.digikey.com/Volume0/opasdata/d220001/derivates/3/010/141/386/1751086_tmb.jpg
product_count: 13796
parent_category: Blocs de jonction
pagination:
page: 1
per_page: 30
total_pages: 1
has_next_page: false
total_results: 65793
Filter listing marteaux (products):
value:
results:
- url: https://www.digikey.fr/fr/products/detail/excel-blades/55672/24758809
type: product
price: 44.32
stock: '1000'
title: 9" Swiss Style Mini Hammer
currency: EUR
product_id: '24758809'
stock_label: Marketplace
manufacturer: Excel Blades
digikey_part_number: 5795-55672-ND
manufacturer_part_number: '55672'
pagination:
next: 2
page: 1
per_page: 25
total_pages: 20
has_next_page: true
total_results: 491
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Digikey
post:
summary: DigiKey Search
description: 'Search DigiKey country sites by keyword or result/filter URL. Returns category branches or product listings with pagination via browser rendering.
**Credit cost:** 2 credits per call'
operationId: post-digikey-search
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: 'Keyword, DigiKey result/filter URL, or relative path.
**Examples:**
```
phoenix contact
```
```
https://www.digikey.fr/fr/products/result?keywords=phoenix+contact
```
```
https://www.digikey.fr/fr/products/filter/marteaux/246
```
```
/fr/products/filter/marteaux/246
```
A full DigiKey URL auto-detects `region`.'
region:
type: string
description: 'DigiKey country TLD when `query` is not a full URL.
**Examples:** `fr`, `com`, `de`, `co.uk`, `com.au`, `ca`, `jp`
Aliases: `uk`/`gb` → `co.uk`, `au` → `com.au`.'
return_page_source:
type: boolean
description: 'When `true`, return rendered HTML as `{"result": "..."}` instead of JSON. Defaults to `false`.'
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: string
url:
type: string
type:
type: string
title:
type: string
image_url:
type: string
product_count:
type: integer
parent_category:
type: string
pagination:
type: object
properties:
page:
type: integer
per_page:
type: integer
total_pages:
type: integer
has_next_page:
type: boolean
total_results:
type: integer
examples:
Keyword phoenix contact (FR categories):
value:
results:
- id: '370'
url: https://www.digikey.fr/fr/products/filter/embases-fiches-et-prises/370
type: category
title: Embases, fiches et prises
image_url: https://mm.digikey.com/Volume0/opasdata/d220001/derivates/3/010/141/386/1751086_tmb.jpg
product_count: 13796
parent_category: Blocs de jonction
pagination:
page: 1
per_page: 30
total_pages: 1
has_next_page: false
total_results: 65793
Filter listing marteaux (products):
value:
results:
- url: https://www.digikey.fr/fr/products/detail/excel-blades/55672/24758809
type: product
price: 44.32
stock: '1000'
title: 9" Swiss Style Mini Hammer
currency: EUR
product_id: '24758809'
stock_label: Marketplace
manufacturer: Excel Blades
digikey_part_number: 5795-55672-ND
manufacturer_part_number: '55672'
pagination:
next: 2
page: 1
per_page: 25
total_pages: 20
has_next_page: true
total_results: 491
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Digikey
components:
parameters:
fields:
name: fields
in: query
required: false
description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
schema:
type: string
is_async:
name: is_async
in: query
required: false
description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
schema:
type: boolean
default: false
soft_fail:
name: soft_fail
in: query
required: false
description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
schema:
type: boolean
default: false
schemas:
ErrorResponse:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable error message.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Your API key. Include it in the x-api-key header for every request.