Skip to content

Get review profiles

We provide review profiles grouped by location!

We only collect data that are present on the website. The information collected varies from website to website. If the information is not found, the value is set to None.

It is expected that the number of indexed reviews does not match the total reviews count. Total reviews count reported on the website includes all historical data, whereas our indexer has limitations in fetching historical data. If you are interested in collecting all historical data, please reach out to us.

The more company specifying parameters you provide, the better results you will receive in return.

Base URL

GET https://reviewindexapi.datashake.com/profiles

Request parameters

company_name

string Name of the company you want the review profiles for.

Make sure to use official company names (e.g., Chipotle Mexican Grill instead of Chipotle)

Code example
curl 'https://reviewindexapi.datashake.com/profiles?company_name=mcdonalds&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "company_name": "mcdonalds"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon
company_domain

string Company domain you want the review profiles for.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?company_domain=mcdonalds.com&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "company_domain": "mcdonalds.com"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon
ticker_symbol

string Company ticker symbol (also known as stock symbol) you want the review profiles for.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?ticker_symbol=MCD&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "ticker_symbol": "MCD"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon
page_number

integer Retrieve a specific page of locations.

Default value is set to 1 and the maximum value is being returned in the API response.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?company_name=mcdonalds&page_number=3&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "page_number": 3,
    "company_name": "mcdonalds"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon
per_page

integer The number of locations in one page.

The default value is 10, and the maximum allowed value is 50.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?company_name=mcdonalds&per_page=250&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "per_page": 250,
    "company_name": "mcdonalds"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon
update

boolean We do not update review profiles automatically. To have the latest available data, such as the number of reviews and average rating, you must request an update.

This process might take more time depending on the number of updated profiles. When an update is requested, a callback URL is required. We do not allow server polling.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?company_domain=mcdonalds.com&update=true&callback=https://www.my-callback.com&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "company_domain": "mcdonalds.com",
    "update": True,
    "callback": "https://www.my-callback.com"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon
callback

string An URL to receive API results.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?company_domain=mcdonalds.com&update=true&callback=https://www.my-callback.com&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "company_domain": "mcdonalds.com",
    "update": True,
    "callback": "https://www.my-callback.com"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon

Rules and restrictions

  • To perform the task, we need at least one of these parameters: company_name, company_domain or ticker_symbol
  • Callback URL is required when update parameter is set to true

Response

API Response example
{
    "success": true,
    "request": {
        "company_domain": "mcdonalds.com",
        "company_name": null,
        "ticker_symbol": null,
        "callback": null,
        "page_number": 1,
        "per_page": 10,
        "update": false
    },
    "request_id": "1649252312782697988-97567546-98a1-41",
    "summary": {
        "profiles": 68652,
        "locations": 18235
    },
    "pages": 1824,
    "page_number": 1,
    "results": [
        {
            "location": {
                "address": "401 Buff Blvd, Summerton, South Carolina, 29148, United States",
                "street": "401 Buff Blvd",
                "city": "Summerton",
                "zipcode": "29148",
                "state": "South Carolina",
                "country": "United States",
                "coordinates": "33.5916488,-80.355376",
                "phone_number": "+1 803-488-0188"
            },
            "profiles": [
                {
                    "company_name": "McDonald's",
                    "url": "https://www.tripadvisor.com/Restaurant_Review-g54455-d21070605-Reviews-McDonald_s-Summerton_South_Carolina.html",
                    "domain": "mcdonalds.com",
                    "source": "tripadvisor",
                    "reported_review_count": 1,
                    "reported_average_rating": 1.0,
                    "review_count": 0,
                    "average_rating": 0.0,
                    "updated_at": "2022-03-23T19:10:07.621030"
                },
                {
                    "company_name": "McDonald's",
                    "url": "https://search.google.com/local/reviews?placeid=ChIJnxxpyWob_4gR6oVrGGmxXmM",
                    "domain": "mcdonalds.com",
                    "source": "google",
                    "reported_review_count": 444,
                    "reported_average_rating": 3.2,
                    "review_count": 64,
                    "average_rating": 3.28,
                    "updated_at": "2022-03-22T16:06:13.940705"
                },
                {
                    "company_name": "McDonald's",
                    "url": "https://foursquare.com/v/mcdonalds/5ed54ea84244b80008b6570b",
                    "domain": "mcdonalds.com",
                    "source": "foursquare",
                    "reported_review_count": 0,
                    "reported_average_rating": 2.85,
                    "review_count": 0,
                    "average_rating": 0.0,
                    "updated_at": "2022-03-20T09:42:49.106951"
                }
            ]
        },
        {
            "location": {
                "address": "3329 W Genesee St, Syracuse, Finger Lakes 13219, United States",
                "street": "3329, W, Genesee, St",
                "city": "Syracuse",
                "zipcode": "13219",
                "state": "Finger Lakes",
                "country": "United States",
                "coordinates": "43.0480073364417,-76.22807040810585",
                "phone_number": "+1 315-218-5757"
            },
            "profiles": [
                {
                    "company_name": "McDonald's",
                    "url": "https://www.facebook.com/McDonalds3329WGeneseeSt/",
                    "domain": null,
                    "source": "facebook",
                    "reported_review_count": 62,
                    "reported_average_rating": 3.1,
                    "review_count": 0,
                    "average_rating": 0.0,
                    "updated_at": "2022-03-22T10:19:26.081569"
                },
                ...
            ]
        },
        ...
    ]
}