Exclusive Transaction Creation

POST comparables/exclusive/transactions

Creates a new exclusive transaction.

Example Request#

curl -X POST 'https://api.pricehubble.com/api/v1/comparables/exclusive/transactions' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
    "countryCode": "CH",
    "sourceTransactionId": "233d82c5-df0d-47ad-ba8a-f6b71e150460",
    "transaction": {
        "transactionDate": "2021-08-10",
        "transactionsStatus": "sold",
        "salePrice": 1000000
    },
    "images": [
        "a2b158e6-8570-4cdb-9105-454773335a49.jpg",
        "1c16d1c1-ade6-4d96-b5a6-df97d5931523.png"
    ],
    "property": {
        "location": {
            "coordinates": {
                "latitude": 47.4,
                "longitude": 8.54
            },
            "address": {
                "postCode": "8008",
                "street": "Klausstrasse",
                "city": "Zurich"
            }
        },
        "propertyType": {
            "code": "apartment"
        },
        "livingArea": 50
    }
}'

Request fields#

Field	Description	Type	Remarks
countryCode	ISO country code	string
sourceTransactionId	Your source id, that can be used to delete or update the transaction (most often it is the id used in the client CRM)	string
sourceOfferId	CRM offer id	string
dossierId	Id of the dossier associated with this transaction	string	If this field is provided, the transaction will not be visible on the search endpoint
description	Transaction description	string
label	Transaction label	string	Max length 10 characters
images	Transaction images	array of image path	To upload image use Exclusive Comparables Images API
fullSourceData	Raw value for transaction in JSON format	json
property	Information about the property	Exclusive Comparables Property
transaction	Information about the transaction	Exclusive Comparables Transaction

Example Response#

{
    "uuid": "6ac48dd5-bf91-4e66-b121-e98a4ed37cea",
    "sourceTransactionId": "23e4c547-4072-4027-b65d-435b922d5fae",
    "sourceOfferId": "",
    "description": "",
    "images": [
        {
            "url": "http://some-domain.com/a2b158e6-8570-4cdb-9105-454773335a49.jpg",
            "filename": "a2b158e6-8570-4cdb-9105-454773335a49.jpg"
        },
    ],
    "property": {
        "volume": null,
        "numberOfFloorsInBuilding": null,
        "buildingYear": null,
        "isNew": null,
        "propertyType": {
            "code": "apartment",
            "subcode": ""
        },
        "landArea": null,
        "hasLift": null,
        "floorNumber": null,
        "livingArea": 50.0,
        "numberOfRooms": null,
        "hasParkingSpaces": null,
        "numberOfIndoorParkingSpaces": null,
        "numberOfOutdoorParkingSpaces": null,
        "numberOfBathrooms": null,
        "isWheelchairAccessible": null,
        "numberOfBedrooms": null,
        "isFurnished": null,
        "renovationYear": null,
        "energyLabel": "",
        "hasPool": null,
        "hasSauna": null,
        "balconyArea": null,
        "gardenArea": null,
        "basementType": "",
        "basementSurface": null,
        "hasConcierge": null,
        "furnishedKitchen": null,
        "hasAirconditioning": null,
        "hasHeating": null,
        "centralisedHeating": null,
        "hasSolarPanels": null,
        "heatingType": "",
        "heatingSource": "",
        "view": "",
        "orientation": "",
        "isRented": null,
        "location": {
            "coordinates": {
                "latitude": 47.4,
                "longitude": 8.54
            },
            "address": {
                "postCode": "8008",
                "street": "Klausstrasse",
                "city": "Zurich",
                "houseNumber": ""
            }
        },
        "quality": {
            "kitchen": "",
            "bathrooms": "",
            "flooring": "",
            "windows": "",
            "masonry": "",
            "roof": ""
        },
        "condition": {
            "property": "",
            "kitchen": "",
            "bathrooms": "",
            "flooring": "",
            "windows": "",
            "masonry": "",
            "roof": "",
            "elec": "",
            "plumbing": ""
        }
    },
    "transaction": {
        "transactionDate": "2021-08-10",
        "salePrice": 1000000.0,
        "originalOfferPrice": null,
        "transactionsStatus": "sold",
        "preSaleDate": null,
        "feesAmount": null
    },
    "fullSourceData": {},
    "countryCode": "CH"
}

Response fields#

Field	Description	Type	Remarks
uuid	The id used within PriceHubble database to identify a transaction	string
countryCode	ISO country code	string
sourceTransactionId	This is the id you provided when creating the transaction (most often it is the id used in the client CRM). It can be used to delete or update the transaction	string
sourceOfferId	CRM offer id	string
dossierId	Id of the dossier associated with this transaction	string
description	Transaction description	string
label	Transaction label	string	Max length 10 characters
images	Transaction images	array of Generic Images
fullSourceData	raw value for transaction in JSON format	json
property	Information about the property	Exclusive Comparables Property
transaction	Information about the transaction	Exclusive Comparables Transaction

Property#

Field	Description	Type	Remarks
location	Property location	Location
propertyType	Property type	PropertyType
livingArea	Net living area	float	In m² For `UK`: in sq.ft Required for all countries, except in `UK`
buildingYear	The year the property was built	integer
landArea	Total area of the lot/parcel on which the house is standing	float	In m² For `UK`: in acres
balconyArea	Balcony / Terrace area	float	In m² For `UK`: in sq.ft
gardenArea	Garden area	float	In m² For `UK`: in sq.ft
volume	Volume	float	In m³ For `UK`: in cu.ft
volumeStandard	Volume standard	string	Only for `house`, only relevant for `CH` Possible values: `building_insurance`, `sia116`, `sia416`
numberOfRooms	Number of rooms	float
numberOfBedrooms	Number of bedrooms	integer
numberOfBathrooms	Number of bathrooms	integer
isWheelchairAccessible	Is wheelchair accessible	boolean
numberOfIndoorParkingSpaces	Garage spaces	integer
numberOfOutdoorParkingSpaces	Parking spaces	integer
floorNumber	Floor number	integer
hasLift	Lift availability	boolean
energyLabel	Energy label	string	Valid values for DE: `A++`, `A+`, `A` .. `H`. For NL: `A+++`, `A++`, `A+`, `A` .. `G`. For CH: `minergie`, `minergie_p`, `minergie_a`, `minergie_eco`, `minergie_p_eco`, `minergie_a_eco`. For `BE`: `A++`, `A+`, `A` .. `G`. For others: `A` .. `G`.
hasSauna	Sauna availability	boolean
hasPool	Pool availability	boolean
numberOfFloorsInBuilding	Total number of floors of the building	integer
isFurnished	Whether the property is furnished or not	boolean
isNew	Whether the property has never been used before ("Bâtiment neuf" in French, "Erstverkauf" / "Erstvermietung" in German)	boolean
renovationYear	Last renovation year of the property	integer
basementType	Basement type	string	Valid values are `livable`, `not_livable` or `other`
basementSurface	Basement surface	float	In m² For `UK`: in sq.ft
hasConcierge	Has concierge	boolean
furnishedKitchen	Has furnished kitchen	boolean
hasAirconditioning	Has air conditioning	boolean
hasHeating	Has heating	boolean
hasSolarPanels	If the building has solar panels	boolean
heatingType	Heating type	string	Valid values are `soil`, `wall`, `radiator`, `air` or `other`
heatingSource	Heating source	string	Valid values are `electric`, `gas`, `heat_pump`, `oil`, `wood` or `other`
view	View	string	Valid values are `clear`, `partially_clear`, `obstructed` or `other`
orientation	Property orientation	string	Any combination of N, S, E, and W from 1 to 4 characters and max one occurance.
isRented	Is rented	boolean
centralisedHeating	Has centralised heating	boolean
condition.bathrooms	Bathrooms condition	Condition
condition.kitchen	Kitchen condition	Condition
condition.flooring	Flooring condition	Condition
condition.windows	Windows condition	Condition
condition.property	Property condition	Condition
condition.masonry	Masonry condition	Condition
condition.roof	Roof condition	Condition
condition.elec	Electricity condition	Condition
condition.plumbing	Plumbing condition	Condition
quality.bathrooms	Bathrooms quality	Quality
quality.kitchen	Kitchen quality	Quality
quality.flooring	Flooring quality	Quality
quality.windows	Windows quality	Quality
quality.masonry	Masonry quality	Quality
quality.roof	Roof quality	Quality

Transaction#

Field	Description	Type	Remarks
transactionDate	Transaction date	date	Format: `YYYY-MM-DD`
salePrice	Sale price	float
transactionsStatus	Transaction status	string	Valid values are `pre_sale` or `sold`
originalOfferPrice	Original offer price	float
preSaleDate	Pre-sale date	date	Format: `YYYY-MM-DD`
feesAmount	Fees amount	float