Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

property_id
string

Agoda numeric property ID

Minimum string length: 1
url
string<uri>

Full Agoda property URL

city_id
string

Agoda numeric city ID, required alongside property_id when url is not given (see GET /v1/agoda/search's resolved_city_id)

Pattern: ^\d+$
check_in
string
required

Check-in date (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
check_out
string
required

Check-out date (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
adults
string

Number of adults (default 2)

Pattern: ^\d+$
children
string

Number of children (default 0)

Pattern: ^\d+$
children_ages
string

Comma-separated child ages; length must match children

Pattern: ^\d+(,\d+)*$
rooms
string

Number of rooms (default 1)

Pattern: ^\d+$
currency
string

Display currency (ISO 4217)

Pattern: ^[A-Za-z]{3}$
pos_country
string

Point-of-sale market (ISO country code)

Pattern: ^[A-Za-z]{2}$
device
enum<string>

Device profile to emulate

Available options:
desktop,
mobile,
tablet
timeout_ms
string

Max time to wait, in ms

Pattern: ^\d+$

Response

Structured Agoda property details.

provider
enum<string>
required
Available options:
agoda
page_type
enum<string>
required
Available options:
property
snapshot_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
property_id
string | null
required
name
string | null
required
type
string | null
required
stars
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
description
string | null
required
address
string | null
required
coordinates
object | null
required
review_score
number | null
required
review_count
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
amenities
string[]
required
images
string[]
required
stay
object
required
occupancy
object
required
currency
string | null
required
pos_country
string | null
required
available
boolean
required
rooms
object[]
required
url
string<uri>
required