Skip to main content

Place Search

Returns place hits that match the query defined in the request.

POST /search/v1/indexes/health_facility/query

Query Parameters​

locale​

string

Locale in which to search for and return hits.

Request body Parameters​

query​

string

The text to query for. Can be a business name or a medical term.

{
  "query": "jean coutu"
}

facetFilters​

Array<string>

Apply a filter on the type property using the property:value format.

For example, to query pharmacies, use the type:PHARMACY facet filter.

{
  "facetFilters": ["type:PHARMACY"]
}

location​

string

The geotext (postal code, city, etc..) to narrow search results.

{
  "location": "montreal"
}

aroundLatLng​

string

Search for records around a central geolocation, enabling a geo search within a circular area.

Format: "aroundLatLng": "latitude,longitude" where latitude and longitude are floats.

{
  "aroundLatLng": "45.5017,73.5673"
}
note

The parameters location and aroundLatLng are mutually exclusive and location has precedence over aroundLatLng if both are specified.

page​

integer default: 0

Page number of the results to fetch. When a page higher than the total number of pages is specified, an empty hits array is returned.

{
  "page": 1 // will return hits of page 1
}

Examples​

curl -X POST "https://api.partner.clinia.ca/search/v1/indexes/health_facility/query" \
  -H "Content-Type: application/json" \
  -H "X-Clinia-API-Key: ${API_KEY}" \
  --data-binary '{
    "query": "jean coutu",
    "location": "montreal",
    "facetFilters": ["type:PHARMACY"]
  }'
{
  "records": [
    {
      "documentType": "health_facility",
      "type": "PHARMACY",
      "address": {
        "streetAddress": "677 rue Sainte-Catherine Ouest, -19A",
        "suiteNumber": "M",
        "postalCode": "H3B 5K4",
        "neighborhood": null,
        "locality": null,
        "place": "Montréal",
        "region": "Quebec",
        "regionCode": "QC",
        "country": "Canada",
        "countryCode": "CA"
      },
      "geoPoint": {
        "lat": 45.5031016,
        "lng": -73.570184
      },
      "onlineBookingUrl": null,
      "distance": null,
      "openingHours": {
        "1": [
          {
            "start": "08:00",
            "end": "19:00"
          }
        ],
        "2": [
          {
            "start": "08:00",
            "end": "19:00"
          }
        ],
        "3": [
          {
            "start": "08:00",
            "end": "21:00"
          }
        ],
        "4": [
          {
            "start": "08:00",
            "end": "21:00"
          }
        ],
        "5": [
          {
            "start": "08:00",
            "end": "21:00"
          }
        ],
        "6": [
          {
            "start": "10:00",
            "end": "19:00"
          }
        ],
        "7": [
          {
            "start": "11:00",
            "end": "17:30"
          }
        ]
      },
      "socials": [
        {
          "url": "https://www.jeancoutu.com/en/",
          "type": null
        }
      ],
      "note": null,
      "services": ["Pharmacy"],
      "id": "ci.2c123ca7-0444-f7b9-ba78-3aa2049d8ebe",
      "name": "Jean Coutu - Doria Boukheroufa",
      "phones": [
        {
          "countryCode": "+1",
          "number": "5142890800",
          "extension": null,
          "type": "MAIN",
          "isTollFree": false
        },
        {
          "countryCode": "+1",
          "number": "5142870747",
          "extension": null,
          "type": "FAX",
          "isTollFree": false
        }
      ],
      "owner": "CLINIA"
    },
    ...
  ],
  "facets": {},
  "meta": {
    "query": "jean coutu",
    "page": 0,
    "numPages": 8,
    "perPage": 20,
    "total": 145
  }
}