Existing Casafari API · API v1 · References
Get location by passed coordinates
GET
https://api.casafari.com/v1/references/locations/by-coordinatesStatic token3 parametersAPI v1
Send Authorization: Token $CASAFARI_TOKEN with your existing API token; see where to get it.
The same path under /api, signed in with a bearer token, is in the REST API reference: GET /api/v1/references/locations/by-coordinates.
Description
Returns a location for the given coordinates with user restrictions.
Query parameters
latitudenumberrequiredThe latitude coordinate.
-90–90
longitudenumberrequiredThe longitude coordinate.
-180–180
langstringLanguage to use for the location names in the response. (When the provided language is not supported, the results will be returned in English.)
Example request
Placeholders only: replace the token and the values with your own.
curl "https://api.casafari.com/v1/references/locations/by-coordinates?latitude=<latitude>&longitude=<longitude>" \
-H "Authorization: Token $CASAFARI_TOKEN"Responses
200
Type: object.
Show the response shape (10 fields)
location_idintegerrequiredID of the location.
namestringrequiredName of the location.
parent_idintegerrequiredID of the parent level location.
administrative_levelstringrequiredLocation administrative level.
locations_structureobject[]requiredInformation about all the parent locations, starting from the top-most level - country.
5 properties
location_idintegerrequiredLocation ID, as returned by the POST /v1/references/locations endpoint.
namestringrequiredLocation name.
administrative_levelstringrequiredLocation administrative level.
zip_codesstring[]The location zip codes.
default []
levelintegerrequiredLocation level as number.
Example from the API description (long arrays shortened)
{
"location_id": 1615,
"name": "São Gonçalo de Lagos",
"parent_id": 1611,
"administrative_level": "Freguesia",
"locations_structure": [
{
"location_id": 499,
"name": "Portugal",
"administrative_level": "País",
"zip_codes": [],
"level": 1
},
{
"location_id": 1597,
"name": "Faro",
"administrative_level": "Distrito",
"zip_codes": [],
"level": 2
}
]
}401 Unauthorized
Type: object.
Show the response shape (1 fields)
detailstringDescription of the error encountered.
403 Forbidden
Type: object.
Show the response shape (1 fields)
detailstringDescription of the error encountered.