# Private Property Location Hierarchy

List the child locations of a location id. shape_id 1 returns the nine provinces, and each returned id can be passed back as shape_id to walk the whole South African location hierarchy.

- **Documentation:** [https://scrappa.co/docs/privateproperty-api/privateproperty_locations_children](https://scrappa.co/docs/privateproperty-api/privateproperty_locations_children)
- **API group:** Private Property API
- **Endpoint:** `GET https://scrappa.co/api/privateproperty/locations/children`

## 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 |
| --- | --- | --- | --- |
| `shape_id` | integer | Yes | Location id to expand. Use 1 for the provinces. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/privateproperty/locations/children?shape_id=1"
```

## Example response

```json
{
    "success": true,
    "shapes": [
        {
            "id": 2,
            "name": "KwaZulu Natal",
            "shapeType": 1
        }
    ]
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 503 | Upstream Unavailable | Private Property returned an unsuccessful, empty or malformed answer. |

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