Skip to main content

Place Match

Returns a place that match with a number of parameters defined in the request. This type of query is useful to find a specific place base on parameters like a name or an address.

POST /search/v1/matches

Query Parameters#

locale#

string

Locale in which to search for and return hits.

Request body Parameters#

name#

string required

The name of the place.

{  "name": "Radimed - Westmount Square"}
note

This parameter is required only if the address parameter is not specified.

address#

string required

The first line of the place’s address.

{  "address": "2505 boulevard Rosemont"}
note

This parameter is required only if the name parameter is not specified.

postalCode#

string

The postal code of the place.

{  "postalCode": "H1Y1K5"}

place#

string

The city in which the place is located.

{  "place": "montreal"}

region#

string

The ISO 3166­-2 code for the region/province of the place.

{  "region": "QC"}

country#

string

The ISO 3166­-1 alpha­2 country code of the place.

{  "country": "CA"}

Examples#

Match a name#

curl -X POST "https://api.partner.clinia.ca/search/v1/matches" \  -H "Content-Type: application/json" \  -H "X-Clinia-API-Key: ${API_KEY}" \  --data-binary '{    "name": "jean coutu maher bitar",  }'
[  {    "documentType": "health_facility",    "type": "PHARMACY",    "address": {      "streetAddress": "1222 avenue Greene",      "suiteNumber": null,      "postalCode": "H3Z 2A3",      "neighborhood": null,      "locality": null,      "place": "Westmount",      "region": "Quebec",      "regionCode": "QC",      "country": "Canada",      "countryCode": "CA"    },    "geoPoint": {      "lat": 45.48641,      "lng": -73.588414    },    "onlineBookingUrl": null,    "distance": null,    "openingHours": {      "1": [        {          "start": "08:00",          "end": "20:00"        }      ],      "2": [        {          "start": "08:00",          "end": "20:00"        }      ],      "3": [        {          "start": "08:00",          "end": "20:00"        }      ],      "4": [        {          "start": "08:00",          "end": "20:00"        }      ],      "5": [        {          "start": "08:00",          "end": "20:00"        }      ],      "6": [        {          "start": "09:00",          "end": "18:00"        }      ],      "7": [        {          "start": "10:00",          "end": "18:00"        }      ]    },    "socials": [      {        "url": "https://www.jeancoutu.com/en/",        "type": null      }    ],    "note": null,    "services": ["Pharmacy"],    "id": "ci.cd3799d6-8383-a2e4-3fd5-8f97d51b36f1",    "name": "Jean Coutu - Maher Bitar, Valérie Savoie-Rosay & Jean Coutu",    "phones": [      {        "countryCode": "+1",        "number": "5149372836",        "extension": null,        "type": "MAIN",        "isTollFree": false      },      {        "countryCode": "+1",        "number": "5149378575",        "extension": null,        "type": "FAX",        "isTollFree": false      }    ],    "owner": "CLINIA"  },  {    "documentType": "health_facility",    "type": "PHARMACY",    "address": {      "streetAddress": "1675 rue Sainte-Catherine Ouest",      "suiteNumber": null,      "postalCode": "H3H 1L9",      "neighborhood": null,      "locality": null,      "place": "Montréal",      "region": "Quebec",      "regionCode": "QC",      "country": "Canada",      "countryCode": "CA"    },    "geoPoint": {      "lat": 45.494411,      "lng": -73.578741    },    "onlineBookingUrl": null,    "distance": null,    "openingHours": {      "1": [        {          "start": "08:00",          "end": "00:00"        }      ],      "2": [        {          "start": "08:00",          "end": "00:00"        }      ],      "3": [        {          "start": "08:00",          "end": "00:00"        }      ],      "4": [        {          "start": "08:00",          "end": "00:00"        }      ],      "5": [        {          "start": "08:00",          "end": "00:00"        }      ],      "6": [        {          "start": "09:00",          "end": "00:00"        }      ],      "7": [        {          "start": "09:00",          "end": "00:00"        }      ]    },    "socials": [      {        "url": "https://www.jeancoutu.com/en/",        "type": null      }    ],    "note": null,    "services": ["Pharmacy"],    "id": "ci.31ee9c2c-610e-c3d0-d404-493cc2e840d7",    "name": "Jean Coutu - Maher Bitar, Valérie Savoie-Rosay & Jean Coutu",    "phones": [      {        "countryCode": "+1",        "number": "5149334221",        "extension": null,        "type": "MAIN",        "isTollFree": false      },      {        "countryCode": "+1",        "number": "5149337454",        "extension": null,        "type": "FAX",        "isTollFree": false      }    ],    "owner": "CLINIA"  }]

Match an address#

curl -X POST "https://api.partner.clinia.ca/search/v1/matches" \  -H "Content-Type: application/json" \  -H "X-Clinia-API-Key: ${API_KEY}" \  --data-binary '{    "address": "2505 boulevard Rosemont",    "postalCode": "H1Y1K5",    "place": "montreal",    "region": "QC",    "country": "CA",  }'
[  {    "documentType": "health_facility",    "type": "PHARMACY",    "address": {      "streetAddress": "419 Boulevard Rosemont",      "suiteNumber": null,      "postalCode": "H2S 1Z2",      "neighborhood": null,      "locality": null,      "place": "Montreal",      "region": "Quebec",      "regionCode": "QC",      "country": "Canada",      "countryCode": "CA"    },    "geoPoint": {      "lat": 45.531515,      "lng": -73.598317    },    "onlineBookingUrl": null,    "distance": null,    "openingHours": {      "1": [        {          "start": "09:00",          "end": "17:00"        }      ],      "2": [        {          "start": "09:00",          "end": "17:00"        }      ],      "3": [        {          "start": "09:00",          "end": "17:00"        }      ],      "4": [        {          "start": "09:00",          "end": "17:00"        }      ],      "5": [        {          "start": "09:00",          "end": "13:00"        }      ]    },    "socials": [      {        "url": "https://www.familiprix.com/en",        "type": null      }    ],    "note": null,    "services": ["Pharmacy"],    "id": "ci.8322d276-503c-c43e-4a86-dc1096cdadc5",    "name": "Familiprix - Cam Uyen Mai Ba",    "phones": [      {        "countryCode": "+1",        "number": "5143791788",        "extension": null,        "type": "MAIN",        "isTollFree": false      },      {        "countryCode": "+1",        "number": "5143793788",        "extension": null,        "type": "FAX",        "isTollFree": false      }    ],    "owner": "CLINIA"  }]