{"repo":"ttskch/jp-postal-code-api","free":true,"listed":false,"github":"https://github.com/ttskch/jp-postal-code-api","clone":"git clone https://github.com/ttskch/jp-postal-code-api.git","description":"無料で商用にも使える日本の郵便番号API","language":"PHP","stars":481,"topics":["api","postal-code","rest"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"日本の郵便番号API 日本の郵便番号から住所のデータを取得できるWeb APIです。 GitHub Pagesを使用して静的なJSONファイルとして配信しているため、可用性が高いのが特徴です。また、オープンソースなのでクライアントワークでも安心してご使用いただけます。もしリポジトリの永続性や GitHub Pagesの利用制限 が心配な場合は、ご自由にフォークしてご利用ください。 日本郵便によって公開されているデータ を元に住所データのJSONファイルを生成して配信しています。配信データはGitHub Actionsを使用して 毎日最新の内容に更新しています。 [!NOTE] このプロジェクトの実装は madefor/postal-code-api にインスピレーションを受けています。長期間メンテナンスが行われていない同プロジェクトに代わるものとして、モダンPHPで再実装しました。オリジナルのソースコードに最大の敬意を表します。 デモ https://jp-postal-code-api.ttskch.com エンドポイント 使い方 例えば、郵便番号が 100-0014 の住所（東京都千代田区永田町）を取得したい場合は、エンドポイントのURLとレスポンスの内容は以下のようになります。 https://jp-postal-code-api.ttskch.com/api/v1/1000014.json 1つの郵便番号に複数の住所がある場合は、レスポンスの内容は以下のようになります。 https://jp-postal-code-api.ttskch.com/api/v1/6180000.json 大口事業所個別番号では、事業所名以外のカナ表記と英語表記は空になります。 https://jp-postal-code-api.ttskch.com/api/v1/1008111.json 2024年1月1日に市町村変更があった住所 を取得すると、2024年5月現在では英語表記は出力されません。元データ が更新されると、このWeb APIの配信データも最大1日の誤差で自動的に更新されます。 https://jp-postal-code-api.ttskch.com/api/v1/4328003.json 配信データの仕様 Web APIの配信データは 日本郵便によって公開されているデータ を元に生成しています。具体的なスキーマは 使い方 の例をご参照ください。 日本語表記・カナ表記・英語表記の住所データが含まれていますが、後述の制限事項があります。 制限事項 大口事業所個別番号の住所データは以下のように出力されます（元データ の内容がそうであるため） カナ表記は事業所名についてのみ出力されます 事業所名のカナ表記は促音・拗音が大書きで出力されます 英語表記は出力されません 一部の住所において、英語表記のうち主に address2 フィールドの内容が途切れている場合があります（元データ の内容が そうである ため） 直近1年程度以内に 市町村変更があった住所 については、英語表記は出力されません（元データが年1回程度しか更新されない ため） 自動更新 こちらのGitHub Actions Workflow によって、毎日午前0時頃に自動的に Web APIの配信データの内容を最新化しています。更新処理の具体的な内容は以下のとおりです。 1. 日本郵便のWebサイト から 住所の郵便番号、住所の郵便番号（ローマ字）、事業所の個別郵便番号 のデータをダウンロード ","default_branch":null,"files":null,"tree":[],"storefront":"/r/ttskch","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ttskch/jp-postal-code-api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}