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

  • 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]
  • 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
    • included array[object]
      One of:
  • 400 application/vnd.api+json

    Bad request

    Hide response attribute Show response attribute object

    Error objects provide additional information about problems encountered while performing an operation. Errors also contain codes besides title and message which can be used for checks even if the detailed messages might change.

    * 1000: generic error * 1001: payment processing temporarily unavailable * 1002: requested amount exceeds the authorized amount of the provided token * 1003: implicit payment methods cannot be modified * 1004: payment method rejected by provider * provider:payment-method-rejected: payment method rejected by provider (identical to 1004) * rule:product-denied: Product restrictions forbid transaction, e.g., forbidden fuel type - token authorized only for Diesel but attempted to fuel Super.

    • errors array[object]
      Hide errors attributes Show errors attributes object
      • id string

        A unique identifier for 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
        • 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].

        • 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
  • 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"
              }
          ]
      }
    
    Hide response attribute Show response attribute object

    Error objects provide additional information about problems encountered while performing an operation. Errors also contain codes besides title and message which can be used for checks even if the detailed messages might change.

    * 1000: generic error * 1001: payment processing temporarily unavailable * 1002: requested amount exceeds the authorized amount of the provided token * 1003: implicit payment methods cannot be modified * 1004: payment method rejected by provider * provider:payment-method-rejected: payment method rejected by provider (identical to 1004) * rule:product-denied: Product restrictions forbid transaction, e.g., forbidden fuel type - token authorized only for Diesel but attempted to fuel Super.

    • errors array[object]
      Hide errors attributes Show errors attributes object
      • id string

        A unique identifier for 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
        • 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].

        • 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
  • 406 application/vnd.api+json

    The specified accept header is invalid

    Hide response attribute Show response attribute object

    Error objects provide additional information about problems encountered while performing an operation. Errors also contain codes besides title and message which can be used for checks even if the detailed messages might change.

    * 1000: generic error * 1001: payment processing temporarily unavailable * 1002: requested amount exceeds the authorized amount of the provided token * 1003: implicit payment methods cannot be modified * 1004: payment method rejected by provider * provider:payment-method-rejected: payment method rejected by provider (identical to 1004) * rule:product-denied: Product restrictions forbid transaction, e.g., forbidden fuel type - token authorized only for Diesel but attempted to fuel Super.

    • errors array[object]
      Hide errors attributes Show errors attributes object
      • id string

        A unique identifier for 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
        • 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].

        • 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
  • 500 application/vnd.api+json

    Internal server error

    Hide response attribute Show response attribute object

    Error objects provide additional information about problems encountered while performing an operation. Errors also contain codes besides title and message which can be used for checks even if the detailed messages might change.

    * 1000: generic error * 1001: payment processing temporarily unavailable * 1002: requested amount exceeds the authorized amount of the provided token * 1003: implicit payment methods cannot be modified * 1004: payment method rejected by provider * provider:payment-method-rejected: payment method rejected by provider (identical to 1004) * rule:product-denied: Product restrictions forbid transaction, e.g., forbidden fuel type - token authorized only for Diesel but attempted to fuel Super.

    • errors array[object]
      Hide errors attributes Show errors attributes object
      • id string

        A unique identifier for 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
        • 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].

        • 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
  • 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": {}
        }
      ]
    }