Get a location

curl --request GET \
  --url https://apigwuat.corpay.com/locations/geosearch/{locationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apigwuat.corpay.com/locations/geosearch/{locationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apigwuat.corpay.com/locations/geosearch/{locationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigwuat.corpay.com/locations/geosearch/{locationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apigwuat.corpay.com/locations/geosearch/{locationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://apigwuat.corpay.com/locations/geosearch/{locationId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigwuat.corpay.com/locations/geosearch/{locationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "8rMCionje8s2LtheVGEK90mYnJdJe5OZd48ecF/w1StRJSodFFzfQ3GhJbYbxG0gQhJv/Yjp5FXBJt14SccU9zFRdnC4SV7juPdCRaWkEZo=",
  "name": "Ebee Smart Technologies",
  "coordinates": {
    "latitude": "52.475911",
    "longitude": "13.350794"
  },
  "evses": [
    {
      "uid": "8rMCionje8s2LtheVGEK90mYnJdJe5OZd48ecF/w1StRJSodFFzfQ3GhJbYbxG0g3wFt7gLfnV3ulxmnoAzR4W/DFEMs63CndZpPK6L2aJG9qMC0Dp9OqeegGRXmiTOE",
      "evse_id": "+49*839*030*000074",
      "physical_reference": "4",
      "status": "AVAILABLE",
      "connectors": [
        {
          "id": "8rMCionje8s2LtheVGEK90mYnJdJe5OZd48ecF/w1StRJSodFFzfQ3GhJbYbxG0g3wFt7gLfnV3ulxmnoAzR4W/DFEMs63CndZpPK6L2aJEM0D69tJVN05/1hZ1zxqZSJ9kBdNsmfryS0+gvjLNZvdF1pDHJuCTydsJX6vPZh7U=",
          "standard": "Type2",
          "power": 22000,
          "power_type": "AC_3_PHASE",
          "price": {
            "id": "4370769f30bd7927",
            "description": "€ 0.56/kWh, € 0.10/min (> 2 h)",
            "currency": "EUR",
            "priceIncludesVat": "true",
            "vatRate": "22",
            "elements": [
              {}
            ]
          },
          "max_amperage": 32,
          "max_voltage": 400
        }
      ],
      "capabilities": [
        "RESERVABLE",
        "PLUG_AND_CHARGE_CAPABLE",
        "PLUG_AND_CHARGE_CAPABLE"
      ],
      "last_updated": "2025-01-15T10:30:00.000Z"
    }
  ],
  "operator": {
    "id": "881941",
    "name": "Ebee Smart Technologies",
    "hotline": "+498944255071",
    "external_id": "DE*ABC"
  },
  "operator_display_name": "Sub-operator X",
  "opening_times": {
    "twentyfourseven": false,
    "regular_hours": [
      {
        "weekday": 1,
        "period_begin": "00:10",
        "period_end": "29:59"
      }
    ],
    "exceptional_openings": [
      {
        "period_begin": "2025-01-15T10:30:00.000Z",
        "period_end": "2025-01-15T10:30:00.000Z"
      }
    ],
    "exceptional_closings": [
      {
        "period_begin": "2025-01-15T10:30:00.000Z",
        "period_end": "2025-01-15T10:30:00.000Z"
      }
    ]
  },
  "directions": [
    {
      "language": "DE",
      "text": "example"
    }
  ],
  "country": "DEU",
  "state": "Bayern",
  "city": "Berlin",
  "postal_code": 10829,
  "address": "EUREF CAMPUS 4-5",
  "openNow": false,
  "is_green_energy": false,
  "last_updated": "2024-03-15T14:30:00.000Z"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

GET

locations

geosearch

{locationId}

Get a location

curl --request GET \
  --url https://apigwuat.corpay.com/locations/geosearch/{locationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apigwuat.corpay.com/locations/geosearch/{locationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apigwuat.corpay.com/locations/geosearch/{locationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigwuat.corpay.com/locations/geosearch/{locationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apigwuat.corpay.com/locations/geosearch/{locationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://apigwuat.corpay.com/locations/geosearch/{locationId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigwuat.corpay.com/locations/geosearch/{locationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "8rMCionje8s2LtheVGEK90mYnJdJe5OZd48ecF/w1StRJSodFFzfQ3GhJbYbxG0gQhJv/Yjp5FXBJt14SccU9zFRdnC4SV7juPdCRaWkEZo=",
  "name": "Ebee Smart Technologies",
  "coordinates": {
    "latitude": "52.475911",
    "longitude": "13.350794"
  },
  "evses": [
    {
      "uid": "8rMCionje8s2LtheVGEK90mYnJdJe5OZd48ecF/w1StRJSodFFzfQ3GhJbYbxG0g3wFt7gLfnV3ulxmnoAzR4W/DFEMs63CndZpPK6L2aJG9qMC0Dp9OqeegGRXmiTOE",
      "evse_id": "+49*839*030*000074",
      "physical_reference": "4",
      "status": "AVAILABLE",
      "connectors": [
        {
          "id": "8rMCionje8s2LtheVGEK90mYnJdJe5OZd48ecF/w1StRJSodFFzfQ3GhJbYbxG0g3wFt7gLfnV3ulxmnoAzR4W/DFEMs63CndZpPK6L2aJEM0D69tJVN05/1hZ1zxqZSJ9kBdNsmfryS0+gvjLNZvdF1pDHJuCTydsJX6vPZh7U=",
          "standard": "Type2",
          "power": 22000,
          "power_type": "AC_3_PHASE",
          "price": {
            "id": "4370769f30bd7927",
            "description": "€ 0.56/kWh, € 0.10/min (> 2 h)",
            "currency": "EUR",
            "priceIncludesVat": "true",
            "vatRate": "22",
            "elements": [
              {}
            ]
          },
          "max_amperage": 32,
          "max_voltage": 400
        }
      ],
      "capabilities": [
        "RESERVABLE",
        "PLUG_AND_CHARGE_CAPABLE",
        "PLUG_AND_CHARGE_CAPABLE"
      ],
      "last_updated": "2025-01-15T10:30:00.000Z"
    }
  ],
  "operator": {
    "id": "881941",
    "name": "Ebee Smart Technologies",
    "hotline": "+498944255071",
    "external_id": "DE*ABC"
  },
  "operator_display_name": "Sub-operator X",
  "opening_times": {
    "twentyfourseven": false,
    "regular_hours": [
      {
        "weekday": 1,
        "period_begin": "00:10",
        "period_end": "29:59"
      }
    ],
    "exceptional_openings": [
      {
        "period_begin": "2025-01-15T10:30:00.000Z",
        "period_end": "2025-01-15T10:30:00.000Z"
      }
    ],
    "exceptional_closings": [
      {
        "period_begin": "2025-01-15T10:30:00.000Z",
        "period_end": "2025-01-15T10:30:00.000Z"
      }
    ]
  },
  "directions": [
    {
      "language": "DE",
      "text": "example"
    }
  ],
  "country": "DEU",
  "state": "Bayern",
  "city": "Berlin",
  "postal_code": 10829,
  "address": "EUREF CAMPUS 4-5",
  "openNow": false,
  "is_green_energy": false,
  "last_updated": "2024-03-15T14:30:00.000Z"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

Authorizations

Authorization

string

header

required

Use OAuth2 client credentials to obtain a bearer token.

Token endpoint: POST <BASE_URL>/keycloak/realms/longship/protocol/openid-connect/token

Use the same base URL as the selected API server:

Test environment: https://apigwuat.corpay.com
Production environment: https://apigw.corpay.com

Example:

curl --location '<BASE_URL>/keycloak/realms/longship/protocol/openid-connect/token' \
--header 'accept: application/json' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=.......' \
--data-urlencode 'client_secret=......'

Path Parameters

locationId

string

required

URL-encoded location id.

Query Parameters

keyIdentifier

string

The keyIdentifier of a charging key, will be used to look up specific prices for this charging key.

fleetId

string

The id of a fleet organization, will be used to look up specific prices for this fleet.

language

string

Supported languages: en, bg, cy, de, es, fi, fr, hu, is, it, lt, nb, nl, pl, pt, ro, sv.

Required string length: 2

Response

Location

address

string

required

Street address of the charging location

Example:

"EUREF CAMPUS 4-5"

city

string

required

City where the charging location is situated

Example:

"Berlin"

coordinates

object

required

Geographic coordinates of the charging location. These values are returned as strings.

Show child attributes

country

string

required

Three-letter country code (ISO 3166-1 alpha-3) where the charging location is situated

Required string length: 3

Example:

"DEU"

evses

object[]

required

List of Electric Vehicle Supply Equipment (EVSE) at this location. Each EVSE may have multiple connectors.

Show child attributes

string

required

Example:

"8rMCionje8s2LtheVGEK90mYnJdJe5OZd48ecF/w1StRJSodFFzfQ3GhJbYbxG0gQhJv/Yjp5FXBJt14SccU9zFRdnC4SV7juPdCRaWkEZo="

last_updated

string

required

ISO 8601 timestamp of when this location's data was last updated. Use this to track changes and implement efficient polling.

Example:

"2024-03-15T14:30:00.000Z"

name

string

required

Human-readable name of the charging location

Maximum string length: 255

Example:

"Ebee Smart Technologies"

directions

object[]

Navigation instructions to help locate the charging points, available in multiple languages

Show child attributes

is_green_energy

boolean

Indicates if the location uses renewable energy sources for charging, based on CPO-provided data

Example:

false

openNow

boolean

Indicates if the location is currently open based on opening_hours and local timezone. Use this for quick filtering of available locations.

Example:

false

opening_times

object

Operating hours of the charging location

Show child attributes

operator

object

Information about the Charging Point Operator (CPO) managing this location

Show child attributes

operator_display_name

string

An enhanced display name of the operator. This may be the operator name as found in the operator object, or the sub-operator of the location. When showing the location to end users, this is the operator name that should be shown.

Example:

"Sub-operator X"

postal_code

string

Postal code of the charging location

Example:

10829

state

string

State, region, or province where the charging location is situated. Format varies by country.

Example:

"Bayern"

Search locations within a rectangle Start a remote charging session

⌘I