Official documentation for the Spotto API. In this section you can find some examples with which you can play in the Postman application.
\nFull documentation of the models can be found at Spotto's API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Intro","slug":"intro"}],"owner":"18726022","collectionId":"c4a73504-6106-4d70-b77f-b640a74d5227","publishedId":"2s93CNPE23","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF729D"},"publishDate":"2023-03-22T14:47:25.000Z"},"item":[{"name":"Partner API","item":[{"name":"Sale","id":"1870bf7b-becd-4cd6-8325-5f70416c8627","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"uniqueReference\": \"P-immo-penthouse-2\",\r\n \"partnerId\": \"cea456ae-b0e6-4b10-982a-957f7337d705\",\r\n \"inputModel\": {\r\n \"propertyInfo\": {\r\n \"type\": \"Apartment\",\r\n \"subType\": \"Penthouse\",\r\n \"purposeType\": \"unknown\",\r\n \"newBuildType\": \"NoNewBuild\",\r\n \"propertyIdentifiers\": {\r\n \"capakeys\": [],\r\n \"basisRegisterUnitIDs\": [],\r\n \"basisRegisterBuildingIDs\": []\r\n },\r\n \"fiscalInfo\": {\r\n \"cadastralIncomeNotIndexed\": 892,\r\n \"cadastralIncomeIndexed\": 0\r\n },\r\n \"energyEfficiencyInfo\": {\r\n \"epcScoreInKwhPerSquareMeterPerYear\": 173,\r\n \"epcLabel\": \"B\"\r\n },\r\n \"permitInfo\": {\r\n \"permitType\": \"unknown\",\r\n \"subdivisionPermitType\": \"NoPermitAvailable\",\r\n \"constructionOffenseType\": \"unknown\",\r\n \"constructionOffenseSubpoenaType\": \"unknown\",\r\n \"areaDesignationType\": \"unknown\"\r\n },\r\n \"featureIndicationInfo\": {\r\n \"isCoOwnership\": false,\r\n \"isInvestmentProperty\": true,\r\n \"isKangerooCompatible\": true,\r\n \"isCoHousingCompatible\": true,\r\n \"isWheelchairCompatible\": true,\r\n \"isUsableForHomePractice\": true,\r\n \"hasHomeAutomation\": false,\r\n \"hasGroundWaterWell\": true,\r\n \"hasRainWaterWell\": true,\r\n \"hasShowroom\": true,\r\n \"hasVentilation\": false\r\n },\r\n \"parcelInfo\": {\r\n \"parcelDepthInMeters\": 0,\r\n \"parcelWidthInMeters\": 0,\r\n \"parcelFloodProneType\": \"unknown\",\r\n \"soilCertificateResultType\": \"unknown\",\r\n \"amountOfTotalPlotSquareMeters\": 0,\r\n \"amountOfBuiltSquareMeters\": 0,\r\n \"amountOfGardenSquareMeters\": 0,\r\n \"amountOfTerraceSquareMeters\": 5,\r\n \"orientationFrontFacade\": \"unknown\",\r\n \"orientationGarden\": \"unknown\",\r\n \"orientationTerrace\": \"unknown\"\r\n },\r\n \"constructionInfo\": {\r\n \"conditionStateType\": \"AsNew\",\r\n \"constructionYear\": 2011,\r\n \"unitFloorLevel\": 3,\r\n \"facadeCount\": 2,\r\n \"facadeWidthInMeters\": 0,\r\n \"amountOfIndoorSquareMeters\": 84,\r\n \"amountOfGarages\": 0,\r\n \"amountOfParkingSpots\": 1,\r\n \"amountOfFloors\": 3,\r\n \"amountOfBedrooms\": 2,\r\n \"amountOfBathrooms\": 0,\r\n \"amountOfShowerRooms\": 1,\r\n \"amountOfToilets\": 1,\r\n \"outfittingInfo\": { \r\n \"flooring\": {\r\n \"flooringTypes\": [\"unknown\"]\r\n },\r\n \"kitchen\": {\r\n \"kitchenType\": \"unknown\",\r\n \"kitchenOutfittingType\": \"WellEquiped\",\r\n \"kitchenConditionType\": \"unknown\"\r\n },\r\n \"windows\": {\r\n \"windowConditionType\": \"unknown\",\r\n \"windowFrameMaterial\": \"unknown\",\r\n \"windowGlazingType\": \"StandardDouble\",\r\n \"hasShutters\": false\r\n },\r\n \"heatingAndSanitary\": {\r\n \"conditionType\": \"unknown\",\r\n \"primaryHeatingType\": \"unknown\",\r\n \"primaryHeatingSource\": \"unknown\",\r\n \"primaryHeatingFuel\": \"unknown\",\r\n \"primaryHeatingDevice\": \"unknown\",\r\n \"fuelTankType\": \"unknown\",\r\n \"hotWaterHeatingType\": \"unknown\",\r\n \"hotWaterHeatingSource\": \"unknown\"\r\n },\r\n \"sewage\": {\r\n \"hasSepticTank\": false,\r\n \"sewageCouplingType\": \"unknown\"\r\n }\r\n }\r\n },\r\n \"apartmentBlockInfo\": {\r\n \"totalAmountOfFloors\": 3,\r\n \"hasElevator\": true,\r\n \"hasIntercom\": true\r\n },\r\n \"newBuildProjectInfo\": {\r\n },\r\n \"descriptions\": [{\r\n \"type\": \"Title\",\r\n \"languageCode\": \"NL\",\r\n \"value\": \"Instapklaar appartement - 2 slaapkamers - ondergrondse parking en berging\"\r\n },\r\n {\r\n \"type\": \"DetailedDescription\",\r\n \"languageCode\": \"NL\",\r\n \"value\": \"Stijlvol en hoogwaardig afgewerkt appartement met een leuk terras in Genk centrum. Dit appartement maakt deel uit van een kleinschalig appartementencomplex Residentie Mark gelegen aan de Nieuwstraat - pal in het centrum. Dit vrij recente appartement is gelegen op de derde (bovenste) verdieping en beschikt over een lift, een ondergrondse autostaanplaats en een ondergrondse kelderberging. Indeling: 3e verdieping via lift - inkomhal met vestiaire - nachtgang/overloop - ruime, rechthoekige woonkamer met een tegelvloer - aansluitende open keuken voorzien van alle comfort (ceramische kookplaat, dampkap, oven, vaatwasser en koelkast) - terras aan voorzijde (westelijke oriëntatie = avondzon) - berging/wasplaats met toegang tot extra grote bergzolder via vlizo trap - gastentoilet met wasbakje - 2 slaapkamers met (slaapkamers bevinden zich aan de achterzijde van het appartement) - badkamer uitgerust met een douche(wand) in ligbad, wastafel in meubel - Lage gemeenschappelijke kosten: €50 per maand Extra troeven: - uiterst centrale ligging - pal in het centrum van Genk - stijlvolle, kleinschalige residentie (slechts 8 appartementen) - perfect onderhouden appartement voorzien van alle comfortThis is an example of how a sale can be sent to postman.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"subscription-key"},{"key":"value","value":"This is an example of how a rent can be sent to postman.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"subscription-key"},{"key":"value","value":"This is an example of how a property can be archived / deleted fromt he website.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"subscription-key"},{"key":"value","value":"Gets the status of the property with regards to importing it into the Spotto system.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"subscription-key"},{"key":"value","value":"Get the contact notifications for a specified property.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"subscription-key"},{"key":"value","value":"Get the statistics for a specified property.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"subscription-key"},{"key":"value","value":"Properties can be created with the a post-call. You can also use this to update an existing property, just make sure to use the same unique reference. You will also need to use this call to archive a property.
\nOnce a property has been sent to our server, it will have to be picked up by our importer. You can check the status of the importer by calling import result call.
\nThe importer runs every hour. So it can take up to 60 minutes for your property to be processed.
\nYou can get contact notifications from the contact-me call. You can use this to show the contact messages in your CRM / application.
\nIf you want to display statistics about a property, you should use the statistics call.
\nThe next flows are required to work on the staging environment before you can create publications on production:
\nCreate a for-rent publication
\nCreate a for-sale publication
\nCreate a project publication
\nCreate a project-unit publication
\nUpdate a single publication
\nRemove a publication
\nProcess a contact-me
\nTake into account that our API works on a per-publication way. There is no possibility to quickly upload all properties. For updates, this means that they should be sent through on a per-publication basis as well.
\nWe advise to sent updates once or twice a day rather than for every change. Our system only processes the updates at set times of the day.
\nTo give the seller / renter a good publication on Spotto, the next fields are required to be sent:
\nTransaction type
\nProperty state
\nNumber of bedrooms
\nLivable area
\nParcel area
\nEPC value (A, B, C ...)
\nDetailed description
\nAddress
\nLocation (X & Y coordinates)
\nThe next fields we highly advise to sent but are not required:
\nPrice
\nNumber of bathrooms
\nNumber of livings
\nYear built
\nYear renovated
\nSubtype
\nThe detailed description allows for basic HTML-tags. You can use this to create a more entertaining description by using lists, emphesis and links.
\nRealtors are allowed to advertise their recently sold/rented properties for up to two weeks. To accomplish this, send the property with the correct transaction type (rent/sale) and the availability option set to Unavailable. The two weeks start counting from the moment the property was first sent with these properties.
\nWe use the location coordinates to display the property on a map and show the map on
\nContains calls for usage as CRM
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"subscription-key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8f289626-8a64-4456-821c-3a98bb276924","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e29c506b-dde5-49f0-83dd-45b4f8323e40","type":"text/javascript","exec":[""]}}],"_postman_id":"dad50879-1ef2-443e-8040-1b82b00a7177"},{"name":"Portals","item":[],"id":"4d0ef9e9-54da-4255-879e-c92647a5f6bb","_postman_id":"4d0ef9e9-54da-4255-879e-c92647a5f6bb","description":""}]}