ガソリンスタンド検索

/gas_station [GET]

基本情報

概要

住所コードや緯度経度を指定して条件に合致するガソリンスタンドを検索します。
※当APIをご利用の場合は、専用データ利用のオプション契約が別途必要となります

URL

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

※RapidAPIでは提供しておりません

出力形式

  • JSON

対応言語

  • ja, en, ko, zh-CN, zh-TW, th

出力順

  • スポットコードの昇順
  • 緯度経度を指定した場合は指定緯度経度からの距離昇順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
address (✔) 住所コード 文字列 大字レベル(11桁末尾0)まで指定可能
addressもしくはcoordのどちらかもしくは両方を必ず指定してください
coord (✔) 検索基点 カンマ区切りの数値 検索を行う基準地点の緯度経度
・「緯度,経度」の順で指定
・ミリ秒表記、度表記(10進数)に対応
addressもしくはcoordのどちらかもしくは両方を必ず指定してください
radius 検索範囲(単位:m) 数値 2000 最大値:5000 coord指定時のみ使用可能
type ガソリンスタンドの種類 文字列 full:フルサービス
self:セルフサービス
ピリオド区切りで複数指定可能
has_gas_price ガソリン価格データの有無  真偽値  true:データがあるガソリンスタンドのみ出力
false:データがないガソリンスタンドも含めて出力
options 追加出力情報 文字列 exact_coord:スポット到着地点
detail:詳細情報
opening_hours:営業時間情報
追加で出力する情報
・ピリオド区切りで複数指定可能
※exact_coordはD2Dオプション申込時のみ利用可能
limit データの出力件数 数値 10 最小値:1
最大値:30
ガソリンスタンドデータの出力数
offset データの出力開始位置 数値 0 最小値:0
最大値:2000
何件目から表示されるか(1件目が0)を指定します
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記
lang 言語 文字列 ja: 日本語
en: 英語
ko: 韓国語
zh-CN: 中国語(簡体字)
zh-TW: 中国語(繁体字)
th: タイ語
出力する言語を指定します
・ピリオド区切りで複数指定可能
※多言語オプション申込時のみ利用可能

radiusの検索範囲について

radiusパラメータにて検索範囲を指定した場合、coordを中心とした四角範囲内で検索が行われます。
そのため、一部指定範囲外のガソリンスタンドが出力される可能性があります。

addressとcoordを両方指定した場合の挙動について

addressとcoordを両方指定した場合の検索方法はAND検索となります。
そのため、coordにて指定した検索範囲内かつaddressにて指定した住所コードに該当するガソリンスタンドが検索されます。

langパラメータの指定時の注意点

・多言語に対応したレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。
・一部スポットは多言語データが存在しないため、多言語指定時に値が返却されない場合があります。

パラメータ構成例

  • 都内かつセルフサービスのガソリンスタンドを5件検索
/gas_station?address=13&type=self&limit=5

レスポンス

名称 レスポンス名 型名 配列 説明
検索数 count Countオブジェクト レスポンスのヒット数などの情報
スポット情報 items Spotオブジェクト スポット情報(ガソリンスタンド)のまとまり
単位情報 unit Unitオブジェクト 出力される単位の情報

Countオブジェクト

名称 レスポンス名 型名 配列 説明
トータルヒット件数 total 数値 検索ヒットした件数
オフセット値 offset 数値 オフセットが設定されている場合はその値を出力
データの出力件数 limit 数値 データの出力件数に設定されている値
1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

Spotオブジェクト

名称 レスポンス名 型名 配列 説明
スポットコード code 文字列
スポット名 name 文字列/Multilingualオブジェクト langパラメータ指定時は、Multilingualオブジェクトで出力
電話番号 phone 文字列
住所コード address_code 文字列
住所の表示名 address_name 文字列/Multilingualオブジェクト langパラメータ指定時は、Multilingualオブジェクトで出力
緯度経度 coord Coordinateオブジェクト
距離(単位:m) distance 数値 検索基点からの距離
パラメータ「coord」指定時のみ出力
郵便番号 postal_code 文字列
カテゴリ一覧 categories Categoryオブジェクト
詳細情報 details SpotDetailオブジェクト パラメータ「options=detail」指定時かつデータが存在する場合のみ出力
出力優先度を考慮してソートされています
スポット到着地点の緯度経度 exact_coord SpotExactCoordオブジェクト パラメータ「options=exact_coord」指定時かつデータが存在する場合のみ出力
営業時間情報 opening_hours SpotOpeningHoursオブジェクト パラメータ「options=opening_hours」指定時かつデータが存在する場合のみ出力

Multilingualオブジェクト

名称 レスポンス名 型名 配列 説明
英語名称 en 文字列
日本語名称 ja 文字列
韓国語名称 ko 文字列
タイ語名称 th 文字列
中国語(簡体字)名称 zh-CN 文字列
中国語(繁体字)名称 zh-TW 文字列

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
スポットの緯度 lat 数値
スポットの経度 lon 数値

Categoryオブジェクト

名称 レスポンス名 型名 配列 説明
カテゴリコード code 文字列
カテゴリ名 name 文字列/Multilingualオブジェクト langパラメータ指定時は、Multilingualオブジェクトで出力
カテゴリ名の読み仮名 ruby 文字列/Multilingualオブジェクト langパラメータ指定時は、Multilingualオブジェクトで出力
ただし"ja"を含む場合のみ返却(日本語のみ)
カテゴリコードのレベル level 文字列 large, middle, small, detail の4階層

SpotDetailオブジェクト

名称 レスポンス名 型名 配列 説明
テキスト情報 texts TextItemオブジェクト データが存在する場合のみ出力
日付情報 dates TextItemオブジェクト データが存在する場合のみ出力
ガソリン料金情報 fuel_price FuelPriceオブジェクト データが存在する場合のみ出力

TextItemオブジェクト

名称 レスポンス名 型名 配列 説明
見出し label 文字列 langパラメータ指定時は、1番目にjaを指定した場合のみ返却(日本語のみ)
文字列値 value 文字列 langパラメータ指定時は、1番目にjaを指定した場合のみ返却(日本語のみ)

FuelPriceオブジェクト

名称 レスポンス名 型名 配列 説明
レギュラー通常価格 regular 数値 データに入っている場合のみ出力
ハイオク通常価格 high_octane 数値 データに入っている場合のみ出力
軽油通常価格 diesel 数値 データに入っている場合のみ出力
灯油通常価格 kerosene 数値 データに入っている場合のみ出力
レギュラー会員価格 member_regular 数値 データに入っている場合のみ出力
ハイオク会員価格 member_high_octane 数値 データに入っている場合のみ出力
軽油会員価格 member_diesel 数値 データに入っている場合のみ出力
灯油会員価格 member_kerosene 数値 データに入っている場合のみ出力
レギュラー通常価格が更新された日付 regular_update_time 数値 データに入っている場合のみ出力
ハイオク通常価格が更新された日付 high_octane_update_time 数値 データに入っている場合のみ出力
軽油通常価格が更新された日付 diesel_update_time 数値 データに入っている場合のみ出力
灯油通常価格が更新された日付 kerosene_update_time 数値 データに入っている場合のみ出力
レギュラー会員価格が更新された日付 member_regular_update_time 数値 データに入っている場合のみ出力
ハイオク会員価格が更新された日付 member_high_octane_update_time 数値 データに入っている場合のみ出力
軽油会員価格が更新された日付 member_diesel_update_time 数値 データに入っている場合のみ出力
灯油会員価格が更新された日付 member_kerosene_update_time 数値 データに入っている場合のみ出力

SpotExactCoordオブジェクト

名称 レスポンス名 型名 配列 説明
車向け到着地点緯度経度 car SpotExactCoordPointオブジェクト データに入っている場合のみ出力
徒歩向け到着地点緯度経度 walk SpotExactCoordPointオブジェクト データに入っている場合のみ出力

SpotExactCoordPointオブジェクト

名称 レスポンス名 型名 配列 説明
地点名称 name 文字列/Multilingualオブジェクト langパラメータ指定時は、Multilingualオブジェクトで出力
緯度経度 coord Coordinateオブジェクト
識別番号 seq 数値 ・地点名称が同一の場合があり、その識別用

識別番号について

識別番号は、1つの到着地点緯度経度に対し任意の番号を割り当てております。
同じ緯度経度でこの番号が変わることはございません。また、同じスポット内で番号が重複することもございません。
今後、到着地点緯度経度の地点名称の変更や、到着地点緯度経度が追加・削除となる場合もございますので、差分確認などにご利用ください。

SpotOpeningHoursオブジェクト

名称 レスポンス名 型名 配列 説明
指定した時間の営業フラグ open 真偽値 true:現在時刻が営業時間内の場合
false: 現在時刻が営業時間外の場合
24時間営業であることを示すフラグ open24h 真偽値 24時間営業であればtrue
営業時間情報一覧 schedule SpotOpeningHoursScheduleオブジェクト

SpotOpeningHoursScheduleオブジェクト

名称 レスポンス名 型名 配列 説明
曜日ID day_id 文字列 01:月曜日
02:火曜日
03:水曜日
04:木曜日
05:金曜日
06:土曜日
07:日曜日
11:祝日
休業日フラグ close 真偽値 休業日であればtrue
休業日が不明の場合は表示されません
指定した日時に該当する曜日を示すフラグ applied 真偽値 現在日時に該当する曜日のオブジェクトだった場合にtrueが出力されます
該当する曜日以外の場合は表示されません
営業時間 periods SpotOpeningHoursPeriodオブジェクト

SpotOpeningHoursPeriodオブジェクト

名称 レスポンス名 型名 配列 説明
営業開始時間 open_time 文字列
営業終了時間 close_time 文字列

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
緯度経度の測地系 datum 文字列
緯度経度の出力形式 coord_unit 文字列

レスポンス例

{
    "count": {
        "total": 29,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "code": "07013-0000000043",
            "name": "エネクスフリート 東保木間店【提携店】",
            "phone": "0338507405",
            "address_name": "東京都足立区東保木間2-2-2",
            "address_code": "13121076000",
            "coord": {
                "lat": 35.792301,
                "lon": 139.810642
            },
            "postal_code": "1210063",
            "categories": [
                {
                    "code": "0801001020",
                    "name": "エネクスフリート",
                    "ruby": "えねくすふりーと",
                    "level": "detail"
                },
                {
                    "code": "0801001",
                    "name": "ガソリンスタンド",
                    "ruby": "がそりんすたんど",
                    "level": "small"
                },
                {
                    "code": "0801",
                    "name": "ガソリンスタンド",
                    "ruby": "がそりんすたんど",
                    "level": "middle"
                },
                {
                    "code": "08",
                    "name": "交通",
                    "ruby": "こうつう",
                    "level": "large"
                }
            ]
        },
        ・・・
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}

レスポンス例(多言語返却時 ※lang=ja.en.ko指定)

{
    "count": {
        "total": 29,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "code": "07013-0000000043",
            "name": {
                "en": "Enex Fleet Higashi-hokima 【 partner store 】",
                "ja": "エネクスフリート 東保木間店【提携店】",
                "ko": "에넥스플리트 히가시호키마 점 【 제휴 점 】"
            },
            "phone": "0338507405",
            "address_name": {
                "en": "Tokyo Adachi-ku Higashi-hokima 2-2-2",
                "ja": "東京都足立区東保木間2-2-2",
                "ko": "도쿄도 아다치구 히가시호키마 2-2-2"
            },
            "address_code": "13121076000",
            "coord": {
                "lat": 35.792301,
                "lon": 139.810642
            },
            "postal_code": "1210063",
            "categories": [
                {
                    "code": "0801001020",
                    "name": {
                        "en": "Enex Fleet",
                        "ja": "エネクスフリート",
                        "ko": "에넥스플리트"
                    },
                    "ruby": {
                        "ja": "えねくすふりーと"
                    },
                    "level": "detail"
                },
                {
                    "code": "0801001",
                    "name": {
                        "en": "Gas Station",
                        "ja": "ガソリンスタンド",
                        "ko": "주유소"
                    },
                    "ruby": {
                        "ja": "がそりんすたんど"
                    },
                    "level": "small"
                },
                {
                    "code": "0801",
                    "name": {
                        "en": "Gas Station",
                        "ja": "ガソリンスタンド",
                        "ko": "주유소"
                    },
                    "ruby": {
                        "ja": "がそりんすたんど"
                    },
                    "level": "middle"
                },
                {
                    "code": "08",
                    "name": {
                        "en": "Transportation",
                        "ja": "交通",
                        "ko": "교통"
                    },
                    "ruby": {
                        "ja": "こうつう"
                    },
                    "level": "large"
                }
            ]
        },
        ・・・
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}