---
title: "Location Vocabulary"
method: GET
path: "/fincaraiz/location-vocabulary"
tags: ["Fincaraiz"]
---

# Location Vocabulary

`GET /fincaraiz/location-vocabulary`

## Request

- Base URL: `https://scrappa.co/api`
- URL: `https://scrappa.co/api/fincaraiz/location-vocabulary`
- Auth: API key in header `X-API-KEY`

Departments, or the neighbourhoods of one department.

## Query parameters

- `estate_id` integer, nullable

## Response `200`

- union
  - string
  - object
    - `success` boolean, required
    - `error` object, required
      - `code` string, required
      - `message` 'Fincaraiz is temporarily unavailable. Please retry.' | 'Fincaraiz could not answer this query. Please retry.' | 'Fincaraiz returned an unreadable response. Please retry.' | 'Fincaraiz rejected the request from our egress pool. Please retry.', required
    - `meta` unknown[], required
      - unknown
  - object
  - object
    - `success` boolean, required
    - `error` object, required
      - `code` 'parser_drift', required
      - `message` 'Fincaraiz returned an unreadable response. Please retry.', required
    - `meta` unknown[], required
      - unknown
  - object
    - `success` boolean, required
    - `error` object, required
      - `code` 'unknown_filter', required
      - `message` 'estate_id must be an integer estate id from this endpoint.', required
    - `meta` unknown[], required
      - unknown

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `422`: estate_id was supplied but is not an integer. Non-billable.
- `503`: The platform answered successfully with a body this endpoint cannot read, so nothing is published and nothing is charged (`parser_drift`). Retryable. The upstream request failed after retries. Retryable and never billed.

---

[API](https://skmtc.dev/scrappa/apis/scrappa-api-documentation.md) · [All operations](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/revisions/31329f110e7c?raw)