### Example GET Request for Sales Results Source: https://developer.domain.com.au/docs/latest/apis/pkg_properties_locations/references/salesresults_head This snippet shows an example of how to make a GET request to the /v1/salesResults/_head endpoint to retrieve weekly sales results. It specifies the base URL and the endpoint path. ```http GET https://api.domain.com.au/v1/salesResults/_head ``` -------------------------------- ### Retrieve Product Disclaimers via HTTP GET Source: https://developer.domain.com.au/docs/latest/apis/pkg_properties_locations/references/disclaimers_getbyproduct An example of an HTTP GET request to fetch disclaimers for the 'PropertyData' product and the corresponding JSON response structure. ```http GET https://api.domain.com.au/v1/disclaimers/product/PropertyData ``` ```json [ { "id": "APMCopyright", "version": "1", "text": "Copyright © 2017 Australian Property Monitors. This data is published and compiled by Australian Property Monitors Pty Ltd and in compiling this publication the publisher also relies on the information supplied by a number of external sources.", "imageurl": "", "authorityname": "APM Copyright" }, { "id": "PSMA", "version": "1", "text": "CadastralLite (c) PSMA Australia Pty Ltd. PSMA Australia do not warrant the accuracy or completeness of information in this product and any person using or relying upon such information does so on the basis that PSMA Australia shall bear no responsibility or liability whatsoever for any errors, faults, defects or omissions in the information.", "imageurl": "http://www.apmpropertydata.com.au/images/psma.gif", "authorityname": "PSMA" } ] ``` -------------------------------- ### Retrieve paginated resources via GET request Source: https://developer.domain.com.au/docs/latest/conventions/pagination Demonstrates how to request a specific page of results using query parameters in a GET request. The example retrieves the first page of agencies matching a search query. ```HTTP GET /v1/agencies/?q=Pyrmont&pageNumber=1&pageSize=10 HTTP/1.1 ``` -------------------------------- ### Retrieve Project Statistics (JSON Example) Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/projects_getstatistics This is an example of the JSON response when retrieving statistics for a specific project using the GET /v1/projects/{id}/statistics endpoint. It includes summary statistics and a daily breakdown. ```json { "summary": { "totalPhotoViews": 0, "totalFloorplanViews": 0, "totalMapViews": 0, "totalVideoViews": 0, "totalAgentDetailViews": 0, "totalSearchCarouselViews": 0, "totalAgentPhoneNumberReveals": 0, "totalEnquiries": 0, "totalEmailToFriend": 0, "totalSharedViaSocialMedia": 0, "totalInspectionTimeSaving": 0, "totalCallToAgentFromMobile": 0, "devProjectId": 0, "totalViews": 0, "totalIndividualImageViews": 0, "totalAdClick": 0, "totalClicksToProjectListing": 0, "totalExternalWebsiteViews": 0, "totalEmailEnquiries": 0 }, "dailyBreakdown": [ { "totalPhotoViews": 0, "totalFloorplanViews": 0, "totalMapViews": 0, "totalVideoViews": 0, "totalAgentDetailViews": 0, "totalSearchCarouselViews": 0, "totalAgentPhoneNumberReveals": 0, "totalEnquiries": 0, "totalEmailToFriend": 0, "totalSharedViaSocialMedia": 0, "totalInspectionTimeSaving": 0, "totalCallToAgentFromMobile": 0, "devProjectId": 0, "totalViews": 0, "totalIndividualImageViews": 0, "totalAdClick": 0, "totalClicksToProjectListing": 0, "totalExternalWebsiteViews": 0, "totalEmailEnquiries": 0, "eventDate": "2026-03-17T22:38:28.128Z" } ] } ``` -------------------------------- ### Search Projects API Request Source: https://developer.domain.com.au/docs/latest/apis/pkg_property/references/projects_search An example of an HTTP GET request to the /v1/projects endpoint. It demonstrates how to filter projects by agencyId. ```http GET https://api.domain.com.au/v1/projects?agencyId=26995 ``` -------------------------------- ### Example GET Request for Agent Listings Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/agents_getlistings This snippet shows a basic HTTP GET request to retrieve listings for a specific agent. It demonstrates the URL structure and the expected parameters. ```http GET https://api.domain.com.au/v1/agents/1281068/listings ``` -------------------------------- ### Example Response for Listing Details Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/listings_get Provides an example JSON response when successfully retrieving listing details. This structure includes property types, status, address, advertiser information, media, and pricing. ```json { "objective": "rent", "propertyTypes": ["apartmentUnitFlat"], "status": "live", "saleMode": "rent", "channel": "residential", "addressParts": { "stateAbbreviation": "nsw", "displayType": "fullAddress", "streetNumber": "65", "unitNumber": "6", "street": "Albert Crescent", "suburb": "Burwood", "suburbId": 7832, "postcode": "2134", "displayAddress": "6/65 Albert Crescent, Burwood NSW 2134" }, "advertiserIdentifiers": { "advertiserType": "agency", "advertiserId": 4299, "contactIds": [744066, 1298529] }, "bathrooms": 1.0, "bedrooms": 1.0, "carspaces": 0.0, "dateAvailable": "2016-11-22", "dateUpdated": "2016-11-07T04:32:08.107Z", "description": "1 Bedroom unit, combined lounge and dining, neat kitchen and bathroom, share laundry, only minutes walk to station and shops.", "energyEfficiencyRating": 0, "geoLocation": { "latitude": -33.8777593, "longitude": 151.1082707 }, "headline": "Inspect Saturday 12/11/16 - 10:00am - 10:15am", "id": 6311594, "inspectionDetails": { "inspections": [], "isByAppointmentOnly": true }, "isNewDevelopment": false, "media": [{ "category": "image", "type": "photo", "url": "https://bucket-api.domain.com.au/v1/bucket/image/w89-h60-6311594_1_propertyphoto_161107_043109" }], "priceDetails": { "canDisplayPrice": false, "displayPrice": "$320" }, "seoUrl": "https://www.domain.com.au/6-65-albert-crescent-burwood-nsw-2134-6311594" } ``` -------------------------------- ### GET Agent Statistics Request Example Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/agents_getstatistics An example of how to make a GET request to retrieve statistics for a specific agent's listings. This includes the base URL, agent ID, and optional query parameters for time period and status filter. ```HTTP GET https://api.domain.com.au/v1/agents/744066/statistics?timePeriod=last7Days&statusFilter=live ``` -------------------------------- ### Example GET Request for Listing Details Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/listings_get Demonstrates how to make a GET request to retrieve the details of a specific listing using its ID. This is a fundamental operation for accessing property information. ```http GET https://api.domain.com.au/v1/listings/6311594 ``` -------------------------------- ### Demographics API GET Request Example Source: https://developer.domain.com.au/docs/latest/apis/pkg_property/references/demographics_get_bynamedsuburb This example demonstrates how to make a GET request to the Demographics API to retrieve demographic data for a specific location. It includes path parameters for state, suburb, and postcode, as well as query parameters for year and data types. The response is expected in JSON format. ```http GET /v2/demographics/NSW/Pyrmont/2009?year=2021&types=AgeGroupOfPopulation,HousingLoanRepayment HTTP/1.1 Host: api.developer.domain.com.au Authorization: Bearer YOUR_API_KEY ``` -------------------------------- ### GET /v1/properties/{propertyId}/priceEstimate Response Example (Success) Source: https://developer.domain.com.au/docs/latest/apis/pkg_price_estimation/references/properties_getpriceestimate Example of a successful response from the price estimate endpoint. It includes price confidence, date, and price ranges. ```json { "priceConfidence": "recentlySold", "date": "2017-07-03", "lowerPrice": 327500000, "upperPrice": 327500000, "midPrice": 327500000, "history": [ { "date": "2017-10-02T01:12:31.001+11:00" } ] } ``` -------------------------------- ### Example GET Request for Agent Search Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/agents_search This snippet demonstrates how to make a GET request to the /v1/agents/search endpoint to find agents by name. It includes a query parameter for the search term. The API returns a list of matching agents with their basic details. ```HTTP GET https://api.domain.com.au/v1/agents/search?query=John ``` -------------------------------- ### Example Response for Agent Listings Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/agents_getlistings This snippet provides an example of the JSON response structure when successfully retrieving agent listings. It includes details about property objectives, types, status, address, advertiser information, and media. ```json [ { "objective": "rent", "propertyTypes": ["apartmentUnitFlat"], "status": "live", "saleMode": "rent", "channel": "residential", "addressParts": { "stateAbbreviation": "nsw", "displayType": "fullAddress", "streetNumber": "65", "unitNumber": "6", "street": "Albert Crescent", "suburb": "Burwood", "suburbId": 7832, "postcode": "2134", "displayAddress": "6/65 Albert Crescent, Burwood NSW 2134" }, "advertiserIdentifiers": { "advertiserType": "agency", "advertiserId": 4299, "contactIds": [744066, 1298529] }, "bathrooms": 1.0, "bedrooms": 1.0, "carspaces": 0.0, "dateAvailable": "2016-11-22", "dateUpdated": "2016-11-07T04:32:08.107Z", "description": "1 Bedroom unit, combined lounge and dining, neat kitchen and bathroom, share laundry, only minutes walk to station and shops.", "energyEfficiencyRating": 0, "geoLocation": { "latitude": -33.8777593, "longitude": 151.1082707 }, "headline": "Inspect Saturday 12/11/16 - 10:00am - 10:15am", "id": 6311594, "inspectionDetails": { "inspections": [], "isByAppointmentOnly": true }, "isNewDevelopment": false, "media": [ { "category": "image", "type": "photo", "url": "https://bucket-api.domain.com.au/v1/bucket/image/w89-h60-6311594_1_propertyphoto_161107_043109" } ], "priceDetails": { "canDisplayPrice": false, "displayPrice": "$320" }, "seoUrl": "https://www.domain.com.au/6-65-albert-crescent-burwood-nsw-2134-6311594" } ] ``` -------------------------------- ### Example GET Request for Subscription Details Source: https://developer.domain.com.au/docs/latest/apis/pkg_webhooks/references/webhooks_getsubscription This snippet shows an example of how to make a GET request to retrieve the details of a specific subscription. It requires the subscription ID as a path parameter. ```http GET https://api.domain.com.au/v1/subscriptions/d8e45297f6364abdaaefba86aa67cf6d ``` -------------------------------- ### Example Project Listing Response (JSON) Source: https://developer.domain.com.au/docs/latest/apis/pkg_property/references/projects_getchildlistings This JSON structure represents a single property listing returned by the Domain.com.au API. It includes detailed information about the property, such as its objective (sale/rent), property types, status, address, advertiser details, number of bedrooms, bathrooms, car spaces, description, geographical location, and inspection schedules. ```JSON [ { "objective": "sale", "propertyTypes": [ "newApartments" ], "status": "archived", "saleMode": "archived", "channel": "residential", "addressParts": { "stateAbbreviation": "nsw", "displayType": "fullAddress", "streetNumber": "100-102", "street": "Elliott Street", "suburb": "Balmain", "postcode": "2041", "displayAddress": "100-102 Elliott Street, Balmain NSW 2041" }, "advertiserIdentifiers": { "advertiserType": "agency", "advertiserId": 26995 }, "apmIdentifiers": { "suburbId": 1872 }, "bathrooms": 2, "bedrooms": 3, "carspaces": 3, "dateUpdated": "2016-11-25T23:32:35Z", "description": "Embracing the Harbour and surrounded by Balmain peninsula’s village charms, this is a rare opportunity to live right on Sydney’s iconic harbourfront in a resort-inspired haven. \r\n\r\nCome home to a beautifully crafted cosmopolitan retreat in a truly iconic setting. Designed by award winning Bates Smart, each apartment has its own relationship to the vistas with deeply framed views and glimpses over the gardens, park and treetops out towards the harbour. Embedded in the landscape, the architecture has one overriding goal in mind – offering residents view-filled apartments in a luxurious environment that will instantly make them feel at home. A waterfront pool creates an amazing residents-only amenity right on the Harbour. Sun loungers line the stylish sandstone paved pool terrace for basking in the sun, in addition to a well-equipped gymnasium.\r\n\r\nWarmth and elegance are the bywords for Harbourfront Balmain’s beautifully finished spaces. Choose from either of two luxuriously natural colour palettes – Harbour & Cove – blending abundant natural stone, timber floors and mirror accents to create soft layers of contrast, reflection and texture. \r\n\r\nJust minutes from the CBD in its absolute Harbourfront setting, you’re connected to the city yet in a special world of your own. The best of Sydney living is here on your threshold as your exclusive home embraces the boutique style of the village, the Harbour and beautiful foreshore parkland. Each in equal measure. Moments to Darling Street’s vibrant lifestyle hub. Minutes to the CBD by car, bus or ferry. Close to great schools, UTS and Sydney University. The position is spectacular. You simply cannot get more accessible, more desirable or more Harbourfront than this.\r\n\r\n• A selection of brand new 3 bedroom apartments are available, including 2 bathrooms and 3 secure car spaces\r\n• A rare opportunity to live in an iconic harbourfront location \r\n• Spectacular Harbour, garden and foreshore views \r\n• Luxuriously finished interiors designed by award winning Bates Smart \r\n• A tranquil residential enclave gazing across a beautiful foreshore park to the water \r\n• Stunning private waterfront pool deck, garden lounge & gymnasium \r\n• Gourmet style kitchens with Miele appliances\r\n• 280 metres to Darling Street lifestyle hub \r\n• 5.6km to the CBD by car\r\n• Close proximity to great schools, UTS and Sydney University.\r\n\r\n\r\nPROJECT GALLERY & DISPLAY SUITE OPEN \r\nTHURSDAY - SUNDAY BETWEEN 10.00AM - 2.00PM\r\n100-102 Elliott Street, Balmain \r\n\r\nPRIVATE INSPECTIONS ALSO AVAILABLE BY APPOINTMENT.\r\nCall 1800 659 339 or www.harbourfrontbalmain.com.au to arrange your appointment today.\r\n\r\n*Note – Images are computer generated. Interested parties should enquire for further details on the apartment layout and finishes.\r\n", "devProjectId": 1261, "features": [ "Ensuite(s)", "Secure parking", "Air conditioning", "Ensuite", "Floorboards", "Gym", "Intercom", "Built in wardrobes", "Internal Laundry", "Broadband internet access", "Dishwasher", "Bath", "Secure Parking", "Balcony / Deck", "Garden / Courtyard", "Swimming Pool" ], "geoLocation": { "latitude": -33.855808, "longitude": 151.169255 }, "headline": "A TROPHY OPPORTUNITY TO LIVE ON THE HARBOUR", "id": 2012659029, "inspectionDetails": { "inspections": [ { "recurrence": "weekly", "closingDateTime": "2018-01-25T03:00:00Z", "openingDateTime": "2018-01-24T23:00:00Z" }, { "recurrence": "weekly", "closingDateTime": "2018-01-18T03:00:00Z", "openingDateTime": "2018-01-17T23:00:00Z" }, { "recurrence": "weekly", "closingDateTime": "2018-01-26T03:00:00Z", "openingDateTime": "2018-01-25T23:00:00Z" } ], "pastInspections": [ { "recurrence": "weekly", "closingDateTime": "2018-01-11T03:00:00Z", "openingDateTime": "2018-01-10T23:00:00Z" } ] } } ] ``` -------------------------------- ### Sample Listing Creation Response - JSON Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/guides/upload-listings This JSON object represents the response after creating a residential listing. It includes the `processStatus`, a unique `id` for tracking the job, `agencyId`, `providerId`, `providerAdId` (your system's unique listing key), and `versionId`. ```json { "processStatus": "queued", "id": "YTE4YzdhMzJhNjc3NGMzMmI2OTZjNmYwMzI2NmI3YTMjMzI1NjQjcHJvdmlkZXJpZDEyMyM=", "agencyId": 32564, "providerId": "a18c7a32a6774c32b696c6f03266b7a3", "providerAdId": "providerId123", "versionId": "cEuUSeGSdaqoLnuNRHJI3uM3XO8.KRV1" } ``` -------------------------------- ### GET Agent Statistics Response Example (JSON) Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/agents_getstatistics An example JSON response structure for the GET /v1/agents/{id}/statistics API endpoint. It details various listing view and interaction metrics for a given agent. ```JSON [ { "listingId": 6311594, "totalListingViews": 109, "totalPhotoViews": 14, "totalPhotoGalleryViews": 20, "totalFloorplanViews": 0, "totalMapViews": 5, "totalVideoViews": 0, "totalEbrochureViews": 0, "totalAgentDetailViews": 0, "totalShortlisted": 1, "totalPrinted": 0, "totalAgentPhoneNumberReveals": 2, "totalEnquiries": 3, "totalEmailToFriend": 0, "totalSharedViaSocialMedia": 0, "totalInspectionTimeSaving": 0, "totalCallToAgentFromMobile": 0, "percentageWebsiteViews": 19.0, "percentageMobileSiteViews": 6.0, "percentageSmartPhoneViews": 71.0, "percentageTabletViews": 4.0 } ] ``` -------------------------------- ### GET /v1/properties/{propertyId}/priceEstimate Request Example Source: https://developer.domain.com.au/docs/latest/apis/pkg_price_estimation/references/properties_getpriceestimate Example of a GET request to the price estimate endpoint. This requires a property ID as a path parameter. ```http GET https://api.domain.com.au/v1/properties/RF-8884-AK/priceEstimate ``` -------------------------------- ### Sample Listing Progress Report - JSON Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/guides/upload-listings This JSON response provides the current status and details of a listing processing job. It includes `processStatus`, `agencyId`, `providerId`, `providerAdId`, `adId` (Domain's listing ID), `qualityScore`, and `events` related to the processing stages. ```json { "processStatus": "processing", "agencyId": 32564, "providerId": "a18c7a32a6774c32b696c6f03266b7a3", "providerAdId": "providerid123", "adId": [2015067201], "qualityScore": 0, "events": [], "versions": [ { "operations": [ "dataReceived", "listingDataSaved", "supplementaryProcessed", "soiProcessed", "propertyTypesProcessed", "geoCoded", "contactsProcessed" ], "versionId": "cEuUSeGSdaqoLnuNRHJI3uM3XO8.KRV1", "processedDate": "0001-01-01T00:00:00.000Z", "dataUrl": "https://********.s3-ap-southeast-2.amazonaws.com/********", "processCount": 0 } ] } ``` -------------------------------- ### GET /v1/agencies Response Example Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/agencies_search This code snippet shows an example JSON response from the GET /v1/agencies endpoint. It details the structure of agency objects, including fields like id, name, address, contact information, and account type. ```json [ { "inSuburb": false, "hasRecentlySold": true, "id": 20438, "name": "Example Realty Pyrmont", "suburb": "Pyrmont", "address1": "80 Harris Street", "address2": "", "telephone": "02 1234 5678", "rentalTelephone": "02 1234 5678", "mobile": "0414 123 456", "fax": "", "state": "NSW", "description": "Agency description", "email": "pyrmontglebe@example.com.au", "rentalEmail": "pyrmontglebe@example.com.au", "accountType": 5, "numberForSale": 0, "numberForRent": 13, "domainUrl": "Pyrmont/ExamplePyrmont", "showTabSoldLastYear": true }, { "inSuburb": false, "hasRecentlySold": true, "id": 29765, "name": "Sydney International Realty - CBD & Pyrmont", "suburb": "Barangaroo", "address1": "International Tower 3, Level 24", "address2": "300 Barangaroo Avenue", "telephone": "02 4567 8901", "rentalTelephone": "02 4567 8901", "mobile": "", "fax": "", "state": "NSW", "description": "", "email": "sales@sydneyrealty.com", "rentalEmail": "spencer.sun@sydneyrealty.com", "accountType": 1, "numberForSale": 7, "numberForRent": 1, "domainUrl": "sydneyrealty-29765", "showTabSoldLastYear": true } ] ``` -------------------------------- ### Example Project Data Response Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/projects_get This JSON object represents a typical response when requesting project details from the Domain.com.au API. It includes status, property types, identifiers, address information, media URLs, descriptions, and feature lists. ```json { "status": "recentlyUpdated", "propertyTypes": [], "id": 1261, "name": "Harbourfront Balmain", "startDate": "2016-01-13", "endDate": "2018-03-26T23:59:59", "address": { "stateAbbreviation": "nsw", "displayType": "fullAddress", "latitude": -33.855614, "longitude": 151.169434, "streetNumber": "100-102", "street": "Elliott Street", "suburb": "Balmain", "suburbId": 1872, "postcode": "2041", "displayAddress": "100-102 Elliott Street, Balmain, NSW 2041" }, "viewingAddress": { "stateAbbreviation": "nsw", "displayType": "fullAddress", "streetNumber": "100-102", "street": "Elliott Street", "suburb": "Balmain", "postcode": "2041" }, "displayableAddress": { "stateAbbreviation": "nsw", "displayType": "fullAddress", "latitude": -33.855614, "longitude": 151.169434, "streetNumber": "100-102", "street": "Elliott Street", "suburb": "Balmain", "postcode": "2041", "displayAddress": "100-102 Elliott Street, Balmain, NSW 2041" }, "enquiryEmailAddress": "property@example.com.au", "advertiserIdentifiers": { "advertiserType": "agency", "advertiserId": 26995, "contactIds": [ 1378211 ] }, "media": [ { "category": "image", "type": "poster", "url": "https://bucket-api.domain.com.au/v1/bucket/image/1261_1_uk_171121_104341-w300-h600" }, { "category": "image", "type": "photo", "url": "https://bucket-api.domain.com.au/v1/bucket/image/1261_1_dp_170112_125055-w3425-h1698" }, { "category": "image", "type": "photo", "url": "https://bucket-api.domain.com.au/v1/bucket/image/1261_1_dp_170120_050034-w5000-h3345" } ], "projectUrl": "http://www.harbourfrontbalmain.com.au/", "headline": "Luxury New Apartments Nearing Completion – October 2017", "tagline": "", "displayAsLastUpdated": "0001-01-01", "modifiedBy": "dana.smith@example.com.au", "modifiedDate": "2018-01-17T16:45:40", "createdBy": "Dana Smith", "createdDate": "2017-03-20T15:06:03", "backgroundColour": "", "description": "Last remaining brand new 2 bedroom apartment! \n\n DISPLAY APARTMENT OPEN THURSDAY TO SUNDAY, 10AM - 2PM OR BY PRIVATE APPOINTMENT.\n \nCall 1800 659 339 or www.harbourfrontbalmain.com.au\n \nCommanding an absolute waterfront location, Harbourfront Balmain has recently released a show stopping collection of 3-bedroom apartments. Each of these exclusive residences captures all of Sydney’s very best assets, thanks to their position on 150-metres of unspoilt waterfrontage and unmatched views over Sydney Harbour; to Spectacle Island and the Iron Cove Bridge. \n \nEach apartment boasts contemporary interiors as well as access to the very best in luxurious resort-style amenities and open outdoor grassy and leafy zones. Just minutes from the CBD, in its iconic Harbourfront setting, you’re connected to the city yet in a special world of your own. Here, on your threshold, is the best of Sydney living as your luxury home embraces the boutique charm of the local village, the glistening harbour and beautiful foreshore parkland. \n \nWith Darling Street’s vibrant lifestyle hub at your fingertips, these residences are minutes to the CBD by car, bus or ferry. Choose from the very best in schools as well as higher education with UTS and the University of Sydney easily within reach. \n \nThe position is spectacular. You simply cannot get more accessible, more desirable or more Harbourfront than this. Superb resort amenities create a luxuriously private Harbourside playground. Open parks, pool deck and gym, informal play areas, grassed zones and leafy groves provide quiet respite within.\n \nFind yourself. Lose yourself. Harbourfront Balmain is a world away from the everyday. Embracing the Harbour and surrounded by Balmain peninsula’s village charms, it’s your Harbourfront sanctuary, your perfect village, your exclusive private world. \n \nCall 1800 659 339 or www.harbourfrontbalmain.com.au to arrange your appointment today.", "appointmentRequired": false, "features": [ "Private waterfront pool deck", "Garden lounge and gymnasium", "280metres to Darling St", "5.6km to CBD" ], "bannerUrl": "/banner_1261_23-01-2017_4:48PM.png", "bigBannerUrl": "/bigbanner_1261_23-01-2017_4:48PM.png", "smallBannerUrl": "/smallbanner_1261_23-01-2017_4:49PM.png", "logoUrl": "/logo_1261_23-01-2017_4:49PM.png", "pdfs": [] } ``` -------------------------------- ### POST /v1/enquiries Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/projects_search Submit an enquiry for a property listing. ```APIDOC ## POST /v1/enquiries ### Description Submits a new enquiry regarding a specific property listing. ### Method POST ### Endpoint /v1/enquiries ### Parameters #### Request Body - **listingId** (string) - Required - The ID of the listing. - **message** (string) - Required - The enquiry content. - **email** (string) - Required - The user's contact email. ### Request Example { "listingId": "12345", "message": "I am interested in this property.", "email": "user@example.com" } ### Response #### Success Response (200) - **status** (string) - Confirmation status of the enquiry. ``` -------------------------------- ### Fetch Project Listings (HTTP) Source: https://developer.domain.com.au/docs/latest/apis/pkg_property/references/projects_getchildlistings This snippet demonstrates how to make an HTTP GET request to the Domain.com.au API to retrieve listings for a specific project. The request includes the project ID in the URL. The response is a JSON array of listing objects. ```HTTP GET https://api.domain.com.au/v1/projects/1261/listings ``` -------------------------------- ### Projects - GET /v1/projects Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management Retrieves a list of projects. ```APIDOC ## GET /v1/projects ### Description Retrieves a list of projects. This endpoint may support filtering and pagination via query parameters. ### Method GET ### Endpoint `/v1/projects` ``` -------------------------------- ### GET /v2/suburbPerformanceStatistics/{state}/{suburb} Request Example Source: https://developer.domain.com.au/docs/latest/apis/pkg_properties_locations/references/suburbperformance_get_bynamedsuburb_withoutpostcode This snippet demonstrates how to make a GET request to the suburbPerformanceStatistics endpoint. It includes example parameters for state, suburb, and optional query parameters like propertyCategory, bedrooms, periodSize, startingPeriodRelativeToCurrent, and totalPeriods. ```http GET /v2/suburbPerformanceStatistics/NSW/Pyrmont?propertyCategory=house&bedrooms=3&periodSize=quarters&startingPeriodRelativeToCurrent=1&totalPeriods=4 HTTP/1.1 Host: api.example.com Authorization: Bearer YOUR_API_KEY ``` -------------------------------- ### Example Response for Agency Statistics (JSON) Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/agencies_getstatistics This is an example JSON response for the GET /v1/agencies/{id}/statistics API endpoint. It outlines the structure and data fields returned, such as listing views, photo views, and enquiry counts for a given agency. ```json [ { "adId": 63211211594, "totalListingViews": 12309, "totalPhotoViews": 13134, "totalPhotoGalleryViews": 2050, "totalFloorplanViews": 0, "totalMapViews": 215, "totalVideoViews": 0, "totalEbrochureViews": 0, "totalAgentDetailViews": 0, "totalShortlisted": 1321, "totalPrinted": 0, "totalAgentPhoneNumberReveals": 4322, "totalEnquiries": 3342, "totalEmailToFriend": 0, "totalSharedViaSocialMedia": 0, "totalInspectionTimeSaving": 0, "totalCallToAgentFromMobile": 0, "percentageWebsiteViews": 19.0, "percentageMobileSiteViews": 6.0, "percentageSmartPhoneViews": 71.0, "percentageTabletViews": 4.0 } ] ``` -------------------------------- ### GET /v1/agencies Request Example Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/agencies_search This code snippet demonstrates how to make a GET request to the /v1/agencies endpoint to retrieve agency information. It includes query parameters for searching by name and pagination. ```http GET https://api.domain.com.au/v1/agencies?q=Pyrmont&pageNumber=1&pageSize=2 ``` -------------------------------- ### Get Project Details via API Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/projects_get This snippet demonstrates how to make a GET request to the Domain.com.au API to retrieve specific project details. It requires a valid project ID in the URL. The response is a JSON object containing comprehensive information about the project. ```http GET https://api.domain.com.au/v1/projects/1261 ``` -------------------------------- ### POST /v2/listings/business/offmarket Request Body Example (JSON) Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/listings_upsertbusinessoffmarket This JSON object represents an example request body for the POST /v2/listings/business/offmarket endpoint. It includes details about the sale, listing provider, contact information, and property specifics. Ensure all required fields are populated according to the schema. ```json { "saleInfo": { "annualSales": 0, "annualProfit": 0, "stockValue": 0 }, "listingProvider": "string", "domainAgencyID": 2147483647, "providerAdId": "string", "description": "string", "summary": "string", "contacts": [ { "domainAgentId": 0, "firstName": "string", "lastName": "string", "phone": "string", "fax": "string", "mobile": "string", "email": "string", "receiveEmails": true } ], "listingAction": "sale", "offMarketDetails": { "offMarketAction": "withDrawn", "actionDate": "2026-03-17T22:38:24.253Z", "soldDetails": { "soldType": "auction", "soldPrice": 2147483647, "displaySoldPrice": true }, "leasedDetails": { "leasedPrice": 2147483647, "leasedDuration": 2147483647 }, "comment": "string" }, "propertyDetails": { "propertyType": [ "accessoriesParts" ], "parking": { "parkingType": "onSite", "numberOnSite": 2147483647, "information": "string" }, "images": [ { "resourceType": "photograph", "url": "https::::::::::::::::::::::::::::::::::::::::::::::mTRW;O}R[UtqNI}qih%VO}:q-s_*4Rbv__)I=?k>!DLZe_fJN,fAH 9(0li^nf$TSHWDCRmcD3GGYh>ZV$cJQ{|Qj;E414h0Bj%" } ], "address": { "unitNumber": "string", "street": "string", "displayOption": "unspecified", "suggestedGeoLocation": { "latitude": 0, "longitude": 0 }, "streetNumber": "string", "suburb": "string", "postcode": "2255", "state": "nsw" }, "area": { "value": 2147483647, "from": 2147483647, "to": 2147483647, "unit": "squareMetres" }, "landArea": { "unit": "squareMetres", "value": 2147483647, "from": 2147483647, "to": 2147483647 } } } ``` -------------------------------- ### GET Request for Agency Data Source: https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/agencies_get This snippet shows an example HTTP GET request to retrieve specific agency data from the Domain.com.au API. It targets an agency by its ID. ```http GET https://api.domain.com.au/v1/agencies/22473 ``` -------------------------------- ### POST /v1/enquiries Source: https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/references/listings_upsertresidentialoffmarket Create a new enquiry for a listing or project. ```APIDOC ## POST /v1/enquiries ### Description Submits a new enquiry to the system. ### Method POST ### Endpoint /v1/enquiries ### Request Body - **listingId** (string) - Required - The ID of the listing. - **message** (string) - Required - The content of the enquiry. ### Request Example { "listingId": "abc-123", "message": "I would like to book an inspection." } ### Response #### Success Response (200) - **status** (string) - Confirmation of submission. ``` -------------------------------- ### GET /v1/addressLocators Response Example Source: https://developer.domain.com.au/docs/latest/apis/pkg_property/references/addresslocators_get This code snippet shows an example JSON response from the /v1/addressLocators API. The response is an array of objects, each containing address components and associated IDs at different levels (Address, Street, Suburb, Postcode). This data is useful for identifying and referencing specific addresses within other applications. ```json [ { "types": ["Address"], "addressComponents": [ { "component": "StreetNumber", "shortName": "100" }, { "component": "StreetName", "shortName": "Harris" }, { "component": "StreetType", "shortName": "St" }, { "component": "Suburb", "shortName": "Pyrmont" }, { "component": "Postcode", "shortName": "2009" }, { "component": "State", "shortName": "NSW" } ], "ids": [ { "level": "Address", "id": 7009624 }, { "level": "Street", "id": 581832 }, { "level": "Suburb", "id": 36382 }, { "level": "Postcode", "id": 152 } ] } ] ``` -------------------------------- ### Example Property Response (JSON) Source: https://developer.domain.com.au/docs/latest/apis/pkg_properties_locations/references/properties_get This is an example JSON response for a successful request to the GET /v1/properties/{id} endpoint. It includes comprehensive details about a property, such as its address, features, sales history, and media. ```json { "cadastreType": "Polygon", "onMarketTypes": [], "status": "OffMarket", "address": "100 Harris Street, Pyrmont NSW 2009", "addressCoordinate": { "lat": -33.86884, "lon": 151.19401 }, "addressId": 7009624, "adverts": [], "areaSize": 7791, "bathrooms": 1, "bedrooms": 1, "claim": { "claimant": "Owner" }, "created": "2017-02-28T09:24:25.523Z", "features": ["Alarm", "Balcony", "Sunroom"], "flatNumber": "", "gnafIds": [ { "monthNo": 2, "yearNo": 2019, "gnafPID": "GANSW710292212" } ], "history": { "sales": [ { "agency": "JLL - Sydney", "apmAgencyId": 51359, "date": "2017-07-03", "daysOnMarket": 52.0, "documentedAsSold": true, "price": 327500000, "reportedAsSold": false, "suppressDetails": false, "suppressPrice": false, "type": "Private Treaty - Sold", "id": 2000062799199, "propertyType": "Commercial" } ] }, "id": "RF-8884-AK", "lotNumber": "100", "photos": [ { "imageType": "Property", "advertId": 2013587455, "date": "2017-05-11T05:35:36Z", "fullUrl": "https://bucket-api.commercialrealestate.com.au/v1/bucket/image/2013587455_6_pi_170511_053508-w1500-h1000", "rank": 1 }, { "imageType": "Property", "advertId": 2013587455, "date": "2017-05-11T05:35:36Z", "fullUrl": "https://bucket-api.commercialrealestate.com.au/v1/bucket/image/2013587455_2_pi_170511_021246-w556-h786", "rank": 2 } ], "planNumber": "1219280", "postcode": "2009", "propertyCategory": "", "propertyType": "Other", "sectionNumber": "", "state": "NSW", "streetAddress": "100 Harris Street", "streetName": "Harris", "streetNumber": "100", "streetType": "St", "streetTypeLong": "Street", "suburb": "Pyrmont", "suburbId": 36382, "updated": "2017-08-11T02:18:48.315Z", "urlSlug": "100-harris-street-pyrmont-nsw-2009", "urlSlugShort": "100-harris-st-pyrmont-nsw-2009", "zone": "B3" } ```