Find a Facebook page
Facebook has no search a visitor can use, so this reads `business.website` for links to the business' page.
Facebook has no search a visitor can use, so this reads business.website for links to the
business' page. find_status is found (pages most-linked first, each with profile_url
only unless load_candidates), not_linked (the home page links none) or unsupported
(no website sent).
X-API-Key<token>Your API key.
cancel_token?stringA 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.
1 <= length <= 128business*The business to look for.
country?stringTwo letters, any case (us, GB).
^[A-Za-z]{2}$load_candidates?booleanOpen up to 3 of the pages found to fill in name, address and phone.
falseUp to 5 candidate profiles.
application/json- 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<>items <= 5find_status?stringunsupported: 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.
"unsupported""found""not_linked"curl -X GET 'https://api.justserp.com/v1/facebook/reviews/find?business%5Bname%5D=Round+Rock+Donuts&business%5Bwebsite%5D=https%3A%2F%2Froundrockdonuts.com%2F&load_candidates=true'{ "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"}Facebook reviews GET
A Facebook page's recommend score, review count and the reviews a logged-out visitor is shown: three to a request as the list scrolls, so keep `max_reviews` modest.
Facebook business page GET
A Facebook business page under the Facebook Business Page parameters (exactly one of `page_id`, `username`, `url`) and answered as the document: `search_metadata`, `search_parameters`, `page` (`id`, `name`, `link`, `username`, `alternate_name`, `is_verified`, `followers`, `following`, `profile_photo`, `cover_photo`) and `about` (`category`, `address`, `gps_coordinates`, `email`, `phone`, `website`, `ratings`, `rating`, `reviews_count`, `business_hours`, `price_range`; `whatsapp`, `instagram`, `youtube`, `services`, `languages` only if the page has such an item).