Query for gas stations

GET /gas-stations

OAuth2 Oidc

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.

# Value Lat/Long Range

0 left Lat [-180..180]

1 bottom Long [-90..90]

2 right Lat [-180..180]

3 top Long [-90..90]
filter[paymentMethod] string

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

#	Value	Lat/Long	Range
0	left	Lat	[-180..180]
1	bottom	Long	[-90..90]
2	right	Lat	[-180..180]
3	top	Long	[-90..90]

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
  
  Hide attributes attributes Show attributes attributes object
  
  latitude number(float)
  
  longitude number(float)
  
  stationName string
  
  brand string
  
  brandID string
  
  onlinePayment object
  
  Hide onlinePayment attributes Show onlinePayment attributes object
  
  online boolean
  
  Values are true or false.
  
  paymentMethods array[string]
  
  address object
  
  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
  
  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
  
  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
  
  Hide relationships attributes Show relationships attributes object
  
  fuelPrices object
  
  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
  
  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
  
  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
  
  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:
  FuelPrice object LocationBasedApp object ReferenceStatus object
  
  Hide attributes Show attributes
  
  type string
  
  Fuel price
  
  Value is fuelPrice.
  
  id string(uuid)
  
  Fuel Price ID
  
  attributes object
  
  Hide attributes attributes Show attributes attributes object
  
  fuelType string
  
  Fuel type for cars, based on the EU fuel marking
  
  price number(decimal)
  
  per liter
  
  currency string
  
  Currency as specified in ISO-4217.
  
  Format should match the following pattern: ^[A-Z]{3}$.
  
  productName string
  
  updatedAt string(date-time)
  
  Time of FuelPrices last update iso8601 with microseconds UTC
  
  Hide attributes Show attributes
  
  type string
  
  Type
  
  Value is locationBasedApp.
  
  id string(uuid)
  
  Location-based app ID
  
  attributes object
  
  Hide attributes attributes Show attributes attributes object
  
  appType string
  
  Value is fueling.
  
  title string
  
  subtitle string
  
  logoUrl string
  
  Logo URL
  
  pwaUrl string
  
  Progressive web application URL. The URL satisfies the following criteria:
  The URL responds with text/html on a GET request
  
  The response contains HTTP caching headers e.g. Cache-Control and ETag
  
  HTTP GET request on the URL with an ETag will return 304 (Not Modified), if the content didn't change
  
  If 503 (Service Unavailable) is returned the request should be retried later
  
  If 404 (Not Found) is returned the URL is invalidated and a new app should be requested
  
  androidInstantAppUrl string
  
  Android instant app URL
  
  cache string
  
  A location-based app is by default loaded on approaching. Some apps should be loaded in advance. They have the cache set to preload.
  
  Values are approaching or preload. Default value is approaching.
  
  createdAt string(date-time)
  
  Time of LocationBasedApp creation (iso8601 without time zone)
  
  updatedAt string(date-time)
  
  Time of LocationBasedApp last update (iso8601 without time zone)
  
  deletedAt string(date-time)
  
  Time of LocationBasedApp deletion (iso8601 without time zone)

Show attributes

type string

Type

Value is referenceStatus.
id string

Service Provider PRN
attributes object
Hide attributes attributes Show attributes attributes object
- status string
  
  Availability status of the referenced resource
  
  Values are online or offline.
- updatedAt string(date-time)
  
  Time of status last update (iso8601)

400 application/vnd.api+json

Bad request

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed

401 application/vnd.api+json

OAuth token missing or invalid or a linked identity is missing.

Linked identity missing is a special case where you need to make sure that the user has additionally logged in / authorized with a third-party.

This is not relevant for most use-cases.

The specific error code that identifies a missing linked identity is missing-linked-identity

Example:

  {
      "errors": [
          {
              "id": "cbgmhslmp1o9or9kh1p0",
              "title": "Missing linked identity for authorized access",
              "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity",
              "status": "401",
              "code": "missing-linked-identity"
          }
      ]
  }

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed

406 application/vnd.api+json

The specified accept header is invalid

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed

500 application/vnd.api+json

Internal server error

Show response attribute object

errors array[object]
Hide errors attributes Show errors attributes object
- id string
  
  A unique identifier for this particular occurrence of the problem.
- links object
  Hide links attribute Show links attribute object
  
  about string
  
  A link that leads to further details about this particular occurrence of the problem.
- status string
  
  the HTTP status code applicable to this problem, expressed as a string value.
- code string
  
  an application-specific error code, expressed as a string value.
- title string
  
  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
  
  a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source object
  
  An object containing references to the source of the error.
  Hide source attributes Show source attributes object
  
  pointer string
  
  A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
  
  parameter string
  
  A string indicating which URI query parameter caused the error.
- meta object
  
  a meta object containing non-standard meta-information about the error.
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed

GET /gas-stations

curl \
 -X GET https://api.pace.cloud/poi/2024-1/gas-stations \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "id": "b86b67e9-7fae-4500-8885-45c8032056cc",
      "type": "gasStation",
      "attributes": {
        "address": {
          "city": "Karlsruhe",
          "street": "Haid-und-Neu-Str.",
          "houseNo": "18",
          "postalCode": "76131",
          "countryCode": "DE"
        },
        "contact": {
          "email": "max.mustermann@pace.de",
          "gender": "m",
          "lastName": "Mustermann",
          "faxNumber": "+49-175-5559-723",
          "firstName": "Max",
          "phoneNumber": "+49-175-5559-722"
        },
        "latitude": 49.013,
        "amenities": [
          "toilet"
        ],
        "longitude": 8.425,
        "references": [
          "prn:psp:sites:010876234876238991"
        ],
        "priceFormat": "d.dds",
        "stationName": "PACE Station",
        "openingHours": {
          "rules": [
            {
              "days": [
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday"
              ],
              "timespans": [
                {
                  "to": "23:00",
                  "from": "06:00"
                }
              ]
            },
            {
              "days": [
                "saturday"
              ],
              "timespans": [
                {
                  "to": "23:00",
                  "from": "07:00"
                }
              ]
            },
            {
              "days": [
                "sunday"
              ],
              "timespans": [
                {
                  "to": "22:00",
                  "from": "07:00"
                }
              ]
            }
          ],
          "timezone": "+01:00"
        },
        "paymentMethods": [
          "sepaDirectDebit"
        ]
      },
      "relationships": {
        "fuelPrices": {
          "data": [
            {
              "id": "6b5bff6f-74e1-40a1-9da0-72305292d939",
              "type": "fuelPrice"
            },
            {
              "id": "f563e0ee-ba9a-4869-8fe7-42639fcf375d",
              "type": "fuelPrice"
            },
            {
              "id": "cb1afd35-f531-4606-abc8-e1cfbc1f96f5",
              "type": "fuelPrice"
            }
          ]
        },
        "locationBasedApps": {
          "data": [
            {
              "id": "89a072d1-0255-4abb-b863-c463e4b78453",
              "type": "locationBasedApp"
            }
          ]
        },
        "referenceStatuses": {
          "data": [
            {
              "id": "prn:psp:sites:010876234876238991",
              "type": "referenceStatus"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "6b5bff6f-74e1-40a1-9da0-72305292d939",
      "type": "fuelPrice",
      "attributes": {
        "price": 1.399,
        "currency": "EUR",
        "fuelType": "ron95e5",
        "productName": "Super E5"
      }
    },
    {
      "id": "f563e0ee-ba9a-4869-8fe7-42639fcf375d",
      "type": "fuelPrice",
      "attributes": {
        "price": 1.379,
        "currency": "EUR",
        "fuelType": "ron95e10",
        "productName": "Super E10"
      }
    },
    {
      "id": "cb1afd35-f531-4606-abc8-e1cfbc1f96f5",
      "type": "fuelPrice",
      "attributes": {
        "price": 1.239,
        "currency": "EUR",
        "fuelType": "diesel",
        "productName": "Diesel"
      }
    },
    {
      "id": "89a072d1-0255-4abb-b863-c463e4b78453",
      "type": "locationBasedApp",
      "attributes": {
        "title": "PACE Fueling App",
        "appType": "fueling",
        "subtitle": "Zahle bargeldlos mit der PACE Fueling App"
      }
    },
    {
      "id": "prn:psp:sites:010876234876238991",
      "type": "referenceStatus",
      "attributes": {
        "status": "online",
        "updatedAt": "2018-06-01T00:00:00Z"
      }
    }
  ]
}

Response examples (400)

{
  "errors": [
    {
      "id": "string",
      "links": {
        "about": "string"
      },
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Response examples (401)

{
  "errors": [
    {
      "id": "string",
      "links": {
        "about": "string"
      },
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Response examples (406)

{
  "errors": [
    {
      "id": "string",
      "links": {
        "about": "string"
      },
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Response examples (500)

{
  "errors": [
    {
      "id": "string",
      "links": {
        "about": "string"
      },
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}