2026-09-28

Campaign Snapshots

A campaign snapshot is one recorded state of a campaign. It captures that marketing period as it stood at a particular moment.

The same campaign can be recorded more than once. Each recording is its own snapshot, so the series shows how that marketing period changed.

The Campaign Snapshot object

Attributes

id string

Unique identifier for the object.

auction_date nullable datetime

Auction date and time in the property's local time.

campaign_id string

Campaign this snapshot belongs to.

end_date nullable date

Campaign end date in the property's local time (YYYY-MM-DD).

guide_price nullable object

Guide price recorded in this snapshot. Either `{ "kind": "exact", "value": number }` or `{ "kind": "range", "min": number, "max": number }`. Nullable.

property object

Property details at the time of the snapshot.

Show child attributesHide child attributes

property.address string

Property address.

property.address_id string

Property identifier.

property.bathrooms nullable number

Number of bathrooms.

property.bedrooms nullable number

Number of bedrooms.

property.building_age nullable enum

Whether the property is new or established.

Possible enum values

established

An existing property.

new

A newly built property.

property.car_spaces nullable number

Number of car spaces.

property.land_size nullable number

Land size in square metres.

property.type nullable enum

Property type.

Possible enum values

apartment

Apartment or unit.

house

House.

land

Vacant land.

retirement

Retirement living property.

townhouse

Townhouse.

other

Other property type.

sold_date nullable date

Date the property sold, in the property's local time (YYYY-MM-DD).

sold_price nullable number

Sold price in dollars.

start_date nullable date

Campaign start date in the property's local time (YYYY-MM-DD).

status enum

Campaign status at the time of the snapshot.

Possible enum values

available

Available on market.

deposit_taken

A deposit has been taken.

leased

The property has been leased.

likely_withdrawn

Likely withdrawn from market.

sold

The property has sold.

under_offer

Under offer.

withdrawn

Withdrawn from market.

type nullable enum

Campaign type at the time of the snapshot.

Possible enum values

auction

Sold by auction.

private_treaty

Private treaty sale.

rent

Rental campaign.

tender

Sold by tender.

withdrawn_date nullable date

Date the campaign was withdrawn, in the property's local time (YYYY-MM-DD).

The Campaign Snapshot object
{
  "auction_date": null,
  "campaign_id": "2c6f8a40-1b7e-4d93-8c55-0e9a7b3d1f24",
  "end_date": null,
  "guide_price": {
    "kind": "exact",
    "value": 850000
  },
  "id": "9d4b7e21-3c58-4a6f-b012-8e5f1a9c3d70",
  "property": {
    "address": "100 Example Street, Sydney NSW 2000",
    "address_id": "5a9e1c72-0d84-4b16-a3f8-67c2e0d4b915",
    "bathrooms": 2,
    "building_age": "established",
    "bedrooms": 3,
    "car_spaces": 1,
    "land_size": 420,
    "type": "house"
  },
  "sold_date": null,
  "sold_price": null,
  "start_date": "2026-01-10",
  "status": "under_offer",
  "type": "private_treaty",
  "withdrawn_date": null
}

List campaign snapshots

POST /v1/list-campaign-snapshots

Parameters

address string Required conditionally

Property address. One of address, address_id, or campaign_id is required.

address_id string Required conditionally

Property identifier. One of address, address_id, or campaign_id is required.

campaign_id string Required conditionally

Campaign identifier. One of address, address_id, or campaign_id is required.

campaign_scope enum

Which campaigns for the property to include. The field defaults to "latest".

Possible enum values

all

Return snapshots for every campaign for the property.

latest

Return snapshots for the latest campaign for the property.

Returns a list of Campaign Snapshot objects if a valid identifier was provided, and raises an error otherwise.

Curl
curl -X POST 'https://feed.homerapp.com.au/v1/list-campaign-snapshots' \
  -H 'Content-Type: application/json' \
  -H 'Homer-API-Key: secret' \
  -H 'Homer-Version: 2026-09-28' \
  -d '{
    "address_id": "5a9e1c72-0d84-4b16-a3f8-67c2e0d4b915"
  }'
Response
{
  "data": [
    {
      "auction_date": null,
      "campaign_id": "2c6f8a40-1b7e-4d93-8c55-0e9a7b3d1f24",
      "end_date": null,
      "guide_price": {
        "kind": "exact",
        "value": 850000
      },
      "id": "9d4b7e21-3c58-4a6f-b012-8e5f1a9c3d70",
      "property": {
        "address": "100 Example Street, Sydney NSW 2000",
        "address_id": "5a9e1c72-0d84-4b16-a3f8-67c2e0d4b915",
        "bathrooms": 2,
        "building_age": "established",
        "bedrooms": 3,
        "car_spaces": 1,
        "land_size": 420,
        "type": "house"
      },
      "sold_date": null,
      "sold_price": null,
      "start_date": "2026-01-10",
      "status": "under_offer",
      "type": "private_treaty",
      "withdrawn_date": null
    }
  ]
}