JustSERPDocs
Healthgrades

Find a Healthgrades provider

Uses the site's search, `business.name` as "who" and the town from `business.address` as "where".

GET
/v1/healthgrades/reviews/find

Uses the site's search, business.name as "who" and the town from business.address as "where". The candidates are providers.

Authorization

headerX-API-Key<token>

Your API key.

Query Parameters

cancel_token?string

A name you make up for this request (a UUID is fine), so you can later GET /v1/cancel with it. Only you know it, so only you can cancel. Use a new one for every request, retries included: a cancelled token stays cancelled for a few minutes.

Length1 <= length <= 128
business*

The business to look for.

country?string

Two letters, any case (us, GB).

Match^[A-Za-z]{2}$

Response Body

Up to 5 candidate profiles.

application/json
  1. response

mode: "find". Up to 5 candidates, each with the fields a profile has (any may be null).

search_metadata*
search_parameters*

The request's own fields as sent, engine first, without cancel_token.

search_information*

The parser's own, e.g. yelp_search's; otherwise {}.

candidates*array<>
Itemsitems <= 5
find_status?string

unsupported: the site has no search a visitor can use (or, for Facebook, no website was sent; for Yellow Pages, the business is outside the US); candidates is [] and retrying is pointless. found, not_linked: Facebook only.

Value in"unsupported""found""not_linked"
Example Request
curl -X GET 'https://api.justserp.com/v1/healthgrades/reviews/find?business%5Bname%5D=Joe%27s+Pizza+Broadway&business%5Baddress%5D=1435+Broadway%2C+New+York%2C+NY+10018&business%5Bphone%5D=%2B1+212-366-1182&business%5Bwebsite%5D=http%3A%2F%2Fjoespizzanyc.com%2F&business%5Blatitude%5D=40.7546795&business%5Blongitude%5D=-73.9870291&country=us'
Example Response
{  "search_metadata": {    "id": "string",    "status": "Success",    "created_at": "string",    "request_url": "string",    "html_url": "string"  },  "search_parameters": {},  "search_information": {},  "candidates": [    {      "profile_url": "string",      "site_id": "string",      "name": "string",      "address": "string",      "phone": "string",      "website": "string",      "rating": 0,      "review_count": 0    }  ],  "find_status": "unsupported"}