Skip to content

Sign in Sign up

Address check

GETapi.baseray.ai/v1/public/address-search

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

countrycz | dk | rorequired: cz (Czechia) or ro (Romania).
qstringrequired: The address text, e.g. Vinohradská 12.

Response 200

OK

itemsarray of objectrequired

idstring (uuid)required
slugstringrequired: The building's slug; its page exists only when indexable is true.
labelstringrequired: The address on one line.
indexablebooleanrequired: True when the building has a public page; otherwise its facts are shown only after signing in.

Errors

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.

Every error has the same shape. Error codes.

Request

curl "https://api.baseray.ai/v1/public/address-search?country=cz&q=Vinohradsk%C3%A1%2012"

const response = await fetch("https://api.baseray.ai/v1/public/address-search?country=cz&q=Vinohradsk%C3%A1%2012", {
  method: "GET",
});
const result = await response.json();

import os
import requests

response = requests.get(
    "https://api.baseray.ai/v1/public/address-search",
    params={"country": "cz", "q": "Vinohradská 12"},
    timeout=30,
)
response.raise_for_status()
result = response.json()

Response 200

{
  "items": [
    {
      "id": "c9eefd1b-8c8d-48fe-8b72-e015374d7720",
      "slug": "praha-vinohradska-12",
      "label": "Vinohradská 1200/12, 120 00 Praha 2",
      "indexable": true
    }
  ]
}