Jageocoder ドキュメント
Jageocoder は日本の住所のジオコーディング・リバースジオコーディングを行う Python パッケージです。 住所を解析して経緯度を求めたり(ジオコーディング)、 逆に経緯度から対応する住所を検索(リバースジオコーディング)することができます。
>>> import jageocoder
>>> jageocoder.init()
>>> jageocoder.search('新宿区西新宿2-8-1')
{'matched': '新宿区西新宿2-8-', 'candidates': [{'id': 80223284, 'name': '8番', 'x': 139.6917724609375, 'y': 35.68962860107422, 'level': 7, 'priority': 3, 'note': '', 'fullname': ['東京都', '新宿区', '西新宿', '二丁目', '8番']}]}
>>> jageocoder.reverse(139.691772, 35.689628, level=7)[0]
{'candidate': {'id': 80223284, 'name': '8番', 'x': 139.6917724609375, 'y': 35.68962860107422, 'level': 7, 'priority': 3, 'note': '', 'fullname': ['東京都', '新宿区', '西新宿', '二丁目', '8番']}, 'dist': 0.07866663127258333}
動作環境
Python 3.9.2 以上がインストールされた Linux, Windows, MacOS で動作します。
ライセンス表示
Copyright (c) 2021-2025 Takeshi SAGARA 相良 毅
MIT ライセンス で利用できます。
ただしこのライセンスは住所データベースで利用している
辞書データに対しては適用されません。
辞書データの利用条件・ライセンスは、それぞれの辞書データの
提供元が設定した条件に従いますので、住所データベースを
インストールしたディレクトリの README.md を確認してください。
目次
- クイックスタート
- インストール手順
- コマンドライン・インタフェース
- コードサンプル
- API リファレンス
- モジュールメソッド
create_trie_index()dictionary_version()download_dictionary()free()get_datasets()get_db_dir()get_module_tree()get_search_config()init()install_dictionary()installed_dictionary_readme()installed_dictionary_version()is_initialized()reverse()search()searchNode()search_aza_record_by_code()search_by_citycode()search_by_machiaza_id()search_by_postcode()search_by_prefcode()set_search_config()uninstall_dictionary()version()
- AddressTree クラス
AddressTreeAddressTree.modeAddressTree.db_dirAddressTree.address_nodesAddressTree.aza_mastersAddressTree.trie_nodesAddressTree.trie_pathAddressTree.debugAddressTree.rootAddressTree.configAddressTree.__init__()AddressTree.count_records()AddressTree.create_note_index_table()AddressTree.datasetsAddressTree.get_address_node()AddressTree.get_config()AddressTree.get_converter()AddressTree.get_node_by_id()AddressTree.get_node_fullname()AddressTree.get_root()AddressTree.get_version()AddressTree.installed_dictionary_readme()AddressTree.installed_dictionary_version()AddressTree.reverse()AddressTree.search()AddressTree.searchNode()AddressTree.search_aza_record_by_code()AddressTree.search_aza_records_by_codes()AddressTree.search_by_citycode()AddressTree.search_by_machiaza_id()AddressTree.search_by_postcode()AddressTree.search_by_prefcode()AddressTree.search_ids_by_codes()AddressTree.search_nodes_by_codes()AddressTree.set_config()AddressTree.validate_config()
- LocalTree クラス
LocalTreeLocalTree.modeLocalTree.db_dirLocalTree.tableLocalTree.aza_mastersLocalTree.trie_nodesLocalTree.trie_pathLocalTree.debugLocalTree.rootLocalTree.configLocalTree.converterLocalTree.__init__()LocalTree.count_records()LocalTree.create_note_index_table()LocalTree.datasetsLocalTree.get_address_node()LocalTree.get_converter()LocalTree.get_node_by_id()LocalTree.get_trie_nodes()LocalTree.installed_dictionary_readme()LocalTree.installed_dictionary_version()LocalTree.reverse()LocalTree.search()LocalTree.searchNode()LocalTree.search_aza_record_by_code()LocalTree.search_by_tree()LocalTree.search_by_trie()LocalTree.search_ids_by_codes()LocalTree.search_nodes_by_codes()LocalTree.validate_config()
- RemoteTree クラス
RemoteTreeRemoteTree.urlRemoteTree.debugRemoteTree.address_nodesRemoteTree.configRemoteTree.__init__()RemoteTree.count_records()RemoteTree.create_note_index_table()RemoteTree.datasetsRemoteTree.get_node_by_id()RemoteTree.get_trie_nodes()RemoteTree.installed_dictionary_readme()RemoteTree.installed_dictionary_version()RemoteTree.json_request()RemoteTree.reverse()RemoteTree.searchNode()RemoteTree.search_aza_record_by_code()RemoteTree.search_by_citycode()RemoteTree.search_by_machiaza_id()RemoteTree.search_by_postcode()RemoteTree.search_by_prefcode()RemoteTree.search_by_trie()RemoteTree.search_ids_by_codes()RemoteTree.search_nodes_by_codes()
- AddressNode クラス
AddressNodeAddressNode.name_indexAddressNode.__init__()AddressNode.__repr__()AddressNode.add_dummy_coordinates()AddressNode.add_note()AddressNode.as_dict()AddressNode.as_geojson()AddressNode.childrenAddressNode.datasetAddressNode.from_record()AddressNode.get_aza_code()AddressNode.get_aza_id()AddressNode.get_aza_names()AddressNode.get_aza_record()AddressNode.get_child()AddressNode.get_children()AddressNode.get_city_jiscode()AddressNode.get_city_local_authority_code()AddressNode.get_city_name()AddressNode.get_fullname()AddressNode.get_googlemap_link()AddressNode.get_gsimap_link()AddressNode.get_machiaza_id()AddressNode.get_name()AddressNode.get_nodes_by_level()AddressNode.get_notes()AddressNode.get_omissible_children()AddressNode.get_omissible_index()AddressNode.get_parent()AddressNode.get_parent_list()AddressNode.get_postcode()AddressNode.get_pref_jiscode()AddressNode.get_pref_local_authority_code()AddressNode.get_pref_name()AddressNode.has_valid_coordinate_values()AddressNode.is_inside()AddressNode.iter_children()AddressNode.levelnameAddressNode.parentAddressNode.retrieve_upper_node()AddressNode.root()AddressNode.search_child_with_criteria()AddressNode.search_recursive()AddressNode.set_attributes()AddressNode.set_notes()AddressNode.to_json()AddressNode.to_record()
- AddressLevel クラス
- Result クラス
- モジュールメソッド