フライト情報検索

/flight [GET]

基本情報

概要

出発/到着空港IDを指定してフライト情報を取得します。
※当APIをご利用の場合は、時刻表データ利用のオプション契約が別途必要となります

URL

https://{HOST}/{CID}/v1/flight

※APIマーケットでは提供しておりません

出力形式

JSON

対応言語

ja

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	備考
departure	✔	出発空港ノードID	文字列		arraivalパラメータと同じ値は指定できません詳細はこちらをご覧ください
arrival	✔	到着空港ノードID	文字列		departureパラメータと同じ値は指定できません詳細はこちらをご覧ください
date		検索対象の日付	文字列(日付) YYYY-MM-DD	当日日付	当日以降の日付が指定できます。過去日付は指定できません。

departure・arrivalの指定方法について

必須パラメータの指定方法は以下の通りです。
‧出発/到着ノードID（departure/arrival）：「駅/バス停名検索API（/transport_node)」のレスポンスにて返却される「駅/バス停のノードID(id)」を指定してください。この時、リクエストパラメータに"type=airport"を付与してリクエストしてください。

羽田空港のノードIDを取得したい場合

/v1/transport_node?word=羽田空港&type=airport

パラメータ構成例

新千歳空港から羽田空港へのフライト情報を検索(当日)

/flight?departure=00004286&arrival=00000592

新千歳空港から羽田空港へのフライト情報を検索(2024年5月31日)

/flight?departure=00004286&arrival=00000592&date=2024-05-31

レスポンス

名称	レスポンス名	型名	配列
出発空港情報	departure	Airportオブジェクト
到着空港情報	arrival	Airportオブジェクト
フライト情報	items	Flightオブジェクト	◯

Airportオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
空港ノードID	id	文字列
空港名	name	文字列

Flightオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
フライトID	id	文字列			フライトを識別するID
便名	flight_number	文字列			3レターコード + 数字
出発時刻	departure_time	文字列(日付時刻)
出発時刻	arrival_time	文字列(日付時刻)
コードシェア便	code_sharing	CodeSharingオブジェクト	◯	nullable

CodeSharingオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
便名	flight_number	文字列			フライトを識別するID

レスポンス例

{
    "departure_node": {
        "id": "00004286",
        "name": "新千歳空港"
    },
    "arrival_node": {
        "id": "00000592",
        "name": "羽田空港（空路）"
    },
    "items": [
        {
            "id": "01970000",
            "flight_number": "ADO12",
            "departure_time": "2024-01-01T08:00:00+09:00",
            "arrival_time": "2024-01-01T09:35:00+09:00",
            "code_sharing": [
                {
                    "flight_number": "ANA4712",
                },
                ・・・
            ]
        },
        ・・・
    ]
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: departure: ['required field']	必須パラメータである departure が指定されていない、または空文字の場合に発生します。
400	parameter error: arrival: ['required field']	必須パラメータである arrival が指定されていない、または空文字の場合に発生します。
400	parameter error: departure: ['an invalid code: {value}']	departure に不正なノードIDを指定した場合に発生します。
400	parameter error: arrival: ['an invalid code: {value}']	arrival に不正なノードIDを指定した場合に発生します。
400	parameter error: date: ['an invalid date: {value}']	date に不正な書式の日付を指定した場合に発生します。
400	parameter error: date: ['not date format : {value}']	date に実在しない日付を指定した場合に発生します。
400	parameter error: date: ['an invalid value : {value}']	date に過去の日付を指定した場合に発生します。
400	departure and arrival are invalid parameter combination.	departure と arrival に同じノードIDを指定した場合に発生します。
400	Invalid departure	departure に存在しないノードID、または国内空港以外のノードIDを指定した場合に発生します。
400	Invalid arrival	arrival に存在しないノードID、または国内空港以外のノードIDを指定した場合に発生します。
400	bad usage on this contract　:　use_company and unuse_company must be either.	利用対象運行会社の設定に不整合がある場合に発生します。