ホーム APIリファレンス Web API poi_multi

Web API

premium
poi_multi

施設検索(多言語)

多言語で施設情報の検索を行います。
対応言語:英語・中国語簡体・中国語繁体・韓国語

施設フリーワード検索
　施設名を指定してフリーワード検索できます。
　施設ジャンルのジャンルコードを指定してリスト検索する事ができます。

施設ジャンルリスト返却
　住所コード、施設ジャンルコードを取得できます。
　取得したコードを指定すると、配下の施設ジャンルコードを取得できます。

施設ジャンルフリーワード検索
　指定された施設名が属する施設ジャンルのジャンルコードの情報を検索します。

検索条件を複数指定した場合はAND結合となります。
※本APIを利用するには別途契約が必要です。

https://[domain]/search/poi_multi

HTTP request method

POST/GET

ContentType

application/x-www-form-urlencoded

Parameters

*requiredは必須
Array型のパラメータの区切り文字は特記のない限りカンマ(,)およびセミコロン(;)です。

名前 説明
genre_pattern*required
string		 ジャンルパターンを指定する。(いずれか一つ指定可能)
英語
1011,1021
中国語簡体
1012,1022
中国語繁体
1013,1023
韓国語
1014,1024
word_en
string		 名称を指定(英語)
最小文字数 2、最大文字数 255
word_match_typeが3(部分一致)の場合のみ、スペース区切りで複数ワード(1ワードの最小文字数 2)のAND検索を行います。
word_en,word_zh_cn,word_zh_tw,word_ko 同時の指定不可
genre_patternの値に1011、1021以外を指定した場合、指定不可
word_zh_cn
string		 名称を指定(中国語簡体)
最小文字数 2、最大文字数 255
word_match_typeが3(部分一致)の場合のみ、スペース区切りで複数ワード(1ワードの最小文字数 2)のAND検索を行います。
word_en,word_zh_cn,word_zh_tw,word_ko 同時の指定不可
genre_patternの値に1012、1022以外を指定した場合、指定不可
word_zh_tw
string		 名称を指定(中国語繁体)
最小文字数 2、最大文字数 255
word_match_typeが3(部分一致)の場合のみ、スペース区切りで複数ワード(1ワードの最小文字数 2)のAND検索を行います。
word_en,word_zh_cn,word_zh_tw,word_ko 同時の指定不可
genre_patternの値に1013、1023以外を指定した場合、指定不可
word_ko
string		 名称を指定(韓国語)
最小文字数 2、最大文字数 255
word_match_typeが3(部分一致)の場合のみ、スペース区切りで複数ワード(1ワードの最小文字数 2)のAND検索を行います。
word_en,word_zh_cn,word_zh_tw,word_ko 同時の指定不可
genre_patternの値に1014、1024以外を指定した場合、指定不可
word_match_type
integer
default 3		 検索語句のマッチタイプを指定
  • 1

    完全一致(スペースや記号が削除され、1ワードとして検索されます。)

  • 2

    前方一致(スペースや記号が削除され、1ワードとして検索されます。)

  • 3

    部分一致
address_code_list
array[string]		 住所コードを指定(前方一致)
複数指定の場合はOR検索となります。
各住所コードの最大文字数 255
指定できる値は最大50件
proximity
array[number]
※カンマ区切り		 中心座標、半径で範囲を指定
代表点の近傍検索。
"経度,緯度,半径(m)"で指定してください。
半径の上限は5000です。
phone_number
string		 電話番号を指定(完全一致)
ハイフンは削除して検索します。
genre_code
array[string]		 ジャンルコードを指定(完全一致)
ジャンルコードをレベル1とレベル2のコロン(:)区切りで指定(複数指定可)
複数指定する場合はカンマ区切りで指定します。
指定できる値は最大50件
例)00010:0001000015,00010:0001000020,00020:0002000020
sort
array[string]		 出力順を指定(複数指定可)
デフォルトは昇順です。降順指定の場合、ソートキーの前方にマイナス(-)を付加してください。
デフォルト指定はありません。
zid
建物ZID
zid_attr
属性ZID
id
ID(地物)
id_attr
ID(属性)
name
名称
name_read
名称読み
distance
検索座標と施設代表点の直線距離
genre_code
ジャンルコード
name_en
名称英語
genre_patternの値に1011、1021以外を指定した場合、指定不可
name_zh_cn
名称中国語簡体
genre_patternの値に1012、1022以外を指定した場合、指定不可
name_zh_tw
名称中国語繁体
genre_patternの値に1013、1023以外を指定した場合、指定不可
name_ko
名称韓国語
genre_patternの値に1014、1024以外を指定した場合、指定不可
facet
array[string]		 取得するファセットフィールド名を指定
ジャンル毎の取得件数(カンマ区切り)を取得する事ができます。
指定可能な値:genre_facet
limit
array[integer]
※カンマ区切り
default List[0,100]		 検索結果取得件数を"オフセット,件数"で指定
最大値 2000,1000
datum
string
default JGD		 入出力座標の測地系を指定
JGD
世界測地系
TOKYO
日本測地系
TOKYO_NAVI
日本測地系(ゼンリン ナビ地図)

Responses

エラーについては「エラーメッセージ一覧」を参照してください。

Media type:application/json

キー名 説明
status
string
 		ステータス
result info hit
integer
 検索結果総数
facet genre_facet
string
number		 facetの指定がある場合のみ出力
値,件数の配列で出力します。
配列最後のペアは指定のジャンルパターンに紐づかないレコードの件数が"NOT_FOUND",件数として含まれます。
例)["05080000_140:140180_[お買い物][コンビニ]",57441,"07020000_170:170130_[金融・郵便局][郵便局]",21766,"NOT_FOUND",31337]
item zid
string		 建物ZID
建物等の地物毎にふられるパーマネントのID
zid_attr
string		 属性ZID
地物内のテナント施設・入居者といった属性情報毎にふられるパーマネントのID
id
string		 ID(地物)
建物ZIDを0パディングし22桁に揃えた文字列
id_attr
string		 ID(属性)
属性ZIDを0パディングし22桁に揃えた文字列
building_name
string		 建物名称
name
string		 施設名称
name_read
string		 施設名称読み
name_read_through
string		 施設名称読み下し
読みと読み下しの違いは以下の通り
・読み  ：英数字は英数字のまま返却
・読み下し：英数字の読みを返却（例：１→イチ、A→エー）
※いずれか、もしくはいずれもnullで返却される場合があります
name_initial_code
string		 施設名称あかさたなコード
  • 0

    あ行

  • 1

    か行

  • 2

    さ行

  • 3

    た行

  • 4

    な行

  • 5

    は行

  • 6

    ま行

  • 7

    や行

  • 8

    ら行

  • 9

    わ行

  • 99

    それ以外
phone_number
string		 電話番号
post_code
string		 郵便番号
address_code
string		 住所コード
address_code1
string		 国コード
address_code2
string		 都道府県コード
address_code3
string		 市区町村コード
address_code4
string		 大字コード
address_code5
string		 字丁目コード
address_detail_code1
string		 街区コード
address_detail_code2
string		 地番戸番コード
address
string		 住所
building_type
integer		 区分
endearing_name_type
integer		 呼び名種別
名称がどのような名称であるかを表す種別
  • 1

    正式名称(公称)

  • 2

    一般名称

  • 3

    通称名称

  • 4

    略称名称

  • 5

    別名称

  • 6

    旧名称

  • 7

    現地名称

  • 8

    短縮名称

  • 9

    組合せ名称

  • 10

    関連名称

  • 99

    その他
language_code
string		 言語コード
"ja"のみ
entrance_point
array[array[number]]		 出入口地点座標
座標の配列(複数点の場合あり)を返却します。
[[経度,緯度],...]
arrival_point
array[array[number]]		 到着地点緯座標
座標の配列(複数点の場合あり)を返却します。
[[経度,緯度],...]
genre_code
string		 ジャンルコード
main_genre_name
string		 メインジャンル名称
施設の属するジャンルを表す。
該当するジャンルが複数存在する場合、すべて返却します。
all_genre_name
string		 ジャンル名称(セミコロン区切り)
施設の属するジャンルを表す。
該当するジャンルが複数存在する場合、複数ジャンル名称を連結して返却します。
position
array[number]
 座標
["経度","緯度"]
distance
number
 検索座標と代表点の直線距離(proximityを指定した場合のみ返却)
building_name_en
string
 建物名称_英語
リクエストパラメータのgenre_patternに1011、1021指定時のみ設定、それ以外はnullを設定します。
building_name_zh_cn
string
 建物名称_中国語簡体
リクエストパラメータのgenre_patternに1012、1022指定時のみ設定、それ以外はnullを設定します。
building_name_zh_tw
string
 建物名称_中国語繁体
リクエストパラメータのgenre_patternに1013、1023指定時のみ設定、それ以外はnullを設定します。
building_name_ko
string
 建物名称_韓国語
リクエストパラメータのgenre_patternに1014、1024指定時のみ設定、それ以外はnullを設定します。
name_en
string
 名称_英語
リクエストパラメータのgenre_patternに1011、1021指定時のみ設定、それ以外はnullを設定します。
name_zh_cn
string
 名称_中国語簡体
リクエストパラメータのgenre_patternに1012、1022指定時のみ設定、それ以外はnullを設定します。
name_zh_tw
string
 名称_中国語繁体
リクエストパラメータのgenre_patternに1013、1023指定時のみ設定、それ以外はnullを設定します。
name_ko
string
 名称_韓国語
リクエストパラメータのgenre_patternに1014、1024指定時のみ設定、それ以外はnullを設定します。
address_en
string
 住所_英語
リクエストパラメータのgenre_patternに1011、1021指定時のみ設定、それ以外はnullを設定します。
address_zh_cn
string
 住所_中国語簡体
リクエストパラメータのgenre_patternに1012、1022指定時のみ設定、それ以外はnullを設定します。
address_zh_tw
string
 住所_中国語繁体
リクエストパラメータのgenre_patternに1013、1023指定時のみ設定、それ以外はnullを設定します。
address_ko
string
 住所_韓国語
リクエストパラメータのgenre_patternに1014、1024指定時のみ設定、それ以外はnullを設定します。

Example

リクエストURL 
https://[domain]/api/zips/general/poi_multi?zis_authtype=ip&zis_authkey=[認証コード]&genre_pattern=1011&word_en=tokyo&limit=0, 1
 レスポンス 
{
  "status": "OK",
  "result": {
    "info": {
      "hit": 5426
    },
    "item": [
      {
        "zid": "307566945446807412",
        "zid_attr": "307486164896658593",
        "id": "0000307566945446807412",
        "id_attr": "0000307486164896658593",
        "building_name": "医療法人社団東京朝日会",
        "name": "医療法人社団東京朝日会",
        "name_read": "",
        "name_read_through": "",
        "name_initial_code": "99",
        "phone_number": "",
        "post_code": "121-0064",
        "address_code": "131210810040004100001",
        "address_code1": "JPN",
        "address_code2": "13",
        "address_code3": "121",
        "address_code4": "081",
        "address_code5": "004",
        "address_detail_code1": "00041",
        "address_detail_code2": "00001",
        "address": "東京都足立区保木間4丁目41-12",
        "building_type": 3,
        "endearing_name_type": 7,
        "language_code": "ja",
        "entrance_point": [
          [
            139.8074647352,
            35.7998448351
          ]
        ],
        "arrival_point": [
          [
            139.8075195313,
            35.799723036
          ]
        ],
        "genre_code": "00160:0016000110; ",
        "main_genre_name": "0016000110:Hospital",
        "all_genre_name": "Hospital/Government Office;Hospital;",
        "position": [
          139.8074891493,
          35.80002469
        ],
        "distance": null,
        "building_name_en": "Tokyo",
        "building_name_zh_cn": null,
        "building_name_zh_tw": null,
        "building_name_ko": null,
        "name_en": "Tokyo",
        "name_zh_cn": null,
        "name_zh_tw": null,
        "name_ko": null,
        "address_en": "TokyoAdachiHokima4-41-12",
        "address_zh_cn": null,
        "address_zh_tw": null,
        "address_ko": null
      }
    ]
  }
}