Skip to content

Points of Interest

POST pois

Returns points of interests such as schools, shops, etc. that match the specified search criteria.

Request#

curl -X POST 'https://api.pricehubble.com/api/v1/pois?access_token=74126eab0a9048d993bda4b1b55ae074' \
  -H 'Content-Type: application/json' \
  -d '{
    "coordinates": {
      "latitude": 47.3968601,
      "longitude": 8.5153549
    },
    "radius": 1000,
    "category": [
      "education",
      "leisure"
    ],
    "subcategory": [
      "kindergarten",
      "playground"
    ],
    "offset": 0,
    "limit": 10,
    "countryCode": "CH"
}'
Field Description Type Remarks
coordinates Filter on POI location. Matches POIs that lie within the circle defined by coordinates and radius Coordinates
radius Radius of the circle around coordinates, in meters integer min: 0, max: 30'000, default: 3'000
category Filter on POI category. Matches POIs which have one of the specified category or a combination of category + subcategory if a subcategory is also specified. array of PoiCategory
subcategory Filter on POI subcategory. Matches POIs which have one of the specified subcategory or a combination of category + subcategory if a category is also specified array of PoiSubcategory
offset Offset of the query (allows pagination) integer min: 0, max: 1'000, default: 0
limit Maximum number of results to return integer min: 0, max: 500, default: 10
countryCode ISO country code string

The following table shows the currently available POI categories/subcategories. Additional categories/subcategories could be added in the future.

PoiCategory and PoiSubcategory#

PoiCategory PoiSubcategory
education kindergarten
  primary_school
  secondary_school
  university
shopping supermarket
  convenience_store
catering restaurant
  bar
  cafe
health hospital
  pharmacy
  doctor
  clinic
  dentist
  nursing_home
  veterinary
leisure park
  sport
  playground
  entertainment
transport bus
  tram
  subway
  train
  airport
  highway_ramp

Response#

{
  "totalItems": 1,
  "items": [
    {
      "name": "Waidfussweg",
      "category": "education",
      "subcategory": "kindergarten",
      "location": {
        "coordinates": {
          "latitude": 47.39780,
          "longitude": 8.51751
        },
        "address": {
          "postCode": "8037",
          "city": "Z├╝rich",
          "street": "Waidfussweg",
          "houseNumber": "61"
        }
      },
      "distance": 193
    }
  ]
}
Field Description Type Remarks
totalItems Total number of matching POIs found integer
items List of matching POIs, sorted by distance in ascending order array of POIs empty array if no results

POI#

Field Description Type Remarks
name Name of the POI in the local language string
category PoiCategory
subcategory PoiSubcategory
location Location
distance Distance in meters to the coordinates specified in the request integer