基本概念

API を利用する上で必要となる、各種 ID・コードの体系やデータに関する基本概念を説明します。

ID・コードの体系について

住所コード

住所には階層構造を持たせており、「レベル」として区分けしています。
各レベルには固有の住所コードを割り振っており、住所コードの桁数はレベルによって異なります。
各レベルの分類とコード桁数の関係は以下のようになっています。

レベル 分類 コード桁数
1 都道府県 2
2 市区町村 5
3 大字・町 8
4 小字・丁目 11
5 街区 16
6 地番 21
7 枝番 26

レベル 3「大字・町」について

レベル 3 の「大字・町」については、下 3 桁が 0 埋めされたコードも受け取ります。
この場合は 11 桁となります。

 

本APIで利用している住所コード体系はデータ提供元の住所体系に依存しています。
市区町村レベルまでであれば全国地方公共団体コードから6桁目のチェックディジットを除いたものになりますが、 大字以降のコードは一覧で確認することはできませんので、住所検索にて取得したコードをご利用ください。

カテゴリコード

スポット情報は基本的に 1 つ以上のカテゴリに属していて、各カテゴリは固有のコードを持ちます。
カテゴリは親子関係を持っていて、次の 4 階層から成り立ちます。

出力名称 分類 コード桁数
large 大項目 2
middle 中項目 4
small 小項目 7
detail 細項目 10

出力順について

カテゴリは「細項目 〜 大項目」の順に出力されます。

出力例

  • 「もんじゃ焼き」のカテゴリ
{
    "categories": [
        {
            "code": "0305026003",
            "name": "もんじゃ焼",
            "ruby": "もんじゃやき",
            "level": "detail"
        },
        {
            "code": "0305026",
            "name": "お好み/もんじゃ/たこ焼き",
            "ruby": "おこのみもんじゃ",
            "level": "small"
        },
        {
            "code": "0305",
            "name": "和食系",
            "ruby": "わしょくけい",
            "level": "middle"
        },
        {
            "code": "03",
            "name": "グルメ/お酒",
            "ruby": "ぐるめおさけ",
            "level": "large"
        }
    ]
}