Skip to main content
POST
/
api
/
jalan
/
hotels
/
plans
/jalan/hotels/plans
curl --request POST \
  --url https://api.anysite.io/api/jalan/hotels/plans \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "hotel": "<string>",
  "count": 2,
  "timeout": 300,
  "checkin": "2023-12-25",
  "checkout": "2023-12-25",
  "adults": 2
}
'
[
  {
    "plan_code": "<string>",
    "@type": "@jalan_plan",
    "name": "<string>",
    "description": "<string>",
    "meal": "<string>",
    "checkin_time": "<string>",
    "checkout_time": "<string>",
    "reservation_period": "<string>",
    "image": "<string>",
    "labels": [],
    "rooms": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
hotel
string
required

Jalan hotel/ryokan id (numeric, e.g. 340595) or a full hotel URL

Minimum string length: 1
Examples:

"340595"

"yad340595"

"https://www.jalan.net/yad340595/"

​
count
integer
required

Max number of plans to return

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

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
checkin
string<date> | null

Check-in date (YYYY-MM-DD); omit for date-undecided lowest prices

​
checkout
string<date> | null

Check-out date (YYYY-MM-DD); defaults to one night after check-in

​
adults
integer
default:2

Number of adults

Required range: 1 <= x <= 20

Response

Successful Response

​
plan_code
string
required
​
@type
string
default:@jalan_plan
​
name
string | null
​
description
string | null
​
meal
string | null
​
checkin_time
string | null
​
checkout_time
string | null
​
reservation_period
string | null
​
image
string | null
​
labels
string[]
​
rooms
JalanPlanRoom · object[]