Přejít k obsahu|Přejít k hlavnímu menu

Report aktuální nabídky

Žádost a přidělení API klíče

API klíč je vázaný na registrovaného uživatele Visidoo.

Pokud jste registraci ještě neprovedli, tak ji naleznete pod odkazem Přihlášení v horním menu a následně odkazem Chci se registrovat v zobrazeném modalu. Dále postupujte podle instrukcí.

Po registraci zašlete žádost o přidělení API klíče pro registrovaný e-mail na adresu podpora@visidoo.cz. API klíč vám bude co nejdříve vygenerován.

Základní informace

  • HTTP metoda: POST
  • Endpoint: https://api.visidoo.com/v1/report/[id]
  • MIME typ: application/json
  • Autorizace: Authorization: Bearer [váš přidělený api klíč]
  • Id parametr v url: Vaše unikátní id pro dotaz

Příklad dotazu

{
    "filter": {
        "adType": "Sale",
        "area": {
            "gte": 0,
            "lte": null,
        },
        "disposition": ["2+1", "3+kk", "3+1"],
        "exactMatch": false,
        "houseType": [],
        "landArea": {
            "gte": 0,
            "lte": null,
        },
        "landType": [],
        "locationId": "",
        "price": {
            "gte": 0,
            "lte": 10000000,
        },
        "radius": 20,
        "realEstateType": "Apartment",
    }
}

Popis vstupních parametrů

Všechna následující pole jsou v dotazu povinná.

  • adType: string - Typ inzerátu, musí být jedno z: Sale (prodej), Rent (pronájem), Roommates (spolubydlení).
  • area: Rozsah plochy ve čtverečních metrech, platné pouze pro realEstateType: Apartment nebo realEstateType: House.
    • gte: number - Musí být větší rovno nule.
    • lte: number - Musí být větší než gte nebo null.
  • disposition: Array<string> - Textová reprezentace českého stylu dispozice, 1+kk, 1+1, 2+kk, 2+1, 3+kk, 3+1... Platné pouze pro realEstateType: Apartment. V případě prázdného pole se berou všechny varianty.
  • exactMatch: boolean - Pokud je true, pak ignoruje inzeráty, které úplně nesplňují zadané parametry, typicky např. inzeráty bez ceny.
  • houseType: Array<string> Typ domu, platné hodnoty jsou: Detached (samostatný), Terraced (řadový), Cottage (chalupa), Hut (chata). Platné pouze pro realEstateType: House. V případě prázdného pole se berou všechny varianty.
  • landArea: Rozsah plochy pozemku ve čtverečních metrech, platné pouze pro realEstateType: Land nebo realEstateType: House.
    • gte: number - Musí být větší rovno nule.
    • lte: number - Musí být větší než gte nebo null.
  • landType: Array<string> Typ pozemku, platné hodnoty jsou: BuildPlot (stavební), Commercial (komerční), Other (ostatní). Platné pouze pro realEstateType: Land. V případě prázdného pole se berou všechny varianty.
  • locationId: string ID lokality z OpenStreetMap s prefixem “-”, např. pro Brno je platná hodnota -438171. Podporované jsou oblasti, které mají boundary: administrative a admin_level do úrovně 10.
  • price:
    • gte: number - Musí být větší rovno nule.
    • lte: number - Musí být větší než gte nebo null.
  • radius: number - Okruh v kilometrech, který se přidá k zadané lokalitě, musí být větší rovno nule, stupně po 5, maximálně 50 (5, 10, 15...).
  • realEstateType: Typ nemovitosti, musí být jedno z: Apartment (byt), House (dům), Land (pozemek).

Příklad odpovědi

{
    "id": "d60fc7b7-96e4-48d0-bae0-975deb81239d",
    "updatedAt": 0,
    "realEstates": [
        {
            "adType": "Sale",
            "area": 33,
            "createdAt": 1661420462222,
            "disposition": null,
            "gps": [
                13.321192,
                49.691599
            ],
            "id": "9ec097db7c6b07857d5799b74f6633868a44161a",
            "imageUrl": "https://img4.realitymat.cz/image/3130532/50805399.jpg",
            "landArea": 624,
            "landType": null,
            "location": {
                "country": "Česko",
                "level": 10,
                "city": "Plzeň",
                "part": "Lhota u Dobřan",
                "district": "okres Plzeň-město",
                "name": "Lhota u Dobřan",
                "id": "-430611",
                "cohesion": "Jihozápad",
                "region": "Plzeňský kraj"
            },
            "origin": "Realitymat",
            "price": 4200000,
            "priceNote": "Cena konečná vč. všech poplatků. Pozemek stavební - nový dům či dostavba, sítě na pozemku.",
            "priceText": "4 200 000 Kč",
            "realEstateType": "House",
            "url": "https://www.realitymat.cz/detail/1015775/prodej-chaty-plzen-k-sinoru-33m2"
        },
        {
            "adType": "Sale",
            "area": 87,
            "createdAt": 1661420568362,
            "disposition": "3+1",
            "gps": [
                16.9312530556,
                50.0715169444
            ],
            "id": "3258d4a9dc0d5fd88d785244c6bfc85b8e7fee0c",
            "imageUrl": "https://reality.idnes.cz/file/thumbnail/630743e4a380692ab026d097?profile=front_detail_article_big_fit",
            "landArea": null,
            "landType": null,
            "location": {
                "country": "Česko",
                "level": 8,
                "city": "Hanušovice",
                "part": null,
                "district": "okres Šumperk",
                "name": "Hanušovice",
                "id": "-438323",
                "cohesion": "Střední Morava",
                "region": "Olomoucký kraj"
            },
            "origin": "iDnes reality",
            "price": 1990000,
            "priceNote": "včetně provize RK",
            "priceText": "1 990 000 Kč",
            "realEstateType": "Apartment",
            "url": "https://reality.idnes.cz/detail/prodej/byt/hanusovice-nadrazni/630743e2a380692ab026d094/"
        },
        {
            "adType": "Sale",
            "area": null,
            "createdAt": 1661420350122,
            "disposition": null,
            "gps": [
                18.4801783333,
                49.8587316667
            ],
            "id": "18f980d52f023addd78bc6554b2a781b37eaeb4a",
            "imageUrl": "https://reality.idnes.cz/file/thumbnail/630742dedf6a0c7abf43d518?profile=front_detail_article_big_fit",
            "landArea": 10165,
            "landType": "BuildPlot",
            "location": {
                "country": "Česko",
                "level": 8,
                "city": "Doubrava",
                "part": null,
                "district": "okres Karviná",
                "name": "Doubrava",
                "id": "-437919",
                "cohesion": "Moravskoslezsko",
                "region": "Moravskoslezský kraj"
            },
            "origin": "iDnes reality",
            "price": 240250,
            "priceNote": "Tržní odhad 1/2 podílu :480.500 Kč",
            "priceText": "240 250 Kč",
            "realEstateType": "Land",
            "url": "https://reality.idnes.cz/detail/prodej/pozemek/doubrava/630742dddf6a0c7abf43d516/"
        }
    ]
}

Popis výstupních parametrů

  • id: string - Vaše specifikované ID.
  • updatedAt: string - Čas v ISO8601, ke kterému jsou data platná.
  • realEstates: Array<RealEstate> - Pole objektů s nemovitostmi.