Skip to main content

FlatFilterDTO

Apartment filter request body. Pagination plus optional filters — every list filter is ignored when empty, and all filters are combined with AND.

pageint32

Page number, 1-based. Min 1.

Possible values: >= 1

Default value: 1
Example: 1
sizeint32

Page size. Min 1, max 100.

Possible values: >= 1 and <= 100

Default value: 15
Example: 15
orders object

Sort order. Each key is a sort field — ID, NUMBER, FLOOR, AREA, PRICE, STATUS or CREATED_TIMESTAMP (see FlatOrderField) — and each value a direction. Keys are applied in the order they appear in the JSON object. Unless ID is one of the keys, a trailing ID ASC tie-breaker is appended so paging stays stable. Omit (or send {}) to sort by ID ASC only.

property name*string

Possible values: [ASC, DESC]

idsint32[]

Filter by apartment IDs (optional).

Example: [1024,1025]
houseIdsint32[]

Filter by house (project) IDs — see GET /v1/open-api/house/all.

Example: [144]
buildingIdsint32[]

Filter by building (block) IDs.

Example: [34]
currencyIdsint32[]

Filter by the house's currency IDs.

Example: [1]
searchstring

Case-insensitive partial match on the apartment number.

Example: 45
numberstring

Apartment number — exact match.

Example: 45
statusesCommerceStatus[]

Filter by commercial status.

Possible values: [SALE, BOOKED, SOLD, RESERVE, DELIVERED, REGISTERED]

categoriesFlatCategory[]

Filter by apartment class.

Possible values: [ECONOMICAL, COMFORT, BUSINESS, PREMIUM]

nonResidentialTypesNonResidentialType[]

Filter by non-residential unit type.

Possible values: [BASEMENT, SHOP, PARKING, APARTMENT]

roomsstring[]

Filter by room count — stored as text, so send strings ("2", "3").

Example: ["2","3"]
floorFromint32

Lower bound (inclusive) for floor.

Example: 2
floorToint32

Upper bound (inclusive) for floor.

Example: 9
areaFromdouble

Lower bound (inclusive) for area, m².

Example: 45.5
areaTodouble

Upper bound (inclusive) for area, m².

Example: 80
priceFromdouble

Lower bound (inclusive) for price, in the house's currency.

Example: 500000000
priceTodouble

Upper bound (inclusive) for price, in the house's currency.

Example: 1200000000
repairedbooleannullable

Only repaired (true) or only non-repaired (false) apartments. null (omit) — don't filter.

Example: true
apartmentbooleannullable

Only apartment-type (true) or only non-apartment (false) units. null (omit) — don't filter.

Example: true
FlatFilterDTO
{
  "page": 1,
  "size": 15,
  "orders": {
    "FLOOR": "ASC",
    "NUMBER": "ASC"
  },
  "ids": [
    1024,
    1025
  ],
  "houseIds": [
    144
  ],
  "buildingIds": [
    34
  ],
  "currencyIds": [
    1
  ],
  "search": "45",
  "number": "45",
  "statuses": [
    "SALE"
  ],
  "categories": [
    "COMFORT"
  ],
  "nonResidentialTypes": [
    "SHOP"
  ],
  "rooms": [
    "2",
    "3"
  ],
  "floorFrom": 2,
  "floorTo": 9,
  "areaFrom": 45.5,
  "areaTo": 80,
  "priceFrom": 500000000,
  "priceTo": 1200000000,
  "repaired": true,
  "apartment": true
}