Query parameters

• advertisingCompanyId string
• advertisingCompanyTag string
• advertiserTag string
• statuses array[string]

  Allows you to filter the advertisements by status. Will return the ads with the selected statuses. The query parameter should be a valid JSON array. For example: ["open","reserved"]. This will return only the ads that are being publicly displayed.

  At least 1 element. Values are open, reserved, sold, lost, or inactive.

• advertiserId string
• page number(float)

  Minimum value is 1. Default value is 1.

• simplified boolean

  By default, we return complete records. If you set this to true, we will return just a simplified version of the records. Page size is 50 by default and 5000 when simplified.

Responses

• 200 application/json

  Advertisements successfully retrieved

  Hide response attributes Show response attributes object

  • success boolean Required
  • data array[object] Required
    Any of:

    object-1 object object-2 object

    Hide attributes Show attributes

    • thirdPartyId string

      Optional custom id that can later be used instead of normal id in insert, update, delete etc. endpoints

    • status string

      This field controls the publicity status of the ad. Ads with status open and reserved will be publicly visible. Others will be hidden. If the advertised property was sold, use status sold. If the advertised property failed to sell and should be hidden, use the status lost. If you don't have the information about whether the property was sold or failed to sell or you want to hide it for any other reason, use the status inactive. If not provided upon insertion, it will default to open.

      Values are open, reserved, sold, lost, or inactive.

    • type string Required

      Values are sell, rent, auction, or share.

    • advertiserId string Required

      Id of a company. It is either id that was provided in the response of the insert endpoint or it can be thirdPartyId, if it has been provided in the request body of the company insert endpoint.

    • advertisingCompanyId string | null

      Id of a company. It is either id that was provided in the response of the insert endpoint or it can be thirdPartyId, if it has been provided in the request body of the company insert endpoint.

    • price number(float) | null

      Use total price for type sell and monthly rent for type rent.

    • currency string | null

      Values are czk, usd, or eur.

    • priceNote string | null
    • location string Required

      Most accurate location description of a location. Preferably exact address in the format common for the given country. If that isn't possible, provide us with the most accurate location description possible. (eg. '{street name}, {city}')

    • locationAccuracy string | null

      Accuracy of the provided location. If not provided upon insertion, will default to exact.

      • If accuracy is missing or is set to exact we will display the exact location that was provided.
      • If accuracy is set to other value we will try to find the closest entity of provided type, if we don't find it we will display the nearest non-exact entity we can find (eg. street)

      Values are exact, street, municipality_part, municipality, cadastral_area, or nearest_non_exact_geo_entity.

    • description string | null
    • referenceId string | null

      Also known as 'advert_code' on other platforms.

    • matterportUrl string | null
    • possibleMoveInDate string(date-time) | null
    • estimatedOtherCosts number(float) | null
    • point object | null
      Hide point attributes Show point attributes object | null

      • latitude number(float) Required
      • longitude number(float) Required
      • Additional properties are NOT allowed

    • property object Required

      Any of:

      object-1 object object-2 object object-3 object object-4 object object-5 object

      Hide attributes Show attributes

      • type string Required

        Value is flat.

      • subType string Required

        Values are flat, atelier, non_residential_space, project, or other.

      • floor number(float) | null
      • ownership string | null

        Values are private, collective, national_or_municipal, mixed, or other.

      • disposition string | null

        Values are 1+kk, 1+1, 2+kk, 2+1, 3+kk, 3+1, 4+kk, 4+1, 5+kk, 5+1, larger, or atypic.

      • floorArea number(float) | null
      • utilityArea number(float) | null
      • constructionType string | null

        Values are brick, panel, wooden, stone, skelet, prefabricated, or other.

      • elevator boolean | null
      • floorsCount number(float) | null
      • balcony boolean | null
      • balconyArea number(float) | null
      • loggia boolean | null
      • loggiaArea number(float) | null
      • cellar boolean | null
      • cellarArea number(float) | null
      • terrace boolean | null
      • terraceArea number(float) | null
      • parkingSpace boolean | null
      • parkingSpaceCount number(float) | null
      • accessibility boolean | null
      • heatingKind array[string] | null

        Values are solid_fuels, gas, electric, heat_pump, stove_fireplace, heat_network, other, or under_floor.

      • energyClass string | null

        Values are A, B, C, D, E, F, or G.

      • sauna boolean | null
      • fireplace boolean | null
      • Additional properties are NOT allowed

      Hide attributes Show attributes

      • type string Required

        Value is building.

      • subType string Required

        Values are family_house, recreational_building, hut, cottage, farmstead, project, villa, or other.

      • ownership string | null

        Values are private, collective, national_or_municipal, mixed, or other.

      • landArea number(float) | null

        Minimum value is 1.

      • builtupArea number(float) | null

        Minimum value is 1.

      • separation string | null

        Values are terraced, corner, or stand_alone.

      • pool boolean | null
      • poolType string | null

        Values are sunken, semi_sunken, or above_ground.

      • pergola boolean | null
      • pergolaType string | null

        Values are classic, glassed, or bioclimatic.

      • heatPump boolean | null
      • heatPumpType string | null

        Values are air_air, air_water, water_water, or ground_water.

      • solarPanels boolean | null
      • solarPanelsArea number(float) | null
      • floorArea number(float) | null
      • utilityArea number(float) | null
      • constructionType string | null

        Values are brick, panel, wooden, stone, skelet, prefabricated, or other.

      • elevator boolean | null
      • floorsCount number(float) | null
      • balcony boolean | null
      • balconyArea number(float) | null
      • loggia boolean | null
      • loggiaArea number(float) | null
      • cellar boolean | null
      • cellarArea number(float) | null
      • terrace boolean | null
      • terraceArea number(float) | null
      • parkingSpace boolean | null
      • parkingSpaceCount number(float) | null
      • accessibility boolean | null
      • heatingKind array[string] | null

        Values are solid_fuels, gas, electric, heat_pump, stove_fireplace, heat_network, other, or under_floor.

      • energyClass string | null

        Values are A, B, C, D, E, F, or G.

      • sauna boolean | null
      • fireplace boolean | null
      • electricityConnection boolean | null
      • gasConnection boolean | null
      • sewerageConnection boolean | null
      • Additional properties are NOT allowed

      Hide attributes Show attributes

      • type string Required

        Value is commercial.

      • subType string Required

        Values are apartment_building, factory, warehouse, storage_unit, office, commercial_space, restaurant, housing, agricultural, virtual_office, doctors_office, or other.

      • ownership string | null

        Values are private, collective, national_or_municipal, mixed, or other.

      • solarPanels boolean | null
      • solarPanelsArea number(float) | null
      • floorArea number(float) | null
      • utilityArea number(float) | null
      • constructionType string | null

        Values are brick, panel, wooden, stone, skelet, prefabricated, or other.

      • elevator boolean | null
      • floorsCount number(float) | null
      • balcony boolean | null
      • balconyArea number(float) | null
      • loggia boolean | null
      • loggiaArea number(float) | null
      • cellar boolean | null
      • cellarArea number(float) | null
      • terrace boolean | null
      • terraceArea number(float) | null
      • parkingSpace boolean | null
      • parkingSpaceCount number(float) | null
      • accessibility boolean | null
      • heatingKind array[string] | null

        Values are solid_fuels, gas, electric, heat_pump, stove_fireplace, heat_network, other, or under_floor.

      • energyClass string | null

        Values are A, B, C, D, E, F, or G.

      • sauna boolean | null
      • fireplace boolean | null
      • electricityConnection boolean | null
      • gasConnection boolean | null
      • sewerageConnection boolean | null
      • Additional properties are NOT allowed

      Hide attributes Show attributes

      • type string Required

        Value is other.

      • subType string Required

        Values are parking_spot, garage, or other.

      • ownership string | null

        Values are private, collective, national_or_municipal, mixed, or other.

      • Additional properties are NOT allowed

      Hide attributes Show attributes

      • type string Required

        Value is parcel.

      • subType string Required

        Values are building_plot, commercial_land, field, meadow, forest, pond, garden, vineyard, orchard, or other.

      • ownership string | null

        Values are private, collective, national_or_municipal, mixed, or other.

      • area number(float) | null
      • electricityConnection boolean | null
      • gasConnection boolean | null
      • sewerageConnection boolean | null
      • Additional properties are NOT allowed
    • id string Required
    • advertiserThirdPartyId string
    • advertisingCompanyThirdPartyId string
    • previewUrl string
    • Additional properties are NOT allowed

    Hide attributes Show attributes

    • id string Required
    • thirdPartyId string
    • previewUrl string
    • Additional properties are NOT allowed
  • paginationInfo object Required
    Hide paginationInfo attributes Show paginationInfo attributes object

    • page number(float) Required
    • pages number(float) Required
    • Additional properties are NOT allowed
  • Additional properties are NOT allowed