# Aqarmap Compound Search API Documentation

Scrappa's `GET /api/aqarmap/compounds` finds Aqarmap compounds and developments by name and returns `id`, `name` and `slug`. A name with no match returns an empty list and is a valid, billable result.

- **Documentation:** [https://scrappa.co/docs/aqarmap-api/aqarmap_compounds](https://scrappa.co/docs/aqarmap-api/aqarmap_compounds)
- **API group:** Aqarmap API
- **Endpoint:** `GET https://scrappa.co/api/aqarmap/compounds`

## 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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Start of a compound name, at least 2 characters, for example palm. |
| `lang` | string | No | en (default) or ar. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/aqarmap/compounds?q=palm"
```

## Example response

```json
{
    "success": true,
    "data": {
        "compounds": [
            {
                "id": 2138544,
                "name": "Palm Hills New Cairo",
                "slug": "projects-palm-hills-new-cairo"
            }
        ]
    },
    "meta": {
        "endpoint_family": "compounds",
        "billable": true,
        "duration_ms": 360
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable. |
| 503 | Upstream Unavailable | Aqarmap could not be reached after retries, refused the request or answered with a body this API cannot read safely (`UPSTREAM_UNAVAILABLE`). Never billed. Retry when `meta.retryable` is true. |

## 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)