# Aqar Agent API Documentation

<p><strong>Aqar Agent API</strong> 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 <code>user_id</code> from <code>advertiser.id</code> of a search item or a listing. The <code>listings</code> list uses the same item shape as the search route and pages with <code>page</code> and <code>size</code>.</p><p>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.</p>

- **Documentation:** [https://scrappa.co/docs/aqar-api/aqar_agent](https://scrappa.co/docs/aqar-api/aqar_agent)
- **API group:** Aqar API
- **Endpoint:** `GET https://scrappa.co/api/aqar/agent`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `user_id` | integer | Yes | Advertiser id from advertiser.id of a search item or a listing. Example: 5329101. |
| `page` | integer | No | One-based page number for the listings (default 1). |
| `size` | integer | No | Listings per page, 1 to 50 (default 20). |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a range is invalid. This response is not billable. |
| 404 | Not Found | The advertiser has no published ads. This response is not billable. |
| 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. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)