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.

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

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
}
require 'net/http'

uri = URI('https://reviewindexapi.datashake.com/profiles')
params = { api_key: "12345", company_name: "mcdonalds" }
uri.query = URI.encode_www_form(params)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  request = Net::HTTP::Post.new(uri) 
  http.request(request)
end
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_name": "mcdonalds",
    "company_domain": "mcdonalds.com"
}
response = requests.get(
    url=url,
    params=params
}
require 'net/http'

uri = URI('https://reviewindexapi.datashake.com/profiles')
params = { api_key: "12345", company_name: "mcdonalds", company_domain: "mcdonalds.com" }
uri.query = URI.encode_www_form(params)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  request = Net::HTTP::Post.new(uri) 
  http.request(request)
end
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",
    "company_name": "mcdonalds",
    "ticker_symbol": "MCD"
}
response = requests.get(
    url=url,
    params=params
}
coming soon
coming soon
coming soon
phone_number

string Company phone number you want the review profiles for.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?phone_number=212-463-8869&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "phone_number": "212-463-8869"
}
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 'https://reviewindexapi.datashake.com/profiles?street=541%206th%20Ave&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "street": "541 6th Ave"
}
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 'https://reviewindexapi.datashake.com/profiles?city=New%20York&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "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 'https://reviewindexapi.datashake.com/profiles?zip_code=10011&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "zip_code": "10011"
}
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 'https://reviewindexapi.datashake.com/profiles?state=NY&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "state": "NY"
}
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 'https://reviewindexapi.datashake.com/profiles?country=United%20States&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "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.

Note: This will take precedence over the other location parameters.

Code example
curl 'https://reviewindexapi.datashake.com/profiles?address=541%206th%20Ave%2C%20New%20York%2C%20NY%2010011&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "address": "541 6th Ave, New York, NY 10011"
}
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=10&api_key=12345'
import requests

url = "https://reviewindexapi.datashake.com/profiles"
params = {
    "api_key": "12345",
    "per_page": 10,
    "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.

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_name": "mcdonalds",
    "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

  • The company_name parameter is required
  • The callback URL is required

Response

API Response example
{
    "success": true,
    "request": {
        "company_domain": null,
        "company_name": "Ippudo",
        "street": "65 4th Ave",
        "city": "New York",
        "zip_code": "10003",
        "state": "NY",
        "country": "United States",
        "address": null,
        "phone_number": null,
        "ticker_symbol": null,
        "callback": "http://foo.bar/callback",
        "page_number": 1,
        "per_page": 10,
        "update": false
    },
    "request_id": "1654526406169052500-efcdf4a4-2421-4a",
    "summary": {
        "profiles": 3,
        "locations": 1
    },
    "reviews_per_site": [
        {
            "review_site": "yelp",
            "average_rating": 5.0,
            "total_reviews": 13
        },
        {
            "review_site": "facebook",
            "average_rating": 5.0,
            "total_reviews": 5
        }
    ],
    "pages": 1,
    "page_number": 1,
    "results": [
        {
            "location": {
                "address": "65 4th ave, new york, new york, 10003, united states",
                "street": "4th ave",
                "city": "new york",
                "zipcode": "10003",
                "state": "new york",
                "country": "united states",
                "coordinates": "40.730920508133, -73.990148658896",
                "phone_number": "(212) 388-0088"
            },
            "profiles": [
                {
                    "company_name": "Ippudo",
                    "url": "https://foursquare.com/v/ippudo/4a5403b8f964a520f3b21fe3",
                    "domain": "ippudony.com",
                    "source": "foursquare",
                    "reported_review_count": 1162,
                    "reported_average_rating": 4.55,
                    "review_count": 0,
                    "average_rating": 0.0,
                    "updated_at": "2022-05-16T17:42:04.966915"
                },
                {
                    "company_name": "Ippudo NY",
                    "url": "https://www.yelp.com/biz/ippudo-ny-new-york-7",
                    "domain": "ippudony.com",
                    "source": "yelp",
                    "reported_review_count": 10241,
                    "reported_average_rating": 4.0,
                    "review_count": 13,
                    "average_rating": 4.54,
                    "updated_at": "2022-05-16T17:42:03.275420"
                },
                {
                    "company_name": "Ippudo New York",
                    "url": "https://www.facebook.com/IppudoNY/",
                    "domain": "ippudony.com",
                    "source": "facebook",
                    "reported_review_count": 1507,
                    "reported_average_rating": 4.6,
                    "review_count": 5,
                    "average_rating": 5.0,
                    "updated_at": "2022-05-16T17:42:02.827197"
                }
            ]
        }
    ]
}