Search locations within a rectangle
Search for charging locations within a specified rectangle defined by two diagonal points. The rectangle coordinates are passed via the topLatitude, bottomLatitude, leftLongitude, and rightLongitude query parameters; the request body contains only filters and options. Returns up to 300 locations.
Authorizations
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=......'
Query Parameters
Latitude of the top edge of the rectangle in decimal degrees (e.g. N58°30' is represented as 58.5). Must be greater than bottomLatitude.
-90 <= x <= 90Latitude of the bottom edge of the rectangle in decimal degrees (e.g. S58°30' is represented as -58.5)
-90 <= x <= 90Longitude of the left edge of the rectangle in decimal degrees (e.g. E014°45' is represented as 14.75). Must be less than rightLongitude.
-180 <= x <= 180Longitude of the right edge of the rectangle in decimal degrees (e.g. E014°45' is represented as 14.75)
-180 <= x <= 180Number of locations returned in the response (doesn't apply when aggregation is enabled)
x <= 300If true, the results will be aggregated. For large radius it makes the response much faster.
Value between 2 and 9. The bigger value is, the smaller is the cell size of the grid for aggregation. If not passed, a default value, based on radius, is assumed.
2 <= x <= 9Supported languages: en, bg, cy, de, es, fi, fr, hu, is, it, lt, nb, nl, pl, pt, ro, sv.
2Body
Response
OK
Response payload containing matching locations and aggregate metadata for a geosearch query.