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

Zameen Agency Directory API Documentation

GET https://scrappa.co/api/zameen/agencies

Zameen Agency Directory API List agencies, or find agencies with a text in their name. Agencies with the most listings come first. Each row has the same fields as the agency profile. Page times per_page must be at most 10,000.

Zameen Agency Directory API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zameen/agencies
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "page": 1,
        "count": 20,
        "query": "ali",
        "agencies": [
            {
                "id": "47422616",
                "city": null,
                "logo": null,
                "name": null,
                "slug": "dha_phase_1_sector_b1_al-mannan_spanish_villas_popular_villas_available_for_sale-47422616-20637-1",
                "phone": "+9251111333333",
                "active": null,
...

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.

3 optional filters available.

query string Optional

Optional. Text in the agency name, 2 to 100 characters, e.g. ali. Without it, all agencies are listed.

Example value coffee shops
page integer Optional

Page number, from 1 (default 1). Page times per_page must be at most 10,000.

Example value 1
per_page integer Optional

Rows per page, 1 to 50 (default 20).

Example value 10

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": {
        "page": 1,
        "count": 20,
        "query": "ali",
        "agencies": [
            {
                "id": "47422616",
                "city": null,
                "logo": null,
                "name": null,
                "slug": "dha_phase_1_sector_b1_al-mannan_spanish_villas_popular_villas_available_for_sale-47422616-20637-1",
                "phone": "+9251111333333",
                "active": null,
                "mobile": "+923000000000",
                "name_ur": null,
                "licenses": [],
                "whatsapp": null,
                "locations": [],
                "created_at": null,
                "description": null,
                "agents_count": null,
                "listing_tier": "premium",
                "listing_counts": {
                    "rent": null,
                    "sale": null,
                    "total": null
                }
            }
        ],
        "has_more": true,
        "per_page": 20,
        "total_count": 347,
        "total_pages": 18
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agencies"
    },
    "success": true
}

Errors

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

422

Validation Error

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

{
    "errors": {
        "per_page": [
            "The per page must not be greater than 50."
        ]
    },
    "message": "The request validation failed"
}
422

Result Window Exceeded

Page times per_page is above 10,000. Zameen search reaches only the first 10,000 results. Narrow the filters or lower the page. This response is not billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false
    },
    "error": {
        "message": "Zameen returns at most the first 10,000 results of a search. Narrow the filters or lower the page number.",
        "failure_type": "result_window_exceeded"
    },
    "success": false
}
503

Temporarily Unavailable

Zameen did not answer or refused the request after several attempts. This response is not billable. Retry after a short pause.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": true
    },
    "error": {
        "message": "Zameen data is temporarily unavailable. Please retry.",
        "failure_type": "upstream_unavailable"
    },
    "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.