Skip to content
Scrappa Get API key
Agoda API 1 credit/request

Agoda Destination Suggest API Documentation

GET https://scrappa.co/api/agoda/suggest

Agoda Destination Suggest API Documentation Find Agoda destinations by name: for each match the id, name, type (city, area, region, landmark or hotel), city id, city name, country id, country code, number of properties and, for hotels, a public url. Use the city id with the search endpoint and the hotel id with the hotel, rooms and reviews endpoints. A search text without matches is a successful response with an empty list.

Agoda Destination Suggest API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/agoda/suggest
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "bangkok",
        "results": [
            {
                "id": 9395,
                "name": "Bangkok",
                "type": "city",
                "city_id": 9395,
                "city_name": "Bangkok",
                "country_id": 106,
                "hotel_count": 12048,
                "country_code": "TH"
            },
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

query string Required

Destination or hotel name, 2 to 100 characters. Example: bangkok.

Example value coffee shops

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "query": "bangkok",
        "results": [
            {
                "id": 9395,
                "name": "Bangkok",
                "type": "city",
                "city_id": 9395,
                "city_name": "Bangkok",
                "country_id": 106,
                "hotel_count": 12048,
                "country_code": "TH"
            },
            {
                "id": 1,
                "name": "Stay in the heart of Bangkok, Thailand",
                "type": "area",
                "city_id": 9395,
                "city_name": "Bangkok",
                "country_id": 106,
                "hotel_count": 1547,
                "country_code": "TH"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "destination_suggest"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required query parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "query": [
            "The query field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Resource Not Found

A search text never produces this error; an empty list is a successful response. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "destination_suggest"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Agoda resource was not found."
    },
    "success": false
}
503

Service Unavailable

Agoda could not be reached or answered with an unexpected shape. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "destination_suggest"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Agoda API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.