交通機関会社エリア検索

/transport_company/address [GET]

基本情報

概要

住所コードに合致する交通機関会社の一覧を取得します。

URL

https://{HOST}/{CID}/v1/transport_company/address

※APIマーケットの場合はURL体系が異なります

出力形式

• JSON

対応言語

• ja

出力順

• 交通機関会社IDで昇順

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
address	✔	住所コード	文字列			都道府県レベル（2桁）のみ指定可能です
type		出力する交通機関	文字列		交通機関タイプより指定	ピリオド区切りで複数指定できます 出力する交通機関会社の種別を限定したい場合にご利用ください（未指定の場合は全種別が検索されます） ※バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可)
offset		データの出力開始位置	数値	0	最小値：0 最大値：1000	何件目から表示されるか（1件目が0）を指定します
limit		データの出力件数	数値	10	最小値：1 最大値：100	交通機関会社データの出力件数

type（交通機関タイプ）

'type' は以下の文字列を取り得ます。

文字列	概要	備考
train	鉄道
airplane	飛行機
ferry	フェリー
shuttle_bus	空港連絡バス
bus	路線バス
highway_bus	高速バス

パラメータ構成例

• 東京都の路線を運営する鉄道会社を10件検索

/transport_company/address?address=13&type=train

レスポンス

名称	レスポンス名	型名	配列	説明
検索数	count	Countオブジェクト
公共交通機関の運行会社情報	items	Companyオブジェクト	〇

Countオブジェクト

名称	レスポンス名	型名	配列	説明
トータルヒット件数	total	数値		検索ヒットした件数
オフセット値	offset	数値		オフセットが設定されている場合はその値を出力
データの出力件数	limit	数値		データの出力件数に設定されている値

Companyオブジェクト

名称	レスポンス名	型名	配列	説明
運行会社ID	id	文字列
運行会社の名称	name	文字列

レスポンス例

{
    "count": {
        "total": 20,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "id": "00000003",
            "name": "ＪＲ東海"
        },
        {
            "id": "00000004",
            "name": "ＪＲ東日本"
        },
        {
            "id": "00000011",
            "name": "ゆりかもめ"
        },
        {
            "id": "00000035",
            "name": "京王電鉄"
        },
        ・・・
    ]
}