Skip to content
Scrappa Get API key
Dot Property API 1 credit/request

Dot Property Agent API Documentation

GET https://scrappa.co/api/dotproperty/v1/agent

Dot Property Agent API returns one agent or agency profile as JSON: name, type, description, address, logo, background, website, number of available listings and the profile URL. Phone numbers and e-mail addresses are not public and are not returned. An unknown id returns 404.

Dot Property Agent API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/dotproperty/v1/agent
Auth header
x-api-key
Cost
1 credit/request
id = 1234567890
Response preview
200 OK
{
    "data": {
        "id": "00000000-ffff-4047-8001-000000000000",
        "url": "https://www.dotproperty.co.th/en/real-estate-agents/sukhothai-co-ltd_00000000-ffff-4047-8001-000000000000/properties-for-sale",
        "logo": "https://images.proppit.com/publisher/00000000-ffff-4047-8001-000000000000/logo.jpeg",
        "name": "Sukhothai Co., Ltd",
        "slug": "sukhothai-co-ltd",
        "type": "agency",
        "address": "Bangkok, Thailand",
        "is_paid": true,
        "website": null,
        "is_active": true,
        "background": null,
        "description": "Company with many high quality real estate projects with many years of excellent management",
...

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.

1 optional filter available.

id string Required

Agent or agency uuid from the Agents route. Example: 00000000-ffff-4047-8001-000000000000.

Example value 1234567890
slug string Optional

Optional name slug from the Agents route. Example: sukhothai-co-ltd.

Example value example

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": {
        "id": "00000000-ffff-4047-8001-000000000000",
        "url": "https://www.dotproperty.co.th/en/real-estate-agents/sukhothai-co-ltd_00000000-ffff-4047-8001-000000000000/properties-for-sale",
        "logo": "https://images.proppit.com/publisher/00000000-ffff-4047-8001-000000000000/logo.jpeg",
        "name": "Sukhothai Co., Ltd",
        "slug": "sukhothai-co-ltd",
        "type": "agency",
        "address": "Bangkok, Thailand",
        "is_paid": true,
        "website": null,
        "is_active": true,
        "background": null,
        "description": "Company with many high quality real estate projects with many years of excellent management",
        "available_listings": 20
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agent"
    },
    "success": true
}

Errors

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

422

Validation Error

The id is missing or is not an agent uuid. This response is not billable.

{
    "errors": {
        "page": [
            "The page field must not be greater than 333."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The agent does not exist. This response is not billable.

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

Upstream Unavailable

Dot Property 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": "agent"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Dot Property 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.