The OurHouse API lets other tools work with your account. The OurHouse browser app uses it to clip homes from listing sites straight into your watchlists, and you can use it for your own spreadsheets or scripts.

The full reference, with every request and response and a Try it out button, is in the API reference for buyers.

1. Get an API key

  1. Go to Account settings → API keys.
  2. Name the key after the tool that will use it, set when it expires, and tick only the scopes it needs.
  3. Press Generate API key and copy the key straight away. It's only shown once.

A key can't create other keys. To make another one, sign in and use Account settings, not the API.

Treat a key like a password: anyone with it can act on your account within its scopes. If one leaks, Revoke it on the same page. See API keys.

2. Make a request

Send the key in the Authorization header:

curl https://visitourhouse.nz/api/watchlists \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Accept: application/json"

What you can do

EndpointWhat it doesScopes
GET /api/health Check the API is up No key needed
GET /api/me Get the account the key belongs to Any key
POST /api/api-keys Create another API key Any key
GET /api/watchlists List your watchlists watchlists:read
POST /api/watchlists Create a watchlist watchlists:write
POST /api/watchlists/{watchlist}/properties Add a property to a watchlist watchlists:write
GET /api/properties Search properties properties:read
POST /api/properties/private Save a private property to a watchlist properties:write + watchlists:write
GET /api/pois Find places near a point pois:read
GET /api/pois/nearest Find the nearest place of one kind pois:read

Scopes

ScopeAllows
watchlists:readWatchlists (read)
watchlists:writeWatchlists (write)
properties:readProperties (read)
properties:writeProperties (write)
pois:readPoints of interest (read)

Plan limits and privacy

  • The API follows the same plan limits as the app. If adding a watchlist or property would go over your plan, you get a 403 with plan_limit and upgrade_url.
  • Properties saved with POST /api/properties/private are private to you, like Private Properties in the app.
  • You only ever see your own watchlists, ones shared with you, and public properties.