Query for gas stations

GET /gas-stations

There are two ways to search for gas stations in a geo location. You can use either one, or none, but not both ways.

To search inside a specific radius around a given longitude and latitude provide the following query parameters:

  • latitude
  • longitude
  • radius

To search inside a bounding box provide the following query parameter:

  • boundingBox

Query parameters

  • page[number] integer

    page number

  • page[size] integer

    items per page

  • filter[appType] array[string]

    Search only gas stations with fueling app available

    Value is fueling.

  • filter[latitude] number(float)

    Latitude in degrees

    Minimum value is -85, maximum value is 85.

  • filter[longitude] number(float)

    Longitude in degrees

    Minimum value is -180, maximum value is 180.

  • filter[radius] number(float)

    Radius in meters

    Minimum value is 0.

  • filter[boundingBox] array[number(float)]

    Bounding box representing left, bottom, right, top in degrees. The query parameters need to be passed 4 times in exactly the order left, bottom, right, top.

    #ValueLat/LongRange
    0leftLat[-180..180]
    1bottomLong[-90..90]
    2rightLat[-180..180]
    3topLong[-90..90]
  • filter[paymentMethod] string

    Comma separated strings that filter stations according to supported payment methods.

Responses

  • 200 application/vnd.api+json

    OK

    Hide response attributes Show response attributes object
    • data array[object]
      Hide data attributes Show data attributes object
      • type string

        Value is gasStation.

      • id string(uuid)

        Gas Station ID

      • attributes object

        Additional properties are allowed.

        Hide attributes attributes Show attributes attributes object
        • latitude number(float)
        • longitude number(float)
        • stationName string
        • brand string
        • brandID string
        • onlinePayment object

          Additional properties are allowed.

          Hide onlinePayment attributes Show onlinePayment attributes object
          • online boolean

            Values are true or false.

          • paymentMethods array[string]
        • address object

          Additional properties are allowed.

          Hide address attributes Show address attributes object
          • street string
          • houseNo string
          • postalCode string
          • city string
          • countryCode string

            Country code in as specified in ISO 3166-1.

        • contact object

          Additional properties are allowed.

          Hide contact attributes Show contact attributes object
          • firstName string
          • lastName string
          • gender string

            Values are m, f, or o.

          • email string
          • phoneNumber string
          • faxNumber string
        • openingHours object

          Additional properties are allowed.

          Hide openingHours attributes Show openingHours attributes object
          • timezone string

            As defined by ISO 8601, the timezone

          • rules array[object]
            Hide rules attributes Show rules attributes object
            • action string

              Values are open or close. Default value is open.

            • days array[string]

              Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.

            • timespans array[object]
              Hide timespans attributes Show timespans attributes object
              • from string

                relative to the specified time zone (local time)

              • to string

                relative to the specified time zone (local time)

        • postalServices array[string]
        • services array[string]
        • shopGoods array[string]
        • loyaltyPrograms array[string]
        • food array[string]
        • amenities array[string]
        • paymentMethods array[string]
        • priceFormat string
        • references array[string]

          References are PRNs to external and internal resources that are represented by this poi

      • relationships object

        Additional properties are allowed.

        Hide relationships attributes Show relationships attributes object
        • fuelPrices object

          Additional properties are allowed.

          Hide fuelPrices attribute Show fuelPrices attribute object
          • data array[object]
            Hide data attributes Show data attributes object
            • type string

              Value is fuelPrice.

            • id string(uuid)

              Fuel Price ID

        • locationBasedApps object

          Additional properties are allowed.

          Hide locationBasedApps attribute Show locationBasedApps attribute object
          • data array[object]
            Hide data attributes Show data attributes object
            • type string

              Value is locationBasedApp.

            • id string(uuid)

              Location-based app ID

        • referenceStatuses object

          Additional properties are allowed.

          Hide referenceStatuses attribute Show referenceStatuses attribute object
          • data array[object]
            Hide data attributes Show data attributes object
            • type string

              Value is referenceStatus.

            • id string(uuid)

              Service Provider resource PRN

        • sucessorOf object

          Additional properties are allowed.

          Hide sucessorOf attribute Show sucessorOf attribute object
          • data array[object]
            Hide data attributes Show data attributes object
            • type string

              Value is gasStation.

            • id string(uuid)

              GasStation ID which was superseded by this gas station

    • included array[object]
      One of: