---
title: "Address check"
method: GET
path: "/public/address-search"
tags: ["Public building pages"]
---

# Address check

`GET /public/address-search`

## Request

- Base URL: `https://api.baseray.ai/v1`
- URL: `https://api.baseray.ai/v1/public/address-search`
- Auth: none required

Up to ten addressed buildings matching a text, for the free address check. A building without a public page is returned with `indexable` false.

## Query parameters

- `country` 'cz' | 'dk' | 'ro', required
- `q` string, required

## Response `200`

OK

- PublicAddressSearchResult: Up to ten addressed buildings matching the text.
  - `items` object[], required
    - `id` string, uuid, required
    - `slug` string, required: The building's slug; its page exists only when `indexable` is true.
    - `label` string, required: The address on one line.
    - `indexable` boolean, required: True when the building has a public page; otherwise its facts are shown only after signing in.

## Other responses

- `400`: A query parameter is missing or malformed (`invalid_parameter`).
- `429`: Too many requests from this address in a minute (`rate_limited`); retry after `Retry-After` seconds.
- `503`: The building catalogue is unavailable right now (`unavailable`); retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/baseray/apis/baseray-api.md) · [All operations](https://skmtc.dev/baseray/apis/baseray-api/llms.txt) · [OpenAPI document](https://skmtc.dev/baseray/apis/baseray-api/revisions/2dc2808717f7?raw)