Detailed points of interest around a location

Returns individual POIs within search_area metres of a coordinate, grouped into Aireon amenity clusters, each with name, distance, category and position.

GET

https://res.aireon.ch/score/poi-details

Authorization

ResApiToken
API key in header
required

Query parameters

search_area
integer
required
Search radius, in metres.
lat
number
required
WGS84 latitude.
lng
number
required
WGS84 longitude.
res_group
optional
true
or
false
Reserved; details are always grouped by cluster.

Returns

200

POIs grouped by amenity cluster.

400

Invalid request.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

401

Authentication token missing (plain-text body).

403

Authentication token invalid (plain-text body).

500

Server error.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

Detailed points of interest around a location

curl --request GET \
  --url 'https://res.aireon.ch/score/poi-details?search_area=0&lat=0&lng=0' \
  --header 'token: <token>'

const url = 'https://res.aireon.ch/score/poi-details?search_area=0&lat=0&lng=0';
const options = {method: 'GET', headers: {token: '<token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "property1": [
    {
      "name": "string",
      "distance": 0,
      "category_name": "string",
      "category_group": "string",
      "location_index": 0,
      "position": {
        "lat": 0,
        "lng": 0
      }
    }
  ],
  "property2": [
    {
      "name": "string",
      "distance": 0,
      "category_name": "string",
      "category_group": "string",
      "location_index": 0,
      "position": {
        "lat": 0,
        "lng": 0
      }
    }
  ]
}

{
  "error": "string",
  "message": "string"
}

Missing Token

Wrong Token

{
  "error": "string",
  "message": "string"
}