properties

GET

property

properties

curl --request GET \
  --url https://api.example.com/property/properties \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/property/properties', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/property/properties",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/property/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/property/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "property_id": 123,
    "sk_properties": 123,
    "property_id_name": "<string>",
    "obj_name": "<string>",
    "entrance_1": "<string>",
    "entrance_2": "<string>",
    "entrance_3": "<string>",
    "entrance_4": "<string>",
    "entrance_5": "<string>",
    "adr1_combined": "<string>",
    "postcode": "<string>",
    "adr_city": "<string>",
    "city": "<string>",
    "country": "<string>",
    "construction_year": 123,
    "longitude": 123,
    "latitude": 123,
    "state_name": "<string>",
    "use_type": "<string>",
    "property_type": "<string>",
    "tax_model": "<string>",
    "fibu": 123,
    "begin_mandate": "2023-12-25",
    "end_mandate": "2023-12-25"
  }
]

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Missing required filter(s): ['property_id']",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "API key required",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "Invalid or disabled API key",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Category or table not found",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "query -> offset: Input should be greater than or equal to 0",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Rate limit exceeded: 500 per 1 hour",
  "instance": "/property/properties"
}

Authorizations

X-API-Key

string

header

required

Query Parameters

limit

integer

default:1000

Maximum number of rows to return (max 100,000). Use offset for subsequent pages.

Required range: 1 <= x <= 100000

offset

integer

default:0

Number of rows to skip (max 500,000). Use with limit for pagination. Results are returned in a stable order (configured sort key per table, fallback to physical row order) — pages are gapless and duplicate-free as long as the dataset does not change between requests. The response headers X-Total-Count, X-Has-More and X-Next-Offset contain pagination metadata. For large datasets use filters or /raw/{table_name} for full-table exports.

Required range: 0 <= x <= 500000

cursor

string

Opaque pagination cursor from the X-Next-Cursor response header of the previous page. Cannot be combined with offset > 0. When X-Next-Cursor is absent in the response, all rows have been fetched.

property_id

string

Filter by property_id

city

string

Filter by city

use_type

string

Filter by use_type

property_type

string

Filter by property_type

Response

Successful Response

property_id

integer

sk_properties

integer

property_id_name

string

obj_name

string

entrance_1

string

entrance_2

string

entrance_3

string

entrance_4

string

entrance_5

string

adr1_combined

string

postcode

string

adr_city

string

city

string

country

string

construction_year

integer

longitude

number

latitude

number

state_name

string

use_type

string

property_type

string

tax_model

string

fibu

integer

begin_mandate

string<date>

end_mandate

string<date>

⌘I

properties

curl --request GET \
  --url https://api.example.com/property/properties \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/property/properties', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/property/properties",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/property/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/property/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "property_id": 123,
    "sk_properties": 123,
    "property_id_name": "<string>",
    "obj_name": "<string>",
    "entrance_1": "<string>",
    "entrance_2": "<string>",
    "entrance_3": "<string>",
    "entrance_4": "<string>",
    "entrance_5": "<string>",
    "adr1_combined": "<string>",
    "postcode": "<string>",
    "adr_city": "<string>",
    "city": "<string>",
    "country": "<string>",
    "construction_year": 123,
    "longitude": 123,
    "latitude": 123,
    "state_name": "<string>",
    "use_type": "<string>",
    "property_type": "<string>",
    "tax_model": "<string>",
    "fibu": 123,
    "begin_mandate": "2023-12-25",
    "end_mandate": "2023-12-25"
  }
]

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Missing required filter(s): ['property_id']",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "API key required",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "Invalid or disabled API key",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Category or table not found",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "query -> offset: Input should be greater than or equal to 0",
  "instance": "/property/properties"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Rate limit exceeded: 500 per 1 hour",
  "instance": "/property/properties"
}

Overview

Endpoints

Authorizations

Query Parameters

Response