{"id":28576275,"url":"https://github.com/digital-go-jp/abr-geocoder","last_synced_at":"2026-03-04T03:01:30.188Z","repository":{"id":173912752,"uuid":"650913037","full_name":"digital-go-jp/abr-geocoder","owner":"digital-go-jp","description":"Address Base Registry Geocoder by digital.go.jp","archived":false,"fork":false,"pushed_at":"2025-10-06T07:40:25.000Z","size":13137,"stargazers_count":110,"open_issues_count":31,"forks_count":33,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-10-06T09:28:41.184Z","etag":null,"topics":["address-base-registry","geocoder"],"latest_commit_sha":null,"homepage":"https://lp.geocoder.address-br.digital.go.jp/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/digital-go-jp.png","metadata":{"files":{"readme":"README.ja.md","changelog":null,"contributing":"CONTRIBUTING/CONTRIBUTING.ja.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-08T04:51:56.000Z","updated_at":"2025-10-05T01:58:14.000Z","dependencies_parsed_at":"2023-10-14T20:14:24.841Z","dependency_job_id":"1ff0abf7-93cc-4c49-aad0-67492d26d317","html_url":"https://github.com/digital-go-jp/abr-geocoder","commit_stats":null,"previous_names":["digital-go-jp/abr-geocoder"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/digital-go-jp/abr-geocoder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-go-jp%2Fabr-geocoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-go-jp%2Fabr-geocoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-go-jp%2Fabr-geocoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-go-jp%2Fabr-geocoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/digital-go-jp","download_url":"https://codeload.github.com/digital-go-jp/abr-geocoder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digital-go-jp%2Fabr-geocoder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30070479,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T01:03:42.280Z","status":"online","status_checked_at":"2026-03-04T02:00:07.464Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address-base-registry","geocoder"],"created_at":"2025-06-10T23:10:45.170Z","updated_at":"2026-03-04T03:01:30.184Z","avatar_url":"https://github.com/digital-go-jp.png","language":"TypeScript","readme":"# abr-geocoder (デジタル庁 アドレス・ベース・レジストリ ジオコーダー)\n\n- [English version](./README.md)\n\n## 🚨 Version 2.2 から Version 2.2.1 へのアップグレード\n\n- データセットダウンロード用の新しいDCAT形式APIに対応しました。\n- **既知の問題**: `abrg update-check`コマンドは新しいAPI形式にまだ対応しておらず、正しく動作しません。今後Version3へのアップデートを予定しているため、Version2での対応は未定です。\n\n## 🚨 Version 2.1 から Version 2.2 へのアップグレード\n\n- `abrg serve`コマンドは、`abrg serve start`と `abrg serve stop`コマンドになりました\n\n\n## 説明\n\n  入力した住所文字列とデジタル庁が整備する [アドレス・ベース・レジストリ](https://catalog.registries.digital.go.jp/rc/dataset/)を突合し、正規化された住所文字列・町字 ID ・緯度経度等を出力するジオコーダーです。\n  日本国内の住所表記を分析し、揺れを吸収して、階層に合わせて正規化した結果を出力します。\n\n  ![](https://lp.geocoder.address-br.digital.go.jp/assets/2024072820391722166771.png)\n\n## 特徴\n\n  - 日本国内の住所を対象としたジオコーダ\n  - [アドレス・ベース・レジストリ](https://catalog.registries.digital.go.jp/rc/dataset/)に基づいて住所表記、階層に合わせて正規化\n  - `住居表示` と `地番` に対応。\n  - SQLiteを使用。サーバー内でジオコーディングすることが可能。\n  - マルチスレッドによる高速処理。\n  - `csv`, `json`, `geojson`, `ndjson`, `ndgeojson`, `simplified` の6つの出力形式をサポート。\n\n## ユースケース\n\n  - コマンドとして利用可能\n    - 標準入力・標準出力によるパイプライン\n    - ファイルによる入出力\n  - RESTサーバとして利用可能\n  - Node.jsのライブラリとして利用可能\n    - 個別リクエスト、Streamをサポート\n  - 京都の通り名による検索（※一部未対応）\n\n## できないこと\n\n  - ランドマーク（有名な施設名など）による検索\n  - 郵便番号による検索\n  - アルファベット（英語表記）による検索\n\n## インストール\n\n  - グローバルインストール\n  ```sh\n  npm install -g @digital-go-jp/abr-geocoder\n  abrg  # 実行できることを確認\n  ```\n\n  - ローカルインストール \n  ```sh\n  npm install @digital-go-jp/abr-geocoder\n  npm link\n  abrg  # 実行できることを確認\n  ```\n\n## `abrg download`コマンド\n\n  [アドレス・ベース・レジストリ](https://catalog.registries.digital.go.jp/rc/dataset/)からジオコーディングに必要なデータセットをダウンロードし、SQLiteを使ってデータベースを構築します。\n\n  ```sh\n  abrg download [options]\n  ```\n\n  - \u003cdetails\u003e\n    \u003csummary\u003e地域を指定してダウンロード\u003c/summary\u003e\n\n    特定の都道府県や市町村を指定して、地域を限定したデータベースを構築することが可能です。これによりダウンロードするデータサイズを抑え、データベースを早く構築することが出来るようになります。\n\n    地域を指定するコードは、[全国地方公共団体コード](https://www.soumu.go.jp/denshijiti/code.html)を指定します。\n    複数の地域を指定する場合は、半角空白で区切ります。\n\n    ```sh\n    # 東京都のデータをダウンロードする\n    abrg download -c 130001\n\n    # 東京都と神奈川県のデータをダウンロードする\n    abrg download -c 130001 140007\n\n    # 千代田区のデータをダウンロードする\n    abrg download -c 131016\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eディレクトリの変更\u003c/summary\u003e\n\n    データセットファイルをダウンロードしたり、データベースを保存するディレクトリを変更することができます。\n    デフォルトでは `$HOME/.abr-geocoder` に保存します。\n\n    ```sh\n    abrg download -d (データを保存するディレクトリへのパス)\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eプログレスバーを非表示\u003c/summary\u003e\n    silentオプションを指定すると、プログレスバーを表示しません。\n\n    ```sh\n    abrg download --silent\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eデバッグ情報の表示\u003c/summary\u003e\n    処理が完了したとき、処理に掛かった時間を表示します。\n\n    ```sh\n    abrg download --debug\n    ```\n  \u003c/details\u003e\n\n## `abrg update-check`コマンド\n\n  データのアップデートを確認します。ローカルにデータがある場合は、データベースに含まれる市区町村を対象にアップデートチェックを行ないます。新しいデータがある場合には、続けてダウンロードすることが可能です。\n\n  ```sh\n  abrg update-check [options]\n  ```\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eyes/no を事前に指定\u003c/summary\u003e\n    利用可能な更新データがある場合、続けてダウンロードを行うかどうかを事前に指定しておくことができます。\n\n    ```sh\n    # 続けてダウンロードを行う場合\n    abrg update-check --yes\n\n    # 続けてダウンロードを行わない場合\n    abrg update-check --no\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eプログレスバーを非表示\u003c/summary\u003e\n    silentオプションを指定すると、プログレスバーを表示しません。\n\n    ```sh\n    abrg update-check --silent\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eディレクトリの変更\u003c/summary\u003e\n\n    データベースを保存するディレクトリを指定します。デフォルトでは `$HOME/.abr-geocoder` です。\n\n    ```sh\n    abrg update-check -d (データを保存するディレクトリへのパス)\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eデバッグ情報の表示\u003c/summary\u003e\n    処理が完了したとき、処理に掛かった時間を表示します。\n\n    ```sh\n    abrg update-check --debug\n    ```\n  \u003c/details\u003e\n\n## `abrg`コマンド\n\n  入力した住所文字列をデータベースと突合し、正規化された住所文字列・町字 ID・緯度経度等を出力します。\n  (ジオコーディングを行います。)\n\n  ```\n  $ abrg \u003cinputFile\u003e [\u003coutputFile\u003e] [options]\n  ```\n\n  - `\u003cinputFile\u003e`\n    \n    コマンドにデータを入力する方法を指定します。\n\n    - \u003cdetails\u003e\n      \u003csummary\u003eファイルへのパスを指定した場合\u003c/summary\u003e\n      指定されたテキストファイルをジオコーディングします。\n      １行単位（１行につき１つのアドレス）で記入してください。\n\n      例：\n      ```\n      abrg ./sample.txt\n      ```\n\n      sample.txt\n      ```\n      東京都千代田区紀尾井町1-3\n      東京都千代田区永田町1-10-1\n      ...\n      東京都千代田区永田町一丁目7番1号\n      ```\n      \u003c/details\u003e\n\n    - \u003cdetails\u003e\n      \u003csummary\u003e\"-\" を指定した場合\u003c/summary\u003e\n      標準入力からデータを受け取ります。\n\n      例：\n      ```\n      echo \"東京都千代田区紀尾井町1-3　東京ガーデンテラス紀尾井町 19階、20階\" | abrg -\n      ```\n      \u003c/details\u003e\n      \n\n  - `\u003coutputFile\u003e`\n  \n    処理結果の出力先を指定します。省略された場合は標準出力(stdout)に出力されます。\n\n    - \u003cdetails\u003e\n      \u003csummary\u003eファイルへのパスを指定した場合\u003c/summary\u003e\n      指定されたファイルに処理結果を出力します。出力形式は `--format` オプションに基づきます。\n\n      例：\n      ```\n      abrg ./input.txt ./output.json\n      ```\n      \u003c/details\u003e\n\n    - \u003cdetails\u003e\n      \u003csummary\u003e省略した場合\u003c/summary\u003e\n      省略された場合は標準出力(stdout)に出力されます。\n\n      例：\n      ```\n      cat ./sample.txt | abrg - | jq\n      ```\n      \u003c/details\u003e\n      \n  - \u003cdetails\u003e\n    \u003csummary\u003e出力形式の変更\u003c/summary\u003e\n    \n    `-f`, `--format` オプションで出力書式を変更できます。デフォルトは`json`です。\n\n    | format     | 説明                                                           |\n    |------------|---------------------------------------------------------------|\n    | csv        | カンマ区切りのcsv形式で結果を出力します                             |\n    | simplified | 出力フィールドを限定した、カンマ区切りのcsv形式で結果を出力します        |\n    | json       | JSON形式で結果を出力します                                        |\n    | ndjson     | NDJSON形式で結果を出力します                                      |\n    | geojson    | GeoJSON形式で結果を出力します                                     |\n    | ndgeojson  | NDGeoJSON形式で結果を出力します                                   |\n\n    \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eワイルドカード文字を指定する\u003c/summary\u003e\n    任意の1文字をワイルドカードとして扱うことができます。\n    utf-8で表現できない旧漢字などを●（黒丸）などに変換した場合などに、指定すると便利です。デフォルトは`?`です。\n\n    例:\n    ```\n    echo \"東京都町●市森野2-2-22\" | abrg - --fuzzy \"●\"\n    ```\n    \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eプログレスバーを非表示\u003c/summary\u003e\n    silentオプションを指定すると、プログレスバーを表示しません。\n\n    ```sh\n    abrg ./input.txt ./output.txt --silent\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eディレクトリの変更\u003c/summary\u003e\n\n    データベースを保存するディレクトリを指定します。デフォルトでは `$HOME/.abr-geocoder` です。\n\n    ```sh\n    abrg ./input.txt ./output.txt  -d (データを保存するディレクトリへのパス)\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eデバッグ情報の表示\u003c/summary\u003e\n    処理が完了したとき、処理に掛かった時間を表示します。\n    また入力された住所文字列にマッチした各テーブルの主キーの情報が出力されます。\n\n    ```sh\n    abrg ./input.txt ./output.txt --debug\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eジオコーディング対象\u003c/summary\u003e\n    \n    `--target` オプションで住居表示・地番のジオコーディング対象を変更できます。デフォルトは`all`です。\n\n    | format      | 説明                                                         |\n    |-------------|-------------------------------------------------------------|\n    | all         | 住居表示と地番のデータの両方を調べます。住居表示の結果が優先されます    |\n    | residential | 住居表示データのみを調べます                                     |\n    | parcel      | 地番データのみを調べます                                        |\n\n    \u003c/details\u003e\n\n## `abrg serve start`コマンド\n\n  ジオコーダをREST APIサーバーとして起動します。\n\n  ```sh\n  abrg serve start [options]\n  ```\n\n  リクエスト方法\n\n  ```sh\n  curl http://localhost:3000/geocode?address=東京都千代田区紀尾井町1-3\n  ```\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eポート番号の変更\u003c/summary\u003e\n\n    REST APIサーバーのポート番号を変更します。デフォルトは `3000` です。\n\n    ```sh\n    abrg serve start -p 8080\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eディレクトリの変更\u003c/summary\u003e\n\n    データベースを保存するディレクトリを指定します。デフォルトでは `$HOME/.abr-geocoder` です。\n\n    ```sh\n    abrg serve start -d (データを保存するディレクトリへのパス)\n    ```\n  \u003c/details\u003e\n\n  - \u003cdetails\u003e\n    \u003csummary\u003eリクエスト・パラメータ\u003c/summary\u003e\n\n    HTTP/GETでリクエストを行います。以下のパラメータが指定可能です。\n\n    | パラメータ    | 必須 | 説明                                      |\n    |-------------|-------------------------------------------------|\n    | address     |   Y  | ジオコーディングしたい住所文字列。必須パラメータ |\n    | target      |      | 検索対象(all, residentaial, parcel)       |\n    | format      |      | 結果の出力形式                             |\n    | fuzzy       |      | ワイルドカードとして使用する1文字             |\n\n  \u003c/details\u003e\n\n## `abrg serve stop`コマンド\n\n  ジオコーダをREST APIサーバーを終了します\n\n  ```sh\n  abrg serve stop\n  ```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-go-jp%2Fabr-geocoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdigital-go-jp%2Fabr-geocoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigital-go-jp%2Fabr-geocoder/lists"}