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

Zameen Agency Profile API Documentation

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

Zameen Agency Profile API Get an agency by id: name (also in Urdu), logo, slug, city and locations, description, number of agents, listing counts for sale and rent, licenses, status, creation date and the phone numbers the agency publishes.

Zameen Agency Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zameen/agency
Auth header
x-api-key
Cost
1 credit/request
id = 1234567890
Response preview
200 OK
{
    "data": {
        "id": "190203",
        "city": "Karachi",
        "logo": "https://zameen-dev.s3.eu-west-1.amazonaws.com/image/164488781/bdddabcc806c4d78a7fa9bcca1d71a88",
        "name": "Ali Estate",
        "slug": "Karachi-Ali_Estate-190203-1",
        "phone": null,
        "active": true,
        "mobile": "+923000000000",
        "name_ur": "Ali Estate",
        "licenses": [],
        "whatsapp": null,
        "locations": [
...

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.

id string Required

Agency id, e.g. 190203. Use agency.id of a search result or id of the agencies endpoint.

Example value 1234567890

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": "190203",
        "city": "Karachi",
        "logo": "https://zameen-dev.s3.eu-west-1.amazonaws.com/image/164488781/bdddabcc806c4d78a7fa9bcca1d71a88",
        "name": "Ali Estate",
        "slug": "Karachi-Ali_Estate-190203-1",
        "phone": null,
        "active": true,
        "mobile": "+923000000000",
        "name_ur": "Ali Estate",
        "licenses": [],
        "whatsapp": null,
        "locations": [
            "Karachi"
        ],
        "created_at": null,
        "description": "After our clients have decided that they would like to use the services of a well-established real estate agency, choosing one of the best property agency is the next most vital assessment they will have to make. We completely look after your property investment with complete care. Managing a property business is a highly skilled and thought-provoking profession. A good real estate agency must have a unique knowledge and expertise of the local real estate sector, a complete understanding of construction, other related works, as well as strong personal skill for communicating between the property owner and service personnel. Our property professionals are dedicated and resourceful individuals who should know their area well, with an extensive list of trustworthy, skilled services to act upon.",
        "agents_count": 0,
        "listing_tier": "featured",
        "listing_counts": {
            "rent": 16,
            "sale": 45,
            "total": 61
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agency"
    },
    "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": {
        "id": [
            "An agency id is required, e.g. 190203. Get one from the search endpoint (agency.id) or the agencies endpoint."
        ]
    },
    "message": "The request validation failed"
}
404

Agency Not Found

The agency id does not exist. This response is not billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false
    },
    "error": {
        "message": "The requested Zameen agency was not found. Check the agency id.",
        "failure_type": "agency_not_found"
    },
    "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.