住所検索 (/address/list)

基本情報

キーワードや住所コードから、条件に合致する住所情報を取得できます。

出力形式 デフォルト出力順
JSON キーワード類似順

リクエストパラメータ

共通パラメータ も参照してください。

パラメータ名 概要 入力値 必須 デフォルト値 説明
address
出力したい住所一覧のコード 文字列    
有効桁数は以下の通り。
2桁(都道府県)
5桁(市区町村)
8桁(町・大字)
11桁(丁目・小字)
16桁(街区)
21桁(地番)
詳細は 住所データについて を参照。
検索キーワード 文字列    
キーワードに関連する住所を表示する。
住所のふりがなでも検索可能。
level-to 住所レベルの上限 数値   なし (すべての住所が対象)
指定したレベルまでの住所に絞り込む。
指定可能なレベルは以下の通り。
1 都道府県
2 市区町村
3 大字・町
4 小字・丁目
5 街区
6 地番
7 枝番

注釈

  • address, word を組み合わせた検索はできません。
  • level-to を指定した場合、 address を指定することはできません。

注意

「lang=ja」以外を使用する場合、「lang=ja」を指定した検索結果と返却結果が異なる場合がありますのでご注意ください。

レスポンスオブジェクト

レスポンスオブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
count Object (Count) 検索件数情報
items Array (Address) 検索結果一覧

例:

{
    "count": {
        "total": 100,
        "offset": 0,
        "limit": 7
    },
    "items": [
        {
            "code": "13103025002",
            "name": "東京都港区南青山1丁目",
            ...
        },
        {
            "code": "13103025002",
            "name": "東京都港区南青山2丁目",
            ...
        },
        ...
        {
            "code": "13103025003",
            "name": "東京都港区南青山7丁目",
            ...
        }
    ]
}

Count オブジェクト

Count オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
total Number 検索条件に該当する総件数
offset Number 出力項目の表示開始位置
limit Number 出力項目数の最大値

例:

{
   "total": 87,
   "offset": 0,
   "limit": 10
}

Address オブジェクト

Address オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
code String 住所コード
name String 住所名
address Array (AddressLevel) 階層化された住所情報
coord Object (Coordinate) 緯度経度

例:

{
    "code": "13103025003",
    "name": "東京都港区南青山3丁目",
    "address": [
        {
            "code": "13",
            "name": "東京都",
            "ruby": "とうきょうと",
            "level": "1"
        },
        {
            "code": "13103",
            "name": "港区",
            "ruby": "みなとく",
            "level": "2"
        },
        {
            "code": "13103025",
            "name": "南青山",
            "ruby": "みなみあおやま",
            "level": "3"
        },
        {
            "code": "13103025003",
            "name": "3丁目",
            "ruby": "3ちょうめ",
            "level": "4"
        }
    ],
    "coord": {
        "lat": 35.665935,
        "lon": 139.715185
    }
}

AddressLevel オブジェクト

AddressLevel オブジェクトは次のプロパティを持ちます。 住所データは階層構造を持って管理されます。

プロパティ名 データ型 説明
code String 住所コード
name String 住所名
ruby String 住所名の読み仮名
level String 住所階層の深さ

例:

{
    "code": "13",
    "name": "東京都",
    "ruby": "とうきょうと",
    "level": "1"
}

Coordinate オブジェクト

Coordinate オブジェクトは次のプロパティを持ちます。

プロパティ名 データ型 説明
lat Number 緯度
lon Number 経度

例:

{
   "lat": 35.68956761,
   "lon": 139.70070036
}