Skip to main content
POST
/
api
/
hotpepper
/
restaurants
/
reviews
/hotpepper/restaurants/reviews
curl --request POST \
  --url https://api.anysite.io/api/hotpepper/restaurants/reviews \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "restaurant": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "@type": "HotpepperReview",
    "author": "<string>",
    "author_url": "<string>",
    "age_group": "<string>",
    "gender": "<string>",
    "rating": 123,
    "meal": "<string>",
    "party_size": 123,
    "scene": "<string>",
    "reserved_course": "<string>",
    "is_reserved": false,
    "visit_date": "<string>",
    "text": "<string>",
    "images": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
restaurant
string
required

Hot Pepper restaurant id (strJ{id} or J{id}) or a full restaurant URL

Minimum string length: 1
Examples:

"J003433499"

"strJ003433499"

"https://www.hotpepper.jp/strJ003433499/"

​
count
integer
required

Max number of reviews to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
id
string
required
​
@type
string
default:HotpepperReview
​
author
string | null
​
author_url
string | null
​
age_group
string | null
​
gender
string | null
​
rating
number | null
​
meal
string | null
​
party_size
integer | null
​
scene
string | null
​
reserved_course
string | null
​
is_reserved
boolean
default:false
​
visit_date
string | null
​
text
string | null
​
images
string[]