digikey-api 0.1.1

Python client for Digikey API

Python Client for Digikey PartSearch API v2

Search for parts in the Digi-Key catalog by keyword using KeywordSearch. Then make a PartDetails call to retrieve all real time information about the part including pricing. PartDetails works best with Digi-Key part numbers as some manufacturers overlap other manufacturer part numbers.

What does it do

digkey-api is an Digkey Part Search API client for Python 3.6+. API response data is returned as Python objects that attempt to make it easy to get the data you want. Not all endpoints have been implemented.

Quickstart

Register

Register an app on the Digikey API portal: Digi-Key API. You will need the client ID and the client secret to use the API. You will also need a Digi-Key account to authenticate, using the Oauth2 process.

Install

pip install digikey-api

export DIGIKEY_CLIENT_ID="client_id"
export DIGIKEY_CLIENT_SECRET="client_secret"
export DIGIKEY_STORAGE_PATH="cache_dir"

Use

Python will automatically spawn a browser to allow you to authenticate using the Oauth2 process. After obtaining a token the library will cache the access token and use the refresh token to automatically refresh your credentials.

import digikey

os.environ['DIGIKEY_CLIENT_ID'] = client_id
os.environ['DIGIKEY_CLIENT_SECRET'] = client_secret
os.environ['DIGIKEY_STORAGE_PATH'] = cache_dir

dkpn = '296-6501-1-ND'
part = digikey.part(dkpn)
print(part)
# <Part mpn=NE555DR>

print(part.manufacturer)
# 'Texas Instruments'

Test

python -m pytest --cov=digikey --doctest-modules --ignore=setup.py
python -m mypy digikey --ignore-missing-imports

Top-level API

• digikey.search()
• digikey.part()

Data models

• digikey.models.KeywordSearchResult
• digikey.models.Part