Skip to main content
POST
/
api
/
hotpepper
/
restaurants
/hotpepper/restaurants
curl --request POST \
  --url https://api.anysite.io/api/hotpepper/restaurants \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "restaurant": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "HotpepperRestaurant",
    "name": "<string>",
    "image": "<string>",
    "catch_copy": "<string>",
    "address": {
      "@type": "HotpepperRestaurantAddress",
      "street": "<string>",
      "locality": "<string>",
      "region": "<string>",
      "country": "<string>"
    },
    "latitude": 123,
    "longitude": 123,
    "telephone": "<string>",
    "genres": [],
    "area": "<string>",
    "nearest_station": "<string>",
    "access": "<string>",
    "rating": 123,
    "review_count": 123,
    "course_count": 123,
    "coupon_count": 123,
    "budget_dinner": "<string>",
    "budget_lunch": "<string>",
    "budget_note": "<string>",
    "open_hours": "<string>",
    "closed_days": "<string>",
    "is_net_reservable": false,
    "point_use": true,
    "smart_pay": true,
    "credit_cards": [],
    "e_money": [],
    "qr_payments": [],
    "smoking": "<string>",
    "total_seats": 123,
    "max_banquet_capacity": 123,
    "has_private_room": true,
    "has_tatami": true,
    "has_horigotatsu": true,
    "has_counter": true,
    "has_sofa": true,
    "has_terrace": true,
    "has_charter": true,
    "has_wifi": true,
    "has_barrier_free": true,
    "has_parking": true,
    "other_facilities": [],
    "has_all_you_can_drink": true,
    "has_all_you_can_eat": true,
    "drink_features": [],
    "kids_friendly": "<string>",
    "celebration_ok": true,
    "shop_features": "<string>",
    "remarks": "<string>",
    "scenes": []
  }
]

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/"

​
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:HotpepperRestaurant
​
name
string | null
​
image
string | null
​
catch_copy
string | null
​
address
object
​
latitude
number | null
​
longitude
number | null
​
telephone
string | null
​
genres
string[]
​
area
string | null
​
nearest_station
string | null
​
access
string | null
​
rating
number | null
​
review_count
integer | null
​
course_count
integer | null
​
coupon_count
integer | null
​
budget_dinner
string | null
​
budget_lunch
string | null
​
budget_note
string | null
​
open_hours
string | null
​
closed_days
string | null
​
is_net_reservable
boolean
default:false
​
point_use
boolean | null
​
smart_pay
boolean | null
​
credit_cards
string[]
​
e_money
string[]
​
qr_payments
string[]
​
smoking
string | null
​
total_seats
integer | null
​
max_banquet_capacity
integer | null
​
has_private_room
boolean | null
​
has_tatami
boolean | null
​
has_horigotatsu
boolean | null
​
has_counter
boolean | null
​
has_sofa
boolean | null
​
has_terrace
boolean | null
​
has_charter
boolean | null
​
has_wifi
boolean | null
​
has_barrier_free
boolean | null
​
has_parking
boolean | null
​
other_facilities
string[]
​
has_all_you_can_drink
boolean | null
​
has_all_you_can_eat
boolean | null
​
drink_features
string[]
​
kids_friendly
string | null
​
celebration_ok
boolean | null
​
shop_features
string | null
​
remarks
string | null
​
scenes
object[]