Listings API

Read your listings for a site. All endpoints are read-only and require a key with the listings:read scope. {site} is your site's UUID.

info

The API reads data — it doesn't modify listings. Listings change only through your feed (or the dashboard). To push data into FeedSync, use the upload API.

Endpoints

Method	Path	Returns
GET	/sites/{site}/listings	Paginated listings.
GET	/sites/{site}/listings/search	Advanced + geo search.
GET	/sites/{site}/listings/featured	Featured, current listings.
GET	/sites/{site}/listings/fields	The fields you can request via ?fields=.
GET	/sites/{site}/listings/{listing}	A single listing (by ref or numeric id).
GET	/sites/{site}/listings/{listing}/objects	Media (images, floorplans, video, documents) for a listing.

List listings

curl https://feedsync.com.au/api/v1/sites/{site}/listings \
  -H "Authorization: Bearer fs_your_api_key" \
  -G \
  --data-urlencode "status=current" \
  --data-urlencode "type=residential" \
  --data-urlencode "per_page=20"

Common query parameters

Parameter	Description
page	Page number (default 1).
per_page	Items per page (default 20, max 100).
status	One or more of current,sold,leased,withdrawn,offmarket,deleted (comma-separated).
type	residential, rental, holiday_rental, rural, commercial, commercial_land, land, business.
under_offer	true / false.
suburb, postcode, state	Location filters.
min_price, max_price	Price range.
bedrooms, bathrooms	Minimum counts.
sort	price, mod_time, bedrooms, bathrooms, suburb, created_at, updated_at (default mod_time).
order	asc or desc (default desc).
include	Extra data: details,agents,objects,metadata (comma-separated).
fields	Limit the response to specific fields (see /listings/fields).

Response

{
  "data": [
    {
      "id": 1234,
      "unique_id": "1P1329",
      "feedsync_unique_id": "CPN2540-1P1329",
      "type": "residential",
      "status": "current",
      "under_offer": false,
      "category": "House",
      "address": {
        "display_address": "22 Brisbane Street, Bondi Junction NSW 2022",
        "suburb": "Bondi Junction",
        "postcode": "2022",
        "state": "NSW",
        "country": "AU"
      },
      "pricing": { "price": 3900000, "price_view": "Auction", "rent": null, "under_offer": false },
      "features": { "bedrooms": 4, "bathrooms": 2, "garages": 2, "carports": 0, "land_area": 512, "building_area": 240 },
      "coordinates": { "latitude": -33.891271, "longitude": 151.248712 },
      "timestamps": { "mod_time": "2024-06-15T09:30:00", "created_at": "2024-06-01T08:00:00Z", "updated_at": "2024-06-15T09:35:22Z" }
    }
  ],
  "meta": { "total": 142, "per_page": 20, "current_page": 1, "last_page": 8, "from": 1, "to": 20 },
  "links": { "first": "…", "last": "…", "prev": null, "next": "…" }
}

Get a single listing

curl https://feedsync.com.au/api/v1/sites/{site}/listings/{ref} \
  -H "Authorization: Bearer fs_your_api_key"

{ref} can be the listing's ref or its numeric id. Add ?include=agents,objects,details for the full record.

Search

GET /sites/{site}/listings/search accepts the filters above plus:

Parameter	Description
q	Free-text match on the address.
lat + lng	Centre point for a radius search (both required together).
radius	Search radius in km (1–100, default 10).

Related read endpoints

Scoped the same way (under /sites/{site}/…):

Path	Scope	Returns
/agents, /agents/{agent}	agents:read	Agents on the site's feed.
/objects, /objects/{object}	listings:read	Media objects.
/stats	stats:read	Totals by status/type, price bands, popular suburbs.
/suburbs, /categories	—	Suburbs and categories with listing counts.

To submit enquiries, see the Leads API.