RocketNemovitosti

API pro import inzerátů

Rozhraní pro realitní kanceláře a výrobce realitního softwaru, kteří chtějí inzeráty na Rocket Nemovitosti vkládat a aktualizovat automaticky. Import funguje jako jednoduché REST API — jeden HTTP požadavek na inzerát, formát JSON.

Získání API klíče

Klíč si vytvoříte sami po přihlášení v sekci Můj účet → API klíče. Zobrazí se jedinkrát při vytvoření, uložte si ho bezpečně. Importované inzeráty se zakládají pod vaším účtem (a vaší realitní kanceláří, pokud v ní jste), klíč můžete kdykoli deaktivovat. S dotazy se ozvěte na obchod@rocketreality.cz.

Endpoint

POST https://rocketnemovitosti.cz/api/import/inzeraty
Authorization: Bearer {váš API klíč}
Content-Type: application/json

Každý požadavek odešle jeden inzerát. Opakované odeslání se stejným externalId stávající inzerát aktualizuje — duplicity nevznikají.

Pole požadavku

PoleTypPovinnéPopis
externalIdstringanoStálý identifikátor inzerátu ve vašem systému. Opakované odeslání se stejným externalId inzerát aktualizuje, nevytvoří duplicitu.
titlestringanoTitulek inzerátu.
sourceUrlstring (URL)neOdkaz na inzerát ve zdrojovém systému.
descriptionstring | nullnePopis nemovitosti v prostém textu.
offerType"sale" | "rent" | "auction" | "other"anoTyp nabídky — prodej, pronájem, dražba, jiné.
propertyTypestring | nullneDruh nemovitosti, např. "apartment", "house", "land", "commercial".
dispositionstring | nullu bytůDispozice bytu, např. "2+1", "3+kk", "pokoj". U kategorie byty je povinná — pokud ji neuvedete, zkusíme ji odvodit z názvu inzerátu.
pricenumber | nullneCena v Kč. Null znamená cenu na vyžádání.
priceNotestringnePoznámka k ceně, např. "k jednání" nebo "včetně provize".
currency"CZK"anoMěna ceny. Aktuálně podporujeme pouze CZK.
sizenumberneUžitná plocha v m².
locationobjektanoAdresa nemovitosti: street, city, postalCode, region. Do city lze uvést i městský obvod („Praha 4", „Brno-střed", „Moravská Ostrava a Přívoz") — obec dohledáme sami a obvod u inzerátu zachováme. Volitelně lat a lng — bez nich umístíme inzerát na střed obce, takže se na mapě překryje s ostatními. Volitelně také addressVisibility ("presna", "ulice", "obec") pro míru zpřesnění adresy na mapě.
photospole objektůanoFotografie jako { url, alt }. Adresy musí být veřejně dostupné — portál si fotografie stáhne při zpracování.
attributesobjektnePodrobné parametry nemovitosti — viz samostatná tabulka níže. Posílejte jen ta, která znáte.
agentobjekt | nullneKontakt na makléře: name, email, phone. Zobrazí se u inzerátu.

Parametry nemovitosti (attributes)

Všechny parametry jsou nepovinné — pošlete jen ty, které znáte. Nevyplněný parametr hodnotu na inzerátu nepřepíše, takže opakovaný import nezruší údaje doplněné ručně.

PoleHodnotyPopis
ownershiposobni | druzstevni | statni_obecniTyp vlastnictví.
buildingTypecihlova | panelova | drevostavba | skeletova | montovana | smisena | kamenna | jinaKonstrukce budovy.
buildingConditionnovostavba | velmi_dobry | dobry | spatny | ve_vystavbe | projekt | pred_rekonstrukci | v_rekonstrukci | po_rekonstrukci | k_demoliciStav budovy.
furnishingzarizeno | castecne_zarizeno | nezarizenoMíra vybavení.
energyLabelA … GEnergetická náročnost budovy.
priceUnitcelkem | za_m2 | za_mesic | za_m2_mesic | za_m2_rok | dohodouJednotka ceny. Bez uvedení se u pronájmů použije za_mesic, jinak celkem.
floorNumbernumberPodlaží, ve kterém se nemovitost nachází.
floorsTotalnumberPočet podlaží budovy.
builtUpAreanumberZastavěná plocha v m².
gardenAreanumberPlocha zahrady v m².
monthlyFeesnumberMěsíční poplatky v Kč.
depositnumberKauce v Kč (u pronájmů).
availableFromstring (datum)K nastěhování od. Přijímáme datum i datum s časem, uloží se datum.
orientationpole hodnotSvětové strany: sever, jih, vychod, zapad, severovychod, severozapad, jihovychod, jihozapad.
hasBalcony / balconyAreaboolean / numberBalkon a jeho plocha v m².
hasTerrace / terraceAreaboolean / numberTerasa a její plocha v m².
hasLoggia / loggiaAreaboolean / numberLodžie a její plocha v m².
hasCellar / cellarAreaboolean / numberSklep a jeho plocha v m².
hasElevatorbooleanVýtah v budově.
hasGarage / garageCountboolean / numberGaráž a počet stání.
hasParking / parkingCountboolean / numberParkování a počet míst.
barrierFreebooleanBezbariérový přístup.
videoUrlstring (URL)Odkaz na video prohlídku.
virtualTourUrlstring (URL)Odkaz na virtuální prohlídku.

Příklad požadavku

curl -X POST https://rocketnemovitosti.cz/api/import/inzeraty \
  -H "Authorization: Bearer VAS_API_KLIC" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "rk-1024",
    "sourceUrl": "https://www.vase-rk.cz/nemovitosti/rodinny-dum-opava",
    "title": "Rodinný dům 5+kk se zahradou, Opava",
    "description": "Prostorný dům s garáží a udržovanou zahradou…",
    "offerType": "sale",
    "propertyType": "house",
    "disposition": "5+kk",
    "price": 8900000,
    "priceNote": "k jednání",
    "currency": "CZK",
    "size": 145,
    "location": {
      "street": "Javorová 18",
      "city": "Opava",
      "postalCode": "74601",
      "region": "moravskoslezsky",
      "lat": 49.9387,
      "lng": 17.9026
    },
    "photos": [
      { "url": "https://www.vase-rk.cz/foto/dum-1.jpg", "alt": "Pohled na dům" }
    ],
    "attributes": {
      "ownership": "osobni",
      "buildingType": "cihlova",
      "buildingCondition": "po_rekonstrukci",
      "energyLabel": "C",
      "floorsTotal": 2,
      "gardenArea": 620,
      "hasGarage": true,
      "garageCount": 1,
      "orientation": ["jih", "zapad"]
    },
    "agent": {
      "name": "Jan Novák",
      "email": "jan.novak@vase-rk.cz",
      "phone": "+420 777 123 456"
    }
  }'

Odpovědi

StavVýznam
200Inzerát byl přijat ke zpracování (vytvoření nebo aktualizace).
401Chybějící nebo neplatný API klíč.
422Tělo požadavku neprošlo validací — odpověď obsahuje popis chyb.
429Příliš mnoho požadavků — zkuste to znovu později.
5xxChyba na naší straně — požadavek bezpečně zopakujte.

Moderace a zveřejnění

Importované inzeráty procházejí stejnou moderací jako inzeráty vložené ručně. Po schválení se zveřejní; aktualizace již schválených inzerátů se propisují automaticky. Za obsah inzerátů odpovídá inzerující kancelář — viz podmínky užití.