Python SDK

要約: ケンオール公式 Python SDK は PyPI パッケージ kenallclient として提供されています。pip install kenallclient で導入し、APIキーを渡して KenAllClient を生成すれば、郵便番号・法人番号・祝日APIを数行で呼び出せます。

インストール方法は？この見出しへのリンク

PyPI からインストールできます (Python 3 対応):

pip install kenallclient

使い方この見出しへのリンク

APIキーを渡して KenAllClient を生成し、メソッドを呼び出すだけです。

from kenallclient.client import KenAllClient
 
client = KenAllClient("YOUR_API_KEY")
 
# 郵便番号から住所を取得
result = client.get("1000001")
print(result.data[0].prefecture)  # => 東京都

get() は KenAllResult を返します。version (データ更新日) と data (住所候補のリスト) を持ち、各候補は prefecture / city / town / postal_code などのフィールドでアクセスできます。

主なメソッドこの見出しへのリンク

メソッド	用途	戻り値
`get(postal_code)`	郵便番号→住所	`KenAllResult`
`search(q=...)`	住所→郵便番号 (フリーワード・ファセット検索)	`KenAllSearchResult`
`get_houjin(corporate_number)`	法人番号→法人情報	`HoujinResult`
`search_houjin(q=..., limit=...)`	法人情報検索	`HoujinSearchResult`
`search_holiday(from_=..., to=...)`	日本の祝日	`HolidaySearchResult`

# 住所→郵便番号 (検索)
client.search(q="神奈川県 AND 日本郵便")
 
# 法人番号から法人情報を取得
houjin = client.get_houjin("2021001052596")
print(houjin.data["name"])
 
# 法人情報検索
client.search_houjin(q="name:オープンコレクター AND prefecture_name:東京都", limit=1)
 
# 日本の祝日
client.search_holiday(from_="2022-01-01", to="2022-02-01")

情報

サーバーサイドでの利用を想定しています。 APIキーはソースコードや公開リポジトリに含めず、環境変数などで安全に管理してください。ブラウザから直接呼び出す場合は JavaScript SDK と公開キーをご利用ください。

コマンドラインから使うこの見出しへのリンク

インストール後は CLI としても利用できます。

python -m kenallclient --apikey="YOUR_API_KEY" get 1008105
python -m kenallclient --apikey="YOUR_API_KEY" search -q "神奈川県 AND 日本郵便"
python -m kenallclient --apikey="YOUR_API_KEY" get-houjin 2021001052596
python -m kenallclient --apikey="YOUR_API_KEY" search-holiday --from 2022-01-01 --to 2022-02-01

SDK が対応していないAPIを使うには？この見出しへのリンク

Python SDK には郵便番号・法人番号・祝日APIに対応するメソッドが用意されています。銀行情報・学校コード・適格請求書発行事業者・営業日・自己IPアドレス確認などのAPIは、requests / httpx などのHTTPクライアントから直接呼び出してください (認証は Authorization: Token YOUR_API_KEY)。詳しくはクイックスタートや各APIリファレンスを参照してください。

import os
import requests
 
API_KEY = os.environ["KENALL_API_KEY"]
res = requests.get(
    "https://api.kenall.jp/v1/bank",
    headers={"Authorization": f"Token {API_KEY}"},
    timeout=10,
)
res.raise_for_status()
print(res.json()["data"][:1])

次に読むこの見出しへのリンク

最終更新: 2026-07-03