# Fincaraiz Location Vocabulary API Documentation

Scrappa's `GET /api/fincaraiz/location-vocabulary` enumerates the platform's location vocabulary — every department, or the neighbourhoods inside one department.

Call it without parameters for the full department list, or pass `estate_id` to list that department's neighbourhoods. Each neighbourhood carries its parent department, so you can build a two-level picker from two calls.

These numeric ids belong to the platform's own vocabulary. They are **not** the UUIDs the search endpoint takes — see route-resolver for the translation.

- **Documentation:** [https://scrappa.co/docs/fincaraiz-api/fincaraiz_location_vocabulary](https://scrappa.co/docs/fincaraiz-api/fincaraiz_location_vocabulary)
- **API group:** Fincaraiz API
- **Endpoint:** `GET https://scrappa.co/api/fincaraiz/location-vocabulary`

## 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 |
| --- | --- | --- | --- |
| `estate_id` | integer | No | Department id. Omit to list every department. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/fincaraiz/location-vocabulary?estate_id=40"
```

## Example response

```json
{
    "success": true,
    "estate_id": 40,
    "returned": 2,
    "neighborhoods": [
        {
            "id": 101,
            "name": "La Candelaria",
            "estate": {
                "id": 40
            }
        }
    ],
    "meta": {
        "billable": true,
        "endpoint_family": "location-vocabulary",
        "attempts": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 503 | Unreadable Response | The platform answered successfully with a body this endpoint cannot read, so nothing is published and nothing is charged (`parser_drift`). Retryable. |
| 422 | Validation Error | estate_id was supplied but is not an integer. Non-billable. |
| 503 | Upstream Unavailable | The upstream request failed after retries. Retryable and never billed. |

## Frequently asked questions

### How many departments are there?

The vocabulary returns the complete set of Colombian departments in one call, with no pagination.

## Related endpoints

- [Location Record](https://scrappa.co/docs/fincaraiz-api/fincaraiz_location)
- [Location Autocomplete](https://scrappa.co/docs/fincaraiz-api/fincaraiz_location_autocomplete)

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