Skip to main content
POST
/
api
/
hotpepper
/
restaurants
/
courses
/hotpepper/restaurants/courses
curl --request POST \
  --url https://api.anysite.io/api/hotpepper/restaurants/courses \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "restaurant": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "HotpepperCourse",
    "image": "<string>",
    "description": "<string>",
    "price": 123,
    "dish_count": 123,
    "min_people": 123,
    "reserve_deadline": "<string>",
    "labels": []
  }
]

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 courses 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
​
url
string
required
​
@type
string
default:HotpepperCourse
​
image
string | null
​
description
string | null
​
price
integer | null
​
dish_count
integer | null
​
min_people
integer | null
​
reserve_deadline
string | null
​
labels
string[]