ケンオールAPI概要
このページでは、ケンオールで提供しているAPIの概要について説明します。
使用例のシェルスクリプトは、特に注釈がない限り、bashを用いています。
API一覧
現在、ケンオールでは以下のAPIを提供しています。
郵便番号API
郵便番号と、対応する地域の住所情報を提供するAPIです。
現在、以下のAPIを提供しています。
- 郵便番号検索API: 郵便番号から住所を検索するためのAPIです。郵便番号検索APIを使うことで、メンテナンスすることなく常に最新の住所を検索することができるようになります。
- 郵便番号逆引き検索API: 住所から郵便番号を検索するとともに、住所正規化を行うAPIです。
- 郵便番号データダウンロードAPI: 郵便番号データ全体を一括でダウンロードすることができます。
- 市区町村API: 指定された都道府県内の全ての市区町村の一覧を取得するAPIです。
いずれのAPIもバージョンを指定して問い合わせを行うことができます。
法人番号API
法人番号と、対応する法人情報を提供するAPIです。
法人番号APIを使うことで、全国500万件の法人の最新住所を簡単に検索することができるようになります。
適格請求書発行事業者API
国税庁が公表している適格請求書発行事業者の情報を提供するAPIです。
適格請求書発行事業者APIを使うことで、全国500万件の適格請求書発行事業者を登録番号から検索することができるようになります。
- 適格請求書発行事業者情報取得API: 登録番号から適格請求書発行事業情報を検索するためのAPIです。
その他のAPI
- 日本の祝日API: 「国民の祝日に関する法律」に定められた祝日を取得するためのAPIです。
- 法定休日確認API: 日本の法定休日を取得するためのAPIです。
- 銀行情報API: 金融機関コードや銀行名等の情報を取得するためのAPIです。
- 自己IPアドレス確認API: アクセス元のIPアドレスを取得するためのAPIです。
郵便番号API
郵便番号検索API
与えられた郵便番号を元に、該当する郵便区画のリソースを取得します。
ケンオールの郵便番号検索APIには、以下のような特長があります。
- 町名だけでなく、小字、丁目、京都の通り名、ビル名、階層などもレコードとして整形して提供。郵便番号に対し、正確な住所を返すことが可能です。
- 個別事業所番号にも対応。大口の事業所のみがもつ特殊な郵便番号も検索可能。
- 常に最新のデータを提供。手動でのデータ更新の必要はありません。
詳細はAPIリファレンスを参照してください。
使用例
curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/postalcode/1000001"
レスポンスは以下の通りです。
{
"version": "2021-06-30",
"data": [
{
"jisx0402": "13101",
"old_code": "100",
"postal_code": "1000001",
"prefecture_kana": "トウキョウト",
"city_kana": "チヨダク",
"town_kana": "チヨダ",
"town_kana_raw": "チヨダ",
"prefecture": "東京都",
"city": "千代田区",
"town": "千代田",
"koaza": "",
"kyoto_street": "",
"building": "",
"floor": "",
"town_partial": false,
"town_addressed_koaza": false,
"town_chome": false,
"town_multi": false,
"town_raw": "千代田",
"corporation": null
}
]
}
デモ
https://kenall.jp/features/postalcode
郵便番号逆引き検索API
郵便番号逆引き検索APIは、住所から郵便番号を検索するAPIです。
検索クエリは以下の2パターンのうちどちらか一方を利用できます。
- フリーテキスト検索クエリ: 住所文字列で検索を行う、シンプルな検索クエリです。
- 構文検索クエリ: 検索用のクエリ構文を用いた複雑な検索を行います。
使用例
curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/postalcode/?t=東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8F&limit=1"
レスポンスは以下の通りです。
{
"version": "2022-01-31",
"data": [
{
"jisx0402": "13101",
"old_code": "102",
"postal_code": "1020083",
"prefecture_kana": "トウキョウト",
"city_kana": "チヨダク",
"town_kana": "コウジマチ",
"town_kana_raw": "コウジマチ",
"prefecture": "東京都",
"city": "千代田区",
"town": "麹町",
"koaza": "",
"kyoto_street": "",
"building": "",
"floor": "",
"town_partial": false,
"town_addressed_koaza": false,
"town_chome": true,
"town_multi": false,
"town_raw": "麹町",
"corporation": null
}
],
"query": {
"q": null,
"t": "東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8F",
"prefecture": "東京都",
"county": null,
"city": "千代田区",
"city_ward": null,
"town": "麹町",
"kyoto_street": null,
"block_lot_num": "3-12-14",
"building": "麹町駅前ヒルトップ",
"floor_room": "8F"
},
"count": 1280,
"offset": 0,
"limit": 1,
"facets": null
}
住所正規化機能
郵便番号逆引き検索APIを用いる際に送信する住所文字列を正規化した結果がレスポンスに含まれます。
逆引き検索自体の結果を利用せず、住所正規化のためだけにこのAPIを用いることができます。
上の例における住所文字列東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8Fを正規化した結果は以下のようになっています。
"query": {
"q": null,
"t": "東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8F",
"prefecture": "東京都",
"county": null,
"city": "千代田区",
"city_ward": null,
"town": "麹町",
"kyoto_street": null,
"block_lot_num": "3-12-14",
"building": "麹町駅前ヒルトップ",
"floor_room": "8F"
},
バッチAPI
住所正規化機能を含む郵便番号逆引き検索APIは、上記でご紹介したように単発での問い合わせの他に、複数の問い合わせを同時に処理するバッチ処理にも対応しています。
バッチ処理についてはこちらのドキュメントを参照してください。
郵便番号データダウンロードAPI
info
本APIは、エンタープライズプランご購入のお客様のみが利用できます。
郵便番号データ全体を一括でダウンロードすることができます。
データは json 形式となっていて、郵便番号検索APIと同様のフォーマットになっています。
ダウンロードしたデータはxz 形式で圧縮されています。
使用例
ダウンロードしたデータを展開して保存する場合、以下のようにcurlコマンドを実行します。
curl -L -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/download/postalcode/latest/kenall.json.xz" \
| xz -cd > kenall.json
市区町村API
郵便番号データ内に存在する都道府県・市区町村のうち、指定された都道府県内の全ての市区町村の一覧を返します。
使用例
curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/cities/13"
レスポンスは以下の通りです。
{
"version": "2021-12-28",
"data": [
{
"jisx0402": "13101",
"prefecture_code": "13",
"city_code": "101",
"prefecture_kana": "トウキョウト",
"city_kana": "チヨダク",
"prefecture": "東京都",
"city": "千代田区"
},
{
"jisx0402": "13102",
"prefecture_code": "13",
"city_code": "102",
"prefecture_kana": "トウキョウト",
"city_kana": "チュウオウク",
"prefecture": "東京都",
"city": "中央区"
},
... 中略 ...
{
"jisx0402": "13402",
"prefecture_code": "13",
"city_code": "402",
"prefecture_kana": "トウキョウト",
"city_kana": "アオガシマムラ",
"prefecture": "東京都",
"city": "青ヶ島村"
},
{
"jisx0402": "13421",
"prefecture_code": "13",
"city_code": "421",
"prefecture_kana": "トウキョウト",
"city_kana": "オガサワラムラ",
"prefecture": "東京都",
"city": "小笠原村"
}
]
}
デモ
https://codepen.io/kenall/pen/jOVjpgz
法人番号API
法人番号や法人名、住所などを元に、法人情報リソースを取得します。
法人番号検索API
指定された法人番号に対応する最新の法人情報リソースを取得します。
curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/houjinbangou/2021001052596"
レスポンスは以下の通りです。
{
"version": "2022-02-22",
"data": {
"published_date": "2022-01-31",
"sequence_number": "1409569",
"corporate_number": "2021001052596",
"process": "12",
"correct": "0",
"update_date": "2021-01-12",
"change_date": "2021-01-04",
"name": "株式会社オープンコレクター",
"name_image_id": null,
"kind": "301",
"prefecture_name": "東京都",
"city_name": "千代田区",
"street_number": "麹町３丁目１２－１４麹町駅前ヒルトップ８階",
"town": "麹町",
"kyoto_street": null,
"block_lot_num": "3-12-14",
"building": "麹町駅前ヒルトップ",
"floor_room": "8階",
"address_image_id": null,
"jisx0402": "13101",
"post_code": "1020083",
"address_outside": "",
"address_outside_image_id": null,
"close_date": null,
"close_cause": null,
"successor_corporate_number": null,
"change_cause": "",
"assignment_date": "2015-10-05",
"en_name": "",
"en_prefecture_name": "Tokyo",
"en_address_line": "",
"en_address_outside": "",
"furigana": "オープンコレクター",
"hihyoji": "0"
}
}
法人情報検索API
法人名や住所などを元に、該当する法人情報リソースを取得します。
法人名・住所検索APIには以下の特長があります。
- 非標準文字での検索に対応
- 完全一致検索に対応。法人種別抜き・込みを選択可能
- ファセット検索による絞り込みに対応
curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/houjinbangou?q=府庁&limit=1&facet_area=/&facet_kind=/&facet_process=/&facet_close_cause=/"
レスポンスは以下の通りです。
{
"version": "2022-02-22",
"data": [
{
"published_date": "2022-01-31",
"sequence_number": "3496847",
"corporate_number": "4130005004608",
"process": "1",
"correct": "1",
"update_date": "2020-07-30",
"change_date": "2015-10-05",
"name": "京都府庁生活協同組合",
"name_image_id": null,
"kind": "399",
"prefecture_name": "京都府",
"city_name": "京都市上京区",
"street_number": "京都府庁内",
"town": "京都府庁内",
"kyoto_street": null,
"block_lot_num": null,
"building": null,
"floor_room": null,
"address_image_id": null,
"jisx0402": "26102",
"post_code": "6020000",
"address_outside": "",
"address_outside_image_id": null,
"close_date": null,
"close_cause": null,
"successor_corporate_number": null,
"change_cause": "",
"assignment_date": "2015-10-05",
"en_name": "",
"en_prefecture_name": "",
"en_address_line": "",
"en_address_outside": "",
"furigana": "キョウトフチョウセイカツ",
"hihyoji": "0"
}
],
"query": "府庁",
"count": 23,
"offset": 0,
"limit": 1,
"facets": {
"area": [
["/京都府", 20],
["/大阪府", 2],
["/東京都", 1]
],
"kind": [
["/その他", 2],
["/その他の設立登記法人", 14],
["/合同会社", 3],
["/地方公共団体", 1],
["/有限会社", 1],
["/株式会社", 1],
["/行政機関など", 1]
],
"process": [
["/吸収合併", 1],
["/国内所在地の変更", 2],
["/新規", 17],
["/登記記録の閉鎖等", 3]
],
"close_cause": [
["/その他", 20],
["/その他の清算の結了等", 1],
["/合併による解散等", 1],
["/登記官による閉鎖", 1]
]
}
}
デモ
https://kenall.jp/features/houjinbangou
適格請求書発行事業者API
登録番号を元に、適格請求書発行事業者登録情報リソースを取得します。
適格請求書発行事業者情報取得API
指定された登録番号に対応する最新の適格請求書発行事業者登録情報リソースを取得します。
curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/invoice/T2021001052596"
レスポンスは以下の通りです。
{
"version": "2022-02-22",
"data": {
"published_date": "2024-01-31",
"sequence_number": 105653,
"qualified_invoice_issuer_number": "T2021001052596",
"process": 1,
"correct": 0,
"kind": 2,
"latest": 1,
"registration_date": "2023-10-01",
"update_date": "2022-03-02",
"disposal_date": null,
"expire_date": null,
"address": {
"postal_code": null,
"jisx0402": "13101",
"prefecture": "東京都",
"prefecture_kana": "トウキョウト",
"prefecture_roman": "Tokyo",
"city": "千代田区",
"city_kana": "チヨダク",
"city_roman": "Chiyoda-ku",
"street_number": "麹町３丁目１２－１４麹町駅前ヒルトップ８階",
"town": "麹町",
"kyoto_street": null,
"block_lot_num": "3-12-14",
"building": "麹町駅前ヒルトップ",
"floor_room": "8階"
},
"address_request": null,
"address_inside": null,
"kana": "",
"name": "株式会社オープンコレクター",
"trade_name": "",
"popular_name_previous_name": ""
}
}
その他のAPI
日本の祝日API
「国民の祝日に関する法律」に定められた祝日を取得するためのAPIです。
使用例
curl -s -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/holidays?year=2022"
レスポンスは以下の通りです。
{
"data": [
{
"title": "元日",
"date": "2022-01-01",
"day_of_week": 6,
"day_of_week_text": "saturday"
},
{
"title": "成人の日",
"date": "2022-01-10",
"day_of_week": 1,
"day_of_week_text": "monday"
},
{
"title": "建国記念の日",
"date": "2022-02-11",
"day_of_week": 5,
"day_of_week_text": "friday"
},
{
"title": "天皇誕生日",
"date": "2022-02-23",
"day_of_week": 3,
"day_of_week_text": "wednesday"
},
{
"title": "春分の日",
"date": "2022-03-21",
"day_of_week": 1,
"day_of_week_text": "monday"
},
{
"title": "昭和の日",
"date": "2022-04-29",
"day_of_week": 5,
"day_of_week_text": "friday"
},
{
"title": "憲法記念日",
"date": "2022-05-03",
"day_of_week": 2,
"day_of_week_text": "tuesday"
},
{
"title": "みどりの日",
"date": "2022-05-04",
"day_of_week": 3,
"day_of_week_text": "wednesday"
},
]
}
自己IPアドレス確認API
アクセス元のIPアドレスを取得することができます。
使用例
curl -s -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/whoami"
レスポンスは以下の通りです。
{
"remote_addr": {
"type": "v4",
"address": "<IPアドレス>"
}
}