共通出力フォーマット

各API共通で用いられる出力フォーマットです。

ステータス情報

API実行結果のステータス情報を示します。

[フォーマット概略]

{"code":string,
"text":string}

[フォーマット詳細]

キー名

データ型

説明

code

string

ステータスコードが入ります。

0000	正常終了
0001	タイムアウトが発生またはデータサイズが制限値を超えたため処理が中断された

text

string

ステータス内容に関するテキスト情報が入ります

[出力例]

{"code":"0000",
"text":"OK"}

緯度経度(latlon)

緯度経度の出力フォーマットです。クエリパラメータ llunit で緯度経度の単位を指定できます。

[フォーマット概略]

{"lat":number,
"lon":number}

[フォーマット詳細]

キー名	データ型	説明
lat	number	緯度が入ります
lon	number	経度が入ります

[出力例]

{"lat":35.6797777,
"lon":139.77165}

住所(Address)

住所データの出力フォーマットです。

[フォーマット概略]

{"text": string,
"code": string,
"point": LatLon,
"parts":[ string, ...],
"kana": string,
"zipcode": string,
"end": boolean,
"bounds": LLBounds,
"kanaParts": [ string, ...],
"level": string,
"language": object}

[フォーマット詳細]

キー名

データ型

説明

text

string

住所表記文字列が入ります。

code

string

住所コードが入ります。

point

object

代表点緯度経度が入ります。

parts

array

住所階層毎に分割された文字列(string型)の配列が入ります。

kana

string

住所読み仮名が入ります。大文字（促音、拗音なし）で出力されます。

zipcode

string

郵便番号が入ります。データがない場合は null となります。

end

boolean

住所にさらに下の階層がある場合は false, そうでない場合は trueが入ります。
不明の場合は null となります。

bounds

object

行政界ポリゴンの緯度経度矩形範囲が入ります。
データは街区までで、街区以上の住所でもない場合があります。
データがない場合は null となります。行政界ポリゴンデータは住宅地図ベースのものしか
ないため、データ更新時期によっては住所とずれる場合があります。

kanaParts

array

住所階層毎に分割された住所読み仮名(string型)の配列が入ります。

level

string

住所階層コードが入ります。

language

object

翻訳住所のオブジェクトが入ります。

キー名		データ型	説明
en		object	英語翻訳住所データが入ります。
	text	string	英語住所表記文字列が入ります。
	parts	array	英語分割住所文字列(string型)の配列が入ります。
zh-cn		object	中国語簡体翻訳住所データが入ります。
	text	string	中国語簡体住所表記文字列が入ります。
	parts	array	中国語簡体分割住所文字列(string型)の配列が入ります。
zh_tw		object	中国語繁体翻訳住所データが入ります。
	text	string	中国語繁体住所表記文字列が入ります。
	parts	array	中国語繁体分割住所文字列(string型)の配列が入ります。
ko		object	韓国語翻訳住所データが入ります。
	text	string	韓国語住所表記文字列が入ります。
	parts	array	韓国語分割住所文字列(string型)の配列が入ります。

翻訳データの整備状況によって、一部翻訳データが存在しない場合があります。その際は text, parts の値とも null となります。
APIによっては翻訳データに対応していない場合があります。その際は language の値が常に null となります。

[出力例]

{"text":"東京都千代田区丸の内１丁目９‐１",
"code":"131010550010000900001",
"point":{"lat":35.6797778,
"lon":139.77165},
"parts":["東京都","千代田区","丸の内","１丁目","９","１"],
"kana":"トウキヨウトチヨダクマルノウチ",
"zipcode":"105-0004",
"end":null,
"bounds":null,
"kanaParts":["トウキヨウト","チヨダク","マルノウチ","","",""],
"level":"tbn",
"language":{"en":{"text":"TokyoMet. Chiyodaku Marunouchi 1-9-1",
"parts":["TokyoMet.","Chiyodaku","Marunouchi","1","9","1"]},
"zh-cn":{"text":"东京都千代田区丸之内 1-9-1",
"parts":["东京都","千代田区","丸之内","1","9","1"]},
"zh-tw":{"text":"東京都千代田區丸之内 1-9-1",
"parts":["東京都","千代田區","丸之内","1","9","1"]},
"ko":{"text":"도쿄도 치요다쿠 마루노우치 1-9-1",
"parts":["도쿄도","치요다쿠","마루노우치","1","9","1"]}}}

POI情報(POI)

POI情報データの出力フォーマットです。

[フォーマット概略]

{"text": string,
"code": string,
"point": LatLon,
"kana": string,
"addressText": string,
"zipcode": string,
"phoneNumber": string,
"genre":{"code": string,
"text": string},
"detail":{"areaid": string,
"areaname": string,
"detailid": string,
"detailname": string,
"floorname": string,
"level": string},
"language":{"zh-cn":{"text": string,
"addressParts": [ string, ...],
"genre": string},
"zh-tw":{"text": string,
"addressParts": [ string, ...],
"genre": string},
"en":{"text": string,
"addressParts": [ string, ...],
"genre": string},
"ko":{"text": string,
"addressParts": [ string, ...],
"genre": string}},
"arrivalInfo":[{"text": string,
"kana": string,
"exittype":{"code": string,
"text": string},
"arrivalpoint": LatLon,
"exitpoint": LatLon} ...] }

[フォーマット詳細]

キー名

データ型

説明

text

string

POI表記文字列が入ります。

code

string

POIコードが入ります。

point

object

代表点緯度経度が入ります。

kana

string

POI名称仮名が入ります。

addressText

string

住所テキストが入ります。

zipcode

string

郵便番号が入ります。

phoneNumber

string

電話番号が入ります。

genre

object

ジャンル情報が入ります。

code

string

ジャンルコードが入ります。
・ジャンルコード一覧(Excel)

text

string

ジャンル名称が入ります。

detail

object

詳細図情報が入ります。

areaid

string

エリアIDが入ります。

areaname

string

エリア名称が入ります。

detailid

string

詳細図番号が入ります。

detailname

string

詳細図名称が入ります。

floorname

string

フロア名称が入ります。

level

string

階層レベルが入ります。

language

object

翻訳情報のオブジェクトが入ります。 ※出力には別途契約が必要です。

キー名		データ型	説明
en		object	英語翻訳データが入ります。
	text	string	英語POI名称文字列が入ります。
	addressParts	array	英語分割住所文字列(string型)の配列が入ります。
	genre	string	英語ジャンル名称文字列が入ります。
zh-cn		object	中国語簡体翻訳データが入ります。
	text	string	中国語簡体POI名称文字列が入ります。
	addressParts	array	中国語簡体分割住所文字列(string型)の配列が入ります。
	genre	string	中国語簡体ジャンル名称文字列が入ります。
zh-tw		object	中国語繁体翻訳データが入ります。
	text	string	中国語繁体POI名称文字列が入ります。
	addressParts	array	中国語繁体分割住所文字列(string型)の配列が入ります。
	genre	string	中国語繁体ジャンル名称文字列が入ります。
ko		object	韓国語翻訳データが入ります。
	text	string	韓国語POI名称文字列が入ります。
	addressParts	array	韓国語分割住所文字列(string型)の配列が入ります。
	genre	string	韓国語ジャンル名称文字列が入ります。

arrivalInfo

array

到着地点情報のオブジェクトが配列に入ります。

キー名

データ型

説明

text

string

到着地点名称が入ります。

kana

string

到着地点カナが入ります。

exittype

object

到着地点出入口種別が入ります。

code

string

種別コードが入ります。

01	入口
02	出口
03	出入口
11	地下鉄出入口
99	未調査

text

string

種別名称が入ります。

arrivalpoint

object

自動車の到着地点緯度経度が入ります。

exitpoint

object

出入口緯度経度が入ります。
※到着地点出入口種別が未調査の場合は、自動車の到着地点緯度経度が入ります。

[出力例]

"item":[{"text":"スターバックスコーヒーJR東京駅日本橋口店",
"code":"30000000000000008160",
"point":{"lat":35.6799667,
"lon":139.7723056},
"kana":"スターバックスコーヒージェイアールトウキョウエキニホンバシグチテン",
"addressText":"東京都千代田区",
"zipcode":null,
"phoneNumber":null,
"genre":{"code":"0024000140",
"text":"グルメ/その他グルメ"},
"detail":{"areaid":"003",
"areaname":"東京・有楽町・銀座・新橋エリア",
"detailid":"00000005",
"detailname":"ＪＲ東京駅",
"floorname":"２階",
"level":"1"},
"language":{"zh-cn":{"text":"星巴克咖啡",
"addressParts":["东京都","千代田区","丸之内","1丁目","9","1"],
"genre":"美食/其他美食"},
"zh-tw":{"text":"星巴克咖啡",
"addressParts":["東京都","千代田区"],
"genre":"美食/其他美食"},
"en":{"text":"Starbucks Coffee",
"addressParts":["Tokyo","Chiyoda-ku"],
"genre":"Gourmet/Other Gourmet"},
"ko":{"text":"스타벅스 커피",
"addressParts":["도쿄도","치요다구","마루노우치","1쵸메","9","1"],
"genre":"구루메(맛집)/기타 구루메(맛집)"}},
"arrivalInfo":[{"text":"丸の内北口",
"kana":"マルノウチキタグチ",
"exittype":{"code":"03",
"text":"出入口"},
"arrivalpoint":{"lat":35.6792861,
"lon":139.7690667},
"exitpoint":{"lat":35.6790528,
"lon":139.7693667}}
...]

LLPolyline

緯度経度ポリラインの出力フォーマットです。クエリパラメータ llunit で形式を指定できます。

[フォーマット]

[number, number,...] //緯度、経度が交互に入る

[出力例]

[35.6798356,139.7656267,35.6799622,139.7656267,35.6799867,139.7657244, ...]

路線情報

路線情報の出力フォーマットです。

[フォーマット概略]

{"code":string,
"text":string,
"corp":string}

[フォーマット詳細]

キー名	データ型	説明
code	string	路線コードが入ります。
text	string	路線名称が入ります
corp	string	必ず NULL が入ります。

[出力例]

{"code":"4",
"text":"山手線",
"corp":null}

緯度経度矩形範囲

緯度経度矩形範囲の出力フォーマットです。

[フォーマット概略]

{"sw":LatLon,
"ne":LatLon}

[フォーマット詳細]

キー名	データ型	説明
sw	object	南西緯度経度が入ります。
ne	object	北東緯度経度が入ります

[出力例]

{"sw":{"lat":35.6062497,
"lon":139.65167),
"ne":{"lat":35.7500397,
"lon":139.886963)}

multi/poiフラグ情報

個別出力結果にあるフラグ情報を示します。

[フォーマット概略]

{"**Flg":string}

[フォーマット詳細]

キー名

データ型

説明

**Flg

string

フラグ情報が返却されます。

NULL	未調査または整備対象外
0	なし
1	あり

[出力例]

{"content_data":[{"***Flg":NULL,
"***Flg":"0"
"***Flg":"1"}

道路リンク情報(LinkDrive)

自動車ネットワークデータ情報を示します。

[フォーマット概略]

{"code":string,
"distance":number,
"line":llPolyline,
"order":string,
"roadType":{"code":string,
"text":string},
"limitedHighway":boolean,
"numberOfLanes":number,
"roadWidth":number,
"linkSeparation":boolean,
"structure":string,
"zlinkCode":string}

[フォーマット詳細]

キー名

データ型

説明

code

string

リンクIDが入ります。

distance

number

リンク距離(メートル)が入ります。

line

array

緯度経度ポリラインが入ります。

order

string

リンク形状座標の格納順序(進行方向)をあらわすコードが入ります。

OE	順方向
EO	逆方向

roadType

object

道路種別が入ります。

code

string

種別コードが入ります。

text

string

種別名称が入ります。

limitedHighway

boolean

自動車専用道路かどうかの判定が入ります。

true	自動車専用道路
false	自動車専用道路でない
null	不明

numberOfLanes

number

車線数情報が入ります。
そのリンクに含まれる車線数(上下線分離したリンクの場合は片側だけの車線、
分離していないリンクの場合は両側合計の車線)が入ります。
不明の場合nullが入ります。

1	1車線
2	2車線または3車線
4	4車線以上

roadWidth

number

道路幅員情報が入ります。
不明の場合nullが入ります。

0	幅員3.0m未満
1	幅員3.0m以上5.5m未満
2	幅員5.5m以上13.0m未満
3	幅員13.0m以上

linkSeparation

boolean

上下線分離フラグが入ります。

true	上下線を分離して上り／下りを別々のリンク列で表現した道路
false	上下線を分離せず上り／下りを一つのリンク列で表現した道路

structure

string

リンクの構造情報が入ります。
データなしの場合は null となります。

TUNNEL

当該リンクがトンネルであることを示します。

zlinkCode

string

ZリンクIDが入ります。

[出力例]

{"code":"2044102",
"distance":44,
"line":[35.6750741,139.7726894,35.675435,139.772910],
"order":"OE",
"roadType":{"code":"6",
"text":"一般道路(その他)"},
"limitedHighway":false,
"numberOfLanes":2,
"roadWidth":2,
"linkSeparation":false,
"structure":"TUNNEL"}

道路リンク情報(LinkWalk)

歩行者ネットワークデータ情報を示します。

[フォーマット概略]

{"code":string,
"distance":number,
"line":llPolyline}

[フォーマット詳細]

キー名	データ型	説明
code	string	リンクIDが入ります。
distance	number	リンク距離(メートル)が入ります。
line	array	緯度経度ポリラインが入ります

[出力例]

{"code":"2044102",
"distance":44,
"line":[35.6750741,139.7726894,35.675435,139.772910]}