Agoda API endpoint
Use Crawlora's Agoda Homes Search API to extract supported public Agoda data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/agoda/homes/searchReturns Homes & Apartments results for an Agoda city: full listing detail for every matching property whose accommodation type is Apartment, drawn from the same city search as hotel search and filtered to non-hotel accommodation types. Callers may supply a known Agoda city id or a free-text city name; when both are supplied city_id takes precedence. Credential-free public data from Agoda's own hotel/home search. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| city_id | integer | No | Numeric Agoda city id, e.g. 9395 for Bangkok. Either city_id or city is required; city_id takes precedence when both are supplied. | ||
| city | string | No | Free-text city name, resolved to a numeric city id via Agoda's own destination search. Ignored when city_id is also supplied. | ||
| page | integer | No | 1 | 1-indexed result page over the underlying city search, defaults to 1 | |
| limit | integer | No | 10 | Candidate listings fetched per page before filtering to homes/apartments, defaults to 10, maximum 50 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/agoda/homes/search?page=1&limit=10" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
- One of `city_id` or `city` is required; supplying neither returns `400` before any upstream request is made. An unknown/unresolvable city returns `404`. - `homes` entries carry the same shape as the hotel detail endpoint's response, plus `accommodation_type`. Known `accommodation_type` values observed on Agoda: `34` (Hotel), `33` (Hostel), `37` (Resort), `120` (Apartment). This endpoint currently returns only `120` (Apartment) entries; broader vacation-home/villa coverage is a planned follow-up. - Because results are filtered down from a page of hotel-search candidates, `count` can be smaller than `limit` even when more matching homes exist on later pages — page forward with `page` to see more. Example response: ```json { "code": 200, "msg": "OK", "data": { "city_id": 9395, "page": 1, "limit": 10, "count": 1, "homes": [ { "property_id": 149146, "display_name": "Diamond Bangkok Apartment", "accommodation_type": 120, "rating": 3.5, "address": { "city": {"id": 9395, "name": "Bangkok"}, "country": {"id": 106, "name": "Thailand"} }, "source_url": "https://www.agoda.com/search?cid=-1&selectedproperty=149146&city=9395" } ] } } ```
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"city_id": 9395,
"page": 1,
"limit": 10,
"count": 1,
"homes": [
{
"property_id": 149146,
"display_name": "Diamond Bangkok Apartment",
"accommodation_type": 120,
"rating": 3.5,
"address": {
"city": {
"id": 9395,
"name": "Bangkok"
},
"country": {
"id": 106,
"name": "Thailand"
}
},
"source_url": "https://www.agoda.com/search?cid=-1&selectedproperty=149146&city=9395"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/agoda.homesSearchResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | agoda.HomesSearchResponse | No | ||||
| data.city_id | integer | No | 9395 | |||
| data.count | integer | No | 1 | |||
| data.homes | array | No | ||||
| data.homes[].accommodation_type | integer | No | 34 | AccommodationType is Agoda's own numeric property-type code (contentSummary.accommodationType), confirmed live 2026-08-05 -- see notes/agoda-maintenance.md for the full set of codes observed. Known values: 34 = Hotel, 33 = Hostel, 37 = Resort, 120 = Apartment. | ||
| data.homes[].address | agoda.Address | No | ||||
| data.homes[].address.address1 | string | No | 222 Ratchaprarop Road, Ratchathewi | |||
| data.homes[].address.city | agoda.City | No | ||||
| data.homes[].address.city.id | integer | No | 9395 | |||
| data.homes[].address.city.name | string | No | Bangkok | |||
| data.homes[].address.country | agoda.Country | No | ||||
| data.homes[].address.country.id | integer | No | 106 | |||
| data.homes[].address.country.name | string | No | Thailand | |||
| data.homes[].address.postal_code | string | No | 10400 | |||
| data.homes[].chain_id | integer | No | 3603 | |||
| data.homes[].children_stay_free_type_id | integer | No | 1 | |||
| data.homes[].description_long | string | No | ||||
| data.homes[].description_short | string | No | Experience Luxury and Convenience at Baiyoke Sky Hotel. | |||
| data.homes[].display_name | string | No | Baiyoke Sky Hotel | |||
| data.homes[].formerly_name | string | No | ||||
| data.homes[].main_image_url | string | No | https://pix8.agoda.net/hotelImages/10637/-1/878a9b58ccd19eee41b98d20e388c080.jpg?ca=9&ce=1 | MainImageURL is the property's primary photo, resolved from Agoda's own content API (contentImages.mainImage.urls) and normalized to an absolute https:// URL. Empty if Agoda has no main image on file. | ||
| data.homes[].number_of_rooms | string | No | 659 | |||
| data.homes[].policy | agoda.Policy | No | ||||
| data.homes[].policy.additional | array | No | When booking more than 5 rooms, different policies and additional supplements may apply. | |||
| data.homes[].policy.adult | array | No | Guests 12 years and older are considered adults. | |||
| data.homes[].policy.extra_bed | array | No | Extra beds are dependent on the room you choose. Please check the individual room capacity for more details. | |||
| data.homes[].policy.min_age | array | No | ||||
| data.homes[].property_id | integer | No | 10637 | |||
| data.homes[].rating | number | No | 4 | |||
| data.homes[].source_url | string | No | https://www.agoda.com/search?cid=-1&selectedproperty=10637&city=9395 | SourceURL is a real, live-verified Agoda URL that resolves directly to this property (Agoda's own affiliate redirect target), even though it is not the pretty slug-based hotel page -- see notes/agoda-maintenance.md. | ||
| data.limit | integer | No | 10 | |||
| data.page | integer | No | 1 | |||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/agoda/homes/search?page=1&limit=10" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms