AthausDocs

Create a listing

Request, parameters, response and errors of POST /v1/listings.

Last updated:

Creates a listing. The body is the OpenImmo 2.0 listing; it is complete unless draft=true, which requires only metadata.source. Creating does not publish. An address with its unit, staircase and entrance belongs to one listing per office (409 address_already_exists, naming the listing that holds it); send data.location.unit to have several listings in one house; metadata.source.offererMarketingKey must be unique in the office (409 reference_already_exists). The plan limits the number of listings (403 plan_required). media names files uploaded with POST /medias (in order), contact is the contact person. Send Idempotency-Key to make a retry safe. Needs write access to listings.

Requires the scope propose.

Request

POST https://api.athaus.ai/v1/listings

Parameters

Query

NameTypeRequiredDescription
draftstringnoAccept an incomplete listing: only metadata.source is required, and the rest is checked when the listing is published. Ours, not OpenImmo. Default false.

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported.
Idempotency-KeystringnoMakes a retry safe: the same key with the same body returns the first answer and writes nothing twice. A random value of at least 128 bits, for example a UUID, 1 to 255 characters. The key is kept for 24 hours and scoped to the API key and this operation. The same key with a different body is a 422; while the first request still runs it is a 409. Only successful answers are kept: after an error the key is free again.

Request body

JSON with Content-Type: application/json. A field the API does not know is a 400, and errors[].name names the field. The body is required.

FieldTypeDescription
dataobject
data.estateTypestringOne of HOUSE, APARTMENT, PLOT, OFFICE, TRADING, GASTRONOMY_HOTEL, STORAGE_PRODUCTION, AGRICULTURE_FORESTRY, PARKING, SENIOR, PROJECT, MISCELLANEOUS.
data.estateSubTypeobject
data.distributionTypestringOne of BUY, RENT, COMPULSORY_AUCTION, BUY_AUCTION.
data.locationobject
data.location.postalcodestring
data.location.citystring
data.location.streetstring
data.location.houseNumberstring
data.location.unitstring
data.location.staircasestring
data.location.floorNumberinteger-5 to 999.
data.location.entrancestring
data.location.statestring
data.location.countrystringOne of 249 values from the list in the standard.
data.location.geometryobject
data.location.geometry.typestringAlways Point.
data.location.geometry.coordinatesnumber[]
data.location.showAddressbooleanDefault true.
data.location.locationNotemap<string>
data.pricesobject
data.prices.currencystringOne of 180 values from the list in the standard. Default EUR.
data.prices.buyobject
data.prices.buy.priceany
data.prices.buy.isLeaseBuyCombiboolean
data.prices.buy.leaseholdobject
data.prices.buy.operatingCostsany
data.prices.buy.rentalIncomeany
data.prices.buy.rentalIncomeExpectany
data.prices.buy.isParkingPriceIncludedboolean
data.prices.buy.parkingPricesany[]
data.prices.buy.pricePerSqUnitany
data.prices.buy.yieldFactornumber0 to 9999999999999.
data.prices.buy.countrySpecificobject
data.prices.rentobject
data.prices.rent.baseRentany
data.prices.rent.baseRentPerYearany
data.prices.rent.totalRentany
data.prices.rent.leaseany
data.prices.rent.operatingCostsany
data.prices.rent.heatingCostsany
data.prices.rent.isHeatingIncludedInOCboolean
data.prices.rent.isHeatingIncludedInTRboolean
data.prices.rent.pricePerSqUnitany
data.prices.rent.pricePerSqUnitPerYearany
data.prices.rent.priceTimeUnitstringOne of DAY, WEEK, MONTH, YEAR. Default MONTH.
data.prices.rent.isParkingPriceIncludedboolean
data.prices.rent.parkingPricesany[]
data.prices.rent.depositNotemap<string>
data.prices.rent.countrySpecificobject
data.prices.compulsoryAuctionobject
data.prices.compulsoryAuction.auctionProceedsany
data.prices.compulsoryAuction.biddingGuaranteeany
data.prices.compulsoryAuction.marketValueany
data.prices.compulsoryAuction.minimumBidany
data.prices.buyAuctionobject
data.prices.buyAuction.minPriceobject
data.prices.buyAuction.startOfferPhasestring (date)
data.prices.buyAuction.endOfferPhasestring (date)
data.prices.brokerageFeeany
data.prices.showPriceboolean
data.prices.priceNotemap<string>
data.prices.countrySpecificobject
data.prices.countrySpecific.frobject
data.spacesobject
data.spaces.spaceMeasureUnitstringOne of SQUARE_METER, SQUARE_INCH, SQUARE_FOOT, SQUARE_YARD, HECTARE, ACRE. Default SQUARE_METER.
data.spaces.buildingFrontnumber0 to 99999999.
data.spaces.kitchenSpacenumber0 to 99999999.
data.spaces.overallSpacenumber0 to 99999999.
data.spaces.usableFloorSpacenumber0 to 99999999.
data.spaces.spaceMaxnumber0 to 99999999.
data.spaces.spaceMinnumber0 to 99999999.
data.spaces.plotSpacenumber0 to 99999999.
data.spaces.plotFrontnumber0 to 99999999.
data.spaces.additionalSpacenumber0 to 99999999.
data.spaces.residentialobject
data.spaces.residential.livingSpacenumber0 to 99999999.
data.spaces.residential.livingRoomSpacenumber0 to 99999999.
data.spaces.residential.atticSpacenumber0 to 99999999.
data.spaces.residential.balconySpacenumber0 to 99999999.
data.spaces.residential.cellarSpacenumber0 to 99999999.
data.spaces.residential.gardenSpacenumber0 to 99999999.
data.spaces.residential.terraceSpacenumber0 to 99999999.
data.spaces.commercialobject
data.spaces.commercial.maxDivisiblenumber0 to 99999999.
data.spaces.commercial.minDivisiblenumber0 to 99999999.
data.spaces.commercial.commercialSpacenumber0 to 99999999.
data.spaces.commercial.shopSpacenumber0 to 99999999.
data.spaces.commercial.storageSpacenumber0 to 99999999.
data.spaces.commercial.sellSpacenumber0 to 99999999.
data.spaces.commercial.officeSpacenumber0 to 99999999.
data.spaces.commercial.officePartSpacenumber0 to 99999999.
data.spaces.commercial.managementSpacenumber0 to 99999999.
data.spaces.commercial.restaurantSpacenumber0 to 99999999.
data.spaces.commercial.countrySpecificobject
data.conditionsobject
data.conditions.buildStatestringOne of FIRST_TIME_USE, FIRST_TIME_USE_AFTER_REFURBISHMENT, MINT_CONDITION, MODERNISED, REFURBISHED, FULLY_RENOVATED, PARTLY_RENOVATED, NEED_OF_RENOVATION, WELL_KEPT, NEGOTIABLE, RIPE_FOR_DEMOLITION, PROJECTED, NO_INFORMATION, RESTRUCTURED, TO_RESTORE, TO_REFURBISH.
data.conditions.ageStatestringOne of OLD, NEW.
data.conditions.lastModernisationinteger
data.conditions.constructionStylestringOne of PREFABRICATED, SOLID, SOLID_PREFABRICATED, TIMBERHOUSE, WOOD_PREFABRICATED, UNSPECIFIED.
data.conditions.yearOfConstructioninteger1000 to 3000.
data.energyobject
data.energy.energyTypeobject
data.energy.energyType.heatMethodstringOne of CENTRAL, INDIVIDUAL, STOREY.
data.energy.energyType.heatFormobject
data.energy.energyType.energySourceobject
data.energy.energyType.energyGenerationobject
data.energy.energyType.maxElectricalPowerinteger
data.energy.countrySpecificobject
data.energy.countrySpecific.deobject
data.featuresobject
data.features.accessibleFromStreetstringOne of YES, NO, NOT_APPLICABLE.
data.features.airconditionstringOne of YES, PART, NO, NOT_APPLICABLE.
data.features.entranceHallstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCoveringobject
data.features.floorCovering.tilesstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.stonestringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.carpetstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.parquetstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.laminatestringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.syntheticstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.screedstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.linoleumstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.marblestringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.terracottastringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.granitestringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.raisedFloorstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.quartzstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.concretestringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.antiDustConcretestringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.woodenPlankstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.antiStaticstringOne of YES, NO, NOT_APPLICABLE.
data.features.floorCovering.vinylstringOne of YES, NO, NOT_APPLICABLE.
data.features.furnishedstringOne of PART, FULL, NO, NOT_APPLICABLE.
data.features.gardenobject
data.features.garden.partboolean
data.features.garden.privateboolean
data.features.garden.sharedboolean
data.features.gymstringOne of YES, NO, NOT_APPLICABLE.
data.features.internetobject
data.features.internet.internetSpeedMbitinteger0 to .
data.features.internet.internetAvailabilityobject
data.features.internet.propertyInternetAccessobject
data.features.lightingobject
data.features.lighting.ceilingstringOne of YES, NO, NOT_APPLICABLE.
data.features.lighting.ledstringOne of YES, NO, NOT_APPLICABLE.
data.features.lighting.windowstringOne of YES, NO, NOT_APPLICABLE.
data.features.mezzaninestringOne of YES, NO, NOT_APPLICABLE.
data.features.propertyOrientationstringOne of NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST.
data.features.receptioniststringOne of YES, NO, NOT_APPLICABLE.
data.features.securityobject
data.features.security.buildingIntercomstringOne of YES, NO, NOT_APPLICABLE, VIDEO, DOOR_PHONE.
data.features.security.camstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.custodianstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.custodianRoomstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.digitalLockstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.emergencyCallstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.fireSprinklerstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.fireAlarmstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.intruderAlarmstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.reinforcedDoorstringOne of YES, NO, NOT_APPLICABLE.
data.features.security.safestringOne of YES, NO, NOT_APPLICABLE.
data.features.wheelchairUsestringOne of YES, NO, NOT_APPLICABLE.
data.features.wineCellarstringOne of YES, NO, NOT_APPLICABLE.
data.features.residentialobject
data.features.residential.assistedLivingstringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.chimneystringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.flatSharePossiblestringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.hammamstringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.houseCleaningServicestringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.jacuzzistringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.loggiastringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.saunastringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.swimmingPoolstringOne of YES, NO, INSIDE, OUTSIDE, INSIDE_AND_OUTSIDE, NOT_APPLICABLE.
data.features.residential.tennisFieldstringOne of YES, NO, NOT_APPLICABLE, PRIVATE, SHARED.
data.features.residential.tvstringOne of SAT, CABLE, OTHER.
data.features.residential.verandastringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.laundryRoomstringOne of YES, NO, NOT_APPLICABLE.
data.features.residential.countrySpecificobject
data.features.commercialobject
data.features.commercial.accessibleByTrucksstringOne of YES, NO, NOT_APPLICABLE, SEPARATED_TRUCK_ACCESS.
data.features.commercial.auditoriumstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.barstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.buildingVentilationstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.cafeteriastringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.coldStorestringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.companyRestaurantstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.droppedCeilingstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.engineGeneratorstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.exhaustHoodstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.flexibleRoomLayoutstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.heatedTerracestringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.liftingPlatformstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.numberOfStorageCellsinteger0 to 999999.
data.features.commercial.overheadCranestringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.restaurantSeatsinteger0 to 999999.
data.features.commercial.restaurantSeatsOutsideinteger0 to 999999.
data.features.commercial.teaKitchenstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.truckManeuveringAreastringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.verticalSlidingDoorstringOne of YES, NO, NOT_APPLICABLE.
data.features.commercial.wallSidingstringOne of YES, NO, NOT_APPLICABLE, DOUBLE, DECORATIVE.
data.features.commercial.countrySpecificobject
data.features.parkingobject
data.features.parking.chargingStationstringOne of YES, NO, NOT_APPLICABLE.
data.features.parking.bikeParkingstringOne of YES, NO, NOT_APPLICABLE.
data.features.plotobject
data.features.plot.usageForobject
data.features.plot.developmentInfrastructureobject
data.features.plot.shortTermConstructiblestringOne of YES, NO, NOT_APPLICABLE.
data.features.plot.brownfieldstringOne of YES, NO, NOT_APPLICABLE.
data.features.plot.buildingPermissionstringOne of YES, NO, NOT_APPLICABLE.
data.features.plot.demolitionSuggestedstringOne of YES, NO, NOT_APPLICABLE.
data.features.plot.fencedPlotstringOne of YES, NO, NOT_APPLICABLE.
data.features.plot.isTerracedAreaboolean
data.features.plot.tiltstringOne of NONE, MINOR, SIGNIFICANT, STEEP.
data.features.plot.countrySpecificobject
data.structureobject
data.structure.buildingobject
data.structure.building.atticstringOne of CONVERTED, PART_CONVERTED, CONVERTIBLE, ISOLATED, ACCESSIBLE_WITH_FIXED_STAIRS.
data.structure.building.balconyDirectionstringOne of NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST.
data.structure.building.gardenOrientationstringOne of NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST.
data.structure.building.barrierFreestringOne of YES, NO, NOT_APPLICABLE.
data.structure.building.bathobject
data.structure.building.cellarstringOne of YES, NO, PART, NOT_APPLICABLE.
data.structure.building.elevatorobject
data.structure.building.kitchenobject
data.structure.building.numberOfFloorsinteger1 to 999.
data.structure.building.numberOfFacadesinteger1 to 999999.
data.structure.building.roomHeightnumber0 to .
data.structure.building.offeredFloorsinteger1 to 5.
data.structure.building.roofStylestringOne of HALF_HIPPED_ROOF, GAMBREL, MONO_PITCHED_ROOF, GABLE, HIP_ROOF, FLAT_ROOF, PYRAMIDAL_ROOF, OTHER.
data.structure.building.locationInBuildingstringOne of GROUNDFLOOR, HALF_BASEMENT, ROOF_STOREY.
data.structure.building.locationAtCornerstringOne of YES, NO, NOT_APPLICABLE.
data.structure.building.calmstringOne of YES, NO, NOT_APPLICABLE.
data.structure.building.withViewobject
data.structure.building.luminousstringOne of YES, NO, NOT_APPLICABLE.
data.structure.building.windowobject
data.structure.building.shapestringOne of L_SHAPE, U_SHAPE, V_SHAPE, RECTANGULAR, SQUARE, OTHER.
data.structure.building.hasSplitFloorboolean
data.structure.building.wallConstructionMaterialstring[]One of MASSIVE_WOOD, CINDER_BLOCK, INSULATING_CINDER_BLOCK, CELLULAR_CONCRETE, BRICK, HONEYCOMB_BRICK, LIMESTONE, WOOD_FRAME, METAL_FRAME.
data.structure.roomsobject
data.structure.rooms.numberOfRoomsnumber0 to 999999.
data.structure.rooms.numberOfBedRoomsinteger0 to 999999.
data.structure.rooms.numberOfBathRoomsinteger0 to 999999.
data.structure.rooms.numberOfToiletsinteger0 to 999999.
data.structure.rooms.numberOfBalconiesinteger0 to 999999.
data.structure.rooms.numberOfTerracesinteger0 to 999999.
data.structure.rooms.numberOfKitchensinteger0 to 999999.
data.structure.rooms.numberOfUnitsinteger0 to 999999.
data.structure.commercialobject
data.structure.commercial.floorLoadinteger
data.structure.commercial.floorLoadUpperFloorsnumber
data.structure.commercial.hallHeightnumber0 to .
data.structure.commercial.numberOfBedsinteger0 to 999999.
data.structure.commercial.numberOfLoadingDocksinteger0 to 999999.
data.structure.commercial.numberOfDesksinteger0 to 999999.
data.structure.commercial.numberOfMeetingRoomsinteger0 to 999999.
data.structure.commercial.numberOfOfficeRoomsinteger0 to 999999.
data.structure.commercial.windowFrontnumber0 to .
data.structure.parkingLotsobject
data.structure.parkingLots.outsideinteger0 to 999999.
data.structure.parkingLots.streetParkinginteger0 to 999999.
data.structure.parkingLots.carportinteger0 to 999999.
data.structure.parkingLots.garageinteger0 to 999999.
data.structure.parkingLots.doubleGarageinteger0 to 999999.
data.structure.parkingLots.duplexinteger0 to 999999.
data.structure.parkingLots.garageAreainteger0 to 999999.
data.structure.parkingLots.parkingAreainteger0 to 999999.
data.structure.parkingLots.carParkinteger0 to 999999.
data.structure.parkingLots.undergroundinteger0 to 999999.
data.structure.parkingLots.boatDockinteger0 to 999999.
data.textsobject
data.texts.headlinemap<string>
data.texts.descriptionmap<string>
data.texts.featuresmap<string>
data.texts.extendedInformationmap<string>
data.texts.areamap<string>
data.managementobject
data.management.isImmediatelyAvailableboolean
data.management.availableFromstring (date)
data.management.availableUntilstring (date)
data.management.isForInvestmentboolean
data.management.heritageProtectedstringOne of YES, NO, NOT_APPLICABLE.
data.management.marketStatusstringOne of SOLD, RENTED, REFERENCE, RESERVED, UNDER_OFFER.
data.management.projectStatusstringOne of BUILDING_PERMISSION, COMMERCIAL_LAUNCH, CONSTRUCTION_START, UNDER_CONSTRUCTION, SHELL_WORKS, FINISHING_WORKS, LAST_CHANCE, PROJECT_ENDED.
data.management.marketLabelstring
data.management.isRentedboolean
data.management.useForstringOne of LIVING, COMMERCIAL, MIXED, OFFICE, INDUSTRIAL.
data.management.isForHolidayRentalboolean
data.management.rentobject
data.management.rent.favouredGenderstringOne of MALE, FEMALE, OTHER.
data.management.rent.minRentalTimeinteger
data.management.rent.maxRentalTimeinteger
data.management.rent.rentalTimeUnitstringOne of DAY, WEEK, MONTH, YEAR.
data.management.rent.certificateOfEligibilityNeededstringOne of YES, NO, NOT_APPLICABLE.
data.management.rent.maxPersonsinteger
data.management.rent.nonSmokerstringOne of YES, NO, NOT_APPLICABLE.
data.management.rent.petsAllowedstringOne of YES, NO, NOT_APPLICABLE.
data.management.rent.isShortTimeRentalboolean
data.management.compulsoryAuctionobject
data.management.compulsoryAuction.auctionLocationstring
data.management.compulsoryAuction.auctionSpacestring
data.management.compulsoryAuction.cancellationDatestring (date)
data.management.compulsoryAuction.coOwnershipstring
data.management.compulsoryAuction.countyCourtstring
data.management.compulsoryAuction.dateOfAuctionstring (date)
data.management.compulsoryAuction.isDiscretionarySaleboolean
data.management.compulsoryAuction.distributionPlanNumberstring
data.management.compulsoryAuction.fileReferenceAtCountyCourtstring
data.management.compulsoryAuction.lastChangeDatestring (date)
data.management.compulsoryAuction.insolvencyAdministratorstring
data.management.compulsoryAuction.ownerstring
data.management.compulsoryAuction.recordationDatestring (date)
data.management.compulsoryAuction.additionalDatestring (date)
data.management.compulsoryAuction.isWithoutValueLimitsboolean
data.management.compulsoryAuction.isSplittingAuctionboolean
data.countrySpecificobject
data.countrySpecific.deobject
data.countrySpecific.frobject
data.countrySpecific.fr.businessobject
data.contactobject
data.contact.salutationstringOne of Mr, Mrs, Miss, Ms, Mx, Sir, Dame, Dr, Cllr, Lady, Lord.
data.contact.firstNamestring
data.contact.lastNamestring
data.contact.namestring
data.contact.emailAddressstring
data.contact.phoneNumberstring
data.contact.mobilePhoneNumberstring
data.contact.imageURLstring
data.contact.userHomepagestring
data.contact.postalCodestring
data.contact.citystring
data.contact.streetstring
data.contact.houseNumberstring
data.contact.countrystring
data.contact.preferredContactTypestringOne of ANONYMOUS, BY_PHONE, BY_EMAIL, OWN_WEBSITE.
data.contact.contactNotemap<string>
data.contact.displayedInformationobject
data.contact.displayedInformation.mainContactPersonobject
data.contact.displayedInformation.additionalContactPersonobject
data.linksobject
data.links.externalLinksobject[]
data.links.externalLinks[].urlstring
data.links.externalLinks[].urlTypestringOne of MAP, MOVIE, PANORAMA, REVOCATION_INSTRUCTION, OFFERER_DETAIL_PAGE.
data.links.externalLinks[].titlestring
data.links.virtualToursobject[]
data.links.virtualTours[].urlstring
data.links.virtualTours[].providerstring
data.links.virtualTours[].titlestring
metadataobject
metadata.sourceobject
metadata.source.offererMarketingKeystring
metadata.source.offererEstateIdstring
metadata.source.offererEstateGroupIdstring
metadata.portalWebKeystring
userDefinedobject[]
userDefined[].namestring
userDefined[].valuestring
userDefined[].utypstringOne of string, integer, boolean, decimal.
userDefined[].modusstring
mediaobject[]
media[].externalMediaIdstring
media[].titlestring
contactobject
contact.salutationstringOne of Mr, Mrs, Miss, Ms, Mx, Sir, Dame, Dr, Cllr, Lady, Lord.
contact.firstNamestring
contact.lastNamestring
contact.namestring
contact.emailAddressstring
contact.phoneNumberstring
contact.mobilePhoneNumberstring
contact.imageURLstring
contact.userHomepagestring
contact.postalCodestring
contact.citystring
contact.streetstring
contact.houseNumberstring
contact.countrystring
contact.preferredContactTypestringOne of ANONYMOUS, BY_PHONE, BY_EMAIL, OWN_WEBSITE.
contact.contactNotemap<string>
contact.displayedInformationobject
contact.displayedInformation.mainContactPersonobject
contact.displayedInformation.mainContactPerson.nameboolean
contact.displayedInformation.mainContactPerson.phoneboolean
contact.displayedInformation.mainContactPerson.mobilePhoneboolean
contact.displayedInformation.mainContactPerson.emailboolean
contact.displayedInformation.mainContactPerson.addressboolean
contact.displayedInformation.mainContactPerson.companyNameboolean
contact.displayedInformation.mainContactPerson.faxboolean
contact.displayedInformation.additionalContactPersonobject
contact.displayedInformation.additionalContactPerson.nameboolean
contact.displayedInformation.additionalContactPerson.phoneboolean
contact.displayedInformation.additionalContactPerson.mobilePhoneboolean
contact.displayedInformation.additionalContactPerson.emailboolean
contact.displayedInformation.additionalContactPerson.addressboolean
contact.displayedInformation.additionalContactPerson.companyNameboolean
contact.displayedInformation.additionalContactPerson.faxboolean

Example

curl -X POST "https://api.athaus.ai/v1/listings" \
  -H "Authorization: Bearer ath_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"data":{"estateType":"APARTMENT","estateSubType":{"apartment":"MULTI_STOREY"},"distributionType":"BUY","location":{"postalcode":"10435","city":"Berlin","street":"Kastanienallee","houseNumber":"12","country":"DEU","floorNumber":3,"geometry":{"type":"Point","coordinates":[13.4128,52.5395]}},"prices":{"currency":"EUR","buy":{"price":{"amount":350000}}},"spaces":{"spaceMeasureUnit":"SQUARE_METER","residential":{"livingSpace":62}},"structure":{"rooms":{"numberOfRooms":2,"numberOfBedRooms":1,"numberOfBathRooms":1}},"conditions":{"yearOfConstruction":1998},"texts":{"headline":{"de":"Helle Zweizimmerwohnung am Kastanienallee-Kiez","en":"Bright two-room flat"},"description":{"de":"Ruhige Wohnung im dritten Stock mit Balkon zum Hof."}}},"metadata":{"source":{"offererEstateId":"WE-12","offererMarketingKey":"WE-12"}},"userDefined":[{"name":"de.livingSpaceStandard","value":"WOFLV","utyp":"string"},{"name":"price.associationFee","value":"285.50","utyp":"decimal"}]}'

Response

On success the status is 202 with ListingReceipt.

ListingReceipt

FieldTypeDescription
requestIdstring
listingIdstring
externalListingIdstring
warningsobject[]
warnings[].typestring
warnings[].messagestring

Response headers

HeaderDescription
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.
Idempotent-Replayedtrue when this is the stored answer to an earlier request with the same Idempotency-Key.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400invalid_query, api_version_unsupported, invalid_body, profile_unsupportedInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409address_already_exists, reference_already_exists, idempotency_key_in_use, idempotency_outcome_unknownThe request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
413payload_too_largeThe request body is larger than 512 KB.
415invalid_inputThe request body is not JSON. Send Content-Type: application/json.
422idempotency_key_reusedThe idempotency key was already used with a different request body.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page