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

Aqar Agent API Documentation

GET https://scrappa.co/api/aqar/agent

Aqar Agent API returns an advertiser and their published ads. Aqar has no profile page, so the profile is built from the public advertiser data of their ads: name, avatar, rating, paid-member flag, the number of reviews and the number of active listings. Send the user_id from advertiser.id of a search item or a listing. The listings list uses the same item shape as the search route and pages with page and size.

An id with no published ads returns a 404 error, because Aqar cannot tell it from an unknown id. Phone numbers and other contact fields are never returned. Failed requests are not billed.

Aqar Agent API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/aqar/agent
Auth header
x-api-key
Cost
1 credit/request
user_id = 1234567890
Response preview
200 OK
{
    "data": {
        "agent": {
            "id": 5329101,
            "name": "Test Advertiser",
            "avatar": null,
            "rating": 5,
            "paid_member": true,
            "reviews_total": 3,
            "active_listings_total": 21
        },
        "listings": [
            {
                "id": 6881689,
...

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.

2 optional filters available.

user_id integer Required

Advertiser id from advertiser.id of a search item or a listing. Example: 5329101.

Example value 1234567890
page integer Optional

One-based page number for the listings (default 1).

Example value 1
size integer Optional

Listings 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": {
        "agent": {
            "id": 5329101,
            "name": "Test Advertiser",
            "avatar": null,
            "rating": 5,
            "paid_member": true,
            "reviews_total": 3,
            "active_listings_total": 21
        },
        "listings": [
            {
                "id": 6881689,
                "age": 4,
                "url": "https://sa.aqar.fm/ad/6881689",
                "area": 119,
                "price": {
                    "value": 85000,
                    "currency": "SAR"
                },
                "images": [
                    {
                        "large": "https://images.aqar.fm/webp/1200x0/props/053291010_1789805952556.jpg",
                        "small": "https://images.aqar.fm/webp/350x0/props/053291010_1789805952556.jpg",
                        "medium": "https://images.aqar.fm/webp/750x0/props/053291010_1789805952556.jpg"
                    }
                ],
                "city_id": 21,
                "bedrooms": 3,
                "location": {
                    "latitude": 24.808927,
                    "longitude": 46.597436
                },
                "bathrooms": 0,
                "furnished": false,
                "published": true,
                "unit_code": null,
                "advertiser": {
                    "id": 5329101,
                    "name": "Test Advertiser",
                    "avatar": null,
                    "rating": 5,
                    "paid_member": true
                },
                "created_at": "2026-09-19T08:23:20Z",
                "category_id": 1,
                "description": "\u0634\u0642\u0629 \u0641\u064a \u0645\u062c\u0645\u0639 \u0647\u0627\u062f\u064a \u0648 \u0631\u0627\u0642\u064a \u062a\u062a\u0643\u0648\u0646 \u0645\u0646 \u062b\u0644\u0627\u062b \u063a\u0631\u0641 \u0646\u0648\u0645 \u062b\u0644\u0627\u062b \u062f\u0648\u0631\u0627\u062a \u0645\u064a\u0627\u0629 \n\u0645\u0637\u0628\u062e \u0631\u0627\u0643\u0628 \n\u0645\u062f\u062e\u0644\u064a\u0646 \n\u0645\u0648\u0642\u0641 \u062e\u0627\u0635\u2026",
                "district_id": 570,
                "meter_price": null,
                "rent_period": "yearly",
                "listing_type": "rent",
                "living_rooms": 0,
                "street_width": null,
                "property_type": "apartment",
                "description_en": "apartment in a quiet and upscale compound consisting of three bedrooms, three bathrooms, a\u2026"
            }
        ],
        "pagination": {
            "from": 0,
            "page": 1,
            "size": 1,
            "total": 21,
            "total_pages": 21,
            "has_next_page": true
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agent"
    },
    "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": {
        "user_id": [
            "The user id field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The advertiser has no published ads. 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

Aqar 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": "Aqar 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.