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

Rumah123 Agents API Documentation

GET https://scrappa.co/api/rumah123/agents

Rumah123 Agents API pages through the public agent directory, 16 agents per page. Each agent has the id, name, profile URL, office address, verification flag, languages, specialities, the number of online, sold and rented listings, the agency with its logo and province, awards and the photo. Filter by a name keyword. Contact details are never returned. A page past the end returns an empty list.

Rumah123 Agents API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/rumah123/agents
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "items": [
            {
                "id": "1779915",
                "url": "https://www.rumah123.com/agen-properti/ray-white-kelapa-gading/sylvester-rwkg-1779915/",
                "name": "Sylvester RWKG",
                "uuid": "6bd17408-bf1b-4698-9552-3bd7cabd4a87",
                "awards": [],
                "images": [
                    "https://picture.rumah123.com/r123-images/250x250-fit/customer/1779915/019bf09df0673c2aa295b1b9883f7454.jpg"
                ],
                "address": "Jl. Kelapa Nias Raya Blok GN No. 8, Kelapa Gading - Jakarta Utara",
                "languages": [],
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

2 optional filters available.

keyword string Optional

Text to find in agent and agency names. Optional.

Example value running shoes
page integer Optional

One-based page number. Default 1.

Example value 1

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": {
        "items": [
            {
                "id": "1779915",
                "url": "https://www.rumah123.com/agen-properti/ray-white-kelapa-gading/sylvester-rwkg-1779915/",
                "name": "Sylvester RWKG",
                "uuid": "6bd17408-bf1b-4698-9552-3bd7cabd4a87",
                "awards": [],
                "images": [
                    "https://picture.rumah123.com/r123-images/250x250-fit/customer/1779915/019bf09df0673c2aa295b1b9883f7454.jpg"
                ],
                "address": "Jl. Kelapa Nias Raya Blok GN No. 8, Kelapa Gading - Jakarta Utara",
                "languages": [],
                "created_at": "2023-02-02T08:49:29+00:00",
                "specialist": [],
                "is_verified": true,
                "organization": {
                    "url": "https://www.rumah123.com/agen-properti/ray-white-kelapa-gading-94/",
                    "logo": "https://pic.rumah123.com/r123/250x250-fit/logo/20180412013424_ray_white_kelapa_gading.png",
                    "name": "Ray White Kelapa Gading",
                    "uuid": "56a5892b-c7b3-48bb-80c6-68534e68a379",
                    "province": "Jakarta"
                },
                "total_listing": {
                    "sold": 4,
                    "online": 137,
                    "rented": 3
                },
                "area_specialist": []
            }
        ],
        "pagination": {
            "per_page": 16,
            "total_count": 1099,
            "current_page": 1,
            "has_next_page": true
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agents"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter or a range is invalid. This response is not billable.

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

Upstream Unavailable

Rumah123 could not be reached or returned data that does not match the request. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "agents"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Rumah123 could not be reached. Please retry shortly."
    },
    "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.