Skip to content

Get review profiles

We provide location based 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.

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

You can even filter results by location using our location parameters.

We charge 1 credit for each request that results in NoLocation error. Meaning that the company you submitted has no review profiles available.

Base URL

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

Request parameters

callback *

string URL provided to receive API results.

We expect a URL endpoint that accepts JSON POST requests

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
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 --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "name": "Five Guys"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
domain

string Domain of the company or product you want the review profiles for.

Using this parameter will provide the highest accuracy possible. However, this could also lead to fewer results than expected.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&domain=fiveguys.com&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "name": "Five Guys",
    "domain": "fiveguys.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 --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=McDonalds&ticker_symbol=MCD&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "McDonalds",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "ticker_symbol": "MCD"
)
response = requests.get(
    url=url,
    params=params
}

coming soon

coming soon

coming soon
phone_number

string Location phone number you want the review profiles for.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&phone_number=%2B1718-797-9380&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "phone_number": "+1718-797-9380"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
street

string Street where the company you want the review profiles for is located.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&street=Cedar%20Hills%20Bvld&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "street": "Cedar Hills Bvld"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
city

string City where the company you want the review profiles for is located.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&city=Beaverton&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "city": "New York"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
zip_code

string ZIP Code of the company you want the review profiles for.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&zip_code=97005&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "zip_code": "97005"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
state

string State where the company you want the review profiles for is located.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&state=Oregon&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "state": "Oregon"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
country

string Country where the company you want the review profiles for is located.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&country=United%20States&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "country": "United States"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
address

string Full address of the company you want the review profiles for.

This will take precedence over the other location parameters.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&address=2606%20Cedar%20Hills%20Blvd%20%2C%20Beaverton%2C%20Oregon%2C%2097005%2C%20United%20States&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "address": "2606 Cedar Hills Blvd , Beaverton, Oregon, 97005, United States"
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
review_site

string

Filter reviews from specific review sites. By default, we return reviews from all indexed websites. Narrowing results down will decrease the processing time.

You can request multiple review sites.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&review_site=foursquare&review_site=glassdoor&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = [
    ("api_key", "12345"),
    ("name", "Five Guys"),
    ("callback", "https://www.example.com/reviewindexapi_callback"),
    ("review_site", "foursquare"),
    ("review_site", "glassdoor")
]
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 --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&page_number=2&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "page_number": 2,
}
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 --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&per_page=10&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "per_page": 10
}
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.

Code example 
curl --request GET --url 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&update=true&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "update": True
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
external_identifier

string If you would like to identify the jobs yourself, you can use external identifier. This value will always be included in our callback payload.

The value cannot exceed 255 characters.

Code example 
curl POST 'https://reviewindexapi.datashake.com/profiles?name=Five%20Guys&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&api_key=12345&external_identifier=qwerty123'

import requests

url = url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "external_identifier": "qwerty123"
}
response = requests.post(
    url=url,
    params=params
)

coming soon

coming soon

coming soon
priority_job

bool You can set some jobs to be processed with priority within your queue.

Code example 
curl GET 'https://reviewindexapi.datashake.com/profiles?api_key=12345&name=Five%20Guys&callback=https%3A%2F%2Fwww.example.com%2Freviewindexapi_callback&priority_job=true'

import requests

url = url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "name": "Five Guys",
    "callback": "https://www.example.com/reviewindexapi_callback",
    "priority_job": True
}
response = requests.get(
    url=url,
    params=params
)

coming soon

coming soon

coming soon

Rules and restrictions

  • The name and callback parameters are required.

Response

API Response example 
{
    "success": true,
    "request": {
        "domain": null,
        "name": "Five Guys",
        "street": null,
        "city": null,
        "zip_code": null,
        "state": null,
        "country": null,
        "address": null,
        "phone_number": null,
        "review_site": [],
        "ticker_symbol": null,
        "callback": "https://foobar.m.pipedream.net",
        "page_number": 1,
        "per_page": 3,
        "update": false,
        "external_identifier": "qwerty123"
    },
    "credits_used": 6920,
    "request_id": "1661523008997513000-01744c2b-8955-4e",
    "summary": {
        "total_profiles": 6920,
        "total_groups": 1925,
        "per_type": [
            {
                "type": "general",
                "profiles": 44,
                "groups": 1
            },
            {
                "type": "location",
                "profiles": 6876,
                "groups": 1924
            }
        ],
        "per_source": [
            {
                "source": "foursquare",
                "profiles": 1440
            },
            {
                "source": "yelp",
                "profiles": 1441
            },
            {
                "source": "tripadvisor",
                "profiles": 1547
            },
            {
                "source": "google",
                "profiles": 1319
            },
            {
                "source": "facebook",
                "profiles": 1172
            },
            {
                "source": "trustpilot",
                "profiles": 1
            }
        ]
    },
    "pagination": {
        "diff": null,
        "page_number": 1,
        "per_page": 3,
        "total_pages": 642
    },
    "results": [
        {
            "type": "general",
            "location": null,
            "profiles": [
                {
                    "company_name": "Five Guys Topeka",
                    "url": "https://www.facebook.com/fiveguystopeka/",
                    "domain": null,
                    "source": "facebook",
                    "reported_review_count": 26,
                    "reported_average_rating": 3.2,
                    "review_count": 0,
                    "average_rating": 0,
                    "updated_at": "2022-04-06T09:08:49.725890"
                },
                {
                    "company_name": "Five Guys - Plainfield",
                    "url": "https://www.facebook.com/FiveGuysPlainfield/",
                    "domain": null,
                    "source": "facebook",
                    "reported_review_count": 5,
                    "reported_average_rating": 5,
                    "review_count": 0,
                    "average_rating": 0,
                    "updated_at": "2022-04-06T09:07:20.692458"
                }
                ...
            ]
        },
        {
            "type": "location",
            "location": {
                "address": "138 montague st., brooklyn, new york, 11201, united states",
                "street": "montague st.",
                "city": "brooklyn",
                "zipcode": "11201",
                "state": "new york",
                "country": "united states",
                "coordinates": "40.694511, -73.9938408",
                "phone_number": "(718) 797-9380"
            },
            "profiles": [
                {
                    "company_name": "Five Guys",
                    "url": "https://foursquare.com/v/five-guys/464c2546f964a520b4461fe3",
                    "domain": "fiveguys.com",
                    "source": "foursquare",
                    "reported_review_count": 30,
                    "reported_average_rating": 0,
                    "review_count": 0,
                    "average_rating": 0,
                    "updated_at": "2022-08-30T19:35:26.003374"
                },
                {
                    "company_name": "Five Guys (Brooklyn, NY)",
                    "url": "https://www.facebook.com/FiveGuysMontagueStBrooklynNY/",
                    "domain": "fiveguys.com",
                    "source": "facebook",
                    "reported_review_count": 3,
                    "reported_average_rating": 3.7,
                    "review_count": 0,
                    "average_rating": 0,
                    "updated_at": "2022-08-30T19:35:26.553340"
                },
                {
                    "company_name": "Five Guys",
                    "url": "https://www.tripadvisor.com/Restaurant_Review-g60827-d8721007-Reviews-Five_Guys-Brooklyn_New_York.html",
                    "domain": "fiveguys.com",
                    "source": "tripadvisor",
                    "reported_review_count": 27,
                    "reported_average_rating": 3.5,
                    "review_count": 0,
                    "average_rating": 0,
                    "updated_at": "2022-08-30T19:35:51.727281"
                }
            ]
        }
    ]
}