jp-local-gov-id

日本の全国地方公共団体コードを、JavaScriptから扱えるようにするAPIです。

できることの例

• 都道府県を指定すると、その都道府県に所在する市区町村を出力する。
• 都道府県の情報を一覧で取得する。
• 地方自治体のコードを取得する。ユニークなコードなので、住所の正規化に用いることができる。

インストール

npm install @b4moss/jp-local-gov-id @b4moss/jp-local-gov-id-data

詳しくはインストールを参照してください。

簡単なコード例

import { createLocalGovClient } from "@b4moss/jp-local-gov-id";
import dataset from "@b4moss/jp-local-gov-id-data";

const client = await createLocalGovClient({ data: dataset });
await client.getByCode("131016"); // 千代田区

詳しくは使い方を参照してください。

試してみる

ブラウザ上でコード解決と文字列検索を試せます。自由にコードを書く場合は Playground へ。

コード解決

文字列検索

パッケージ内容

質問・要望など

GitHub の Issuesからお願いします。（GitHubアカウントが必要です。）