Agency owners, admins and agents can use the OurHouse API from their own tools. For example to check how a listing appears on OurHouse, or to pull nearby schools, shops and transport into listing material.

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

1. Get an API key

  1. Log in with your own account and go to Account settings → API keys (behind your avatar).
  2. Name the key after the tool that will use it, set when it expires, and tick only the scopes it needs. usually properties:read and pois:read.
  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.

Keys belong to a person, not the agency. When someone leaves, revoke their keys, or remove them from the agency.

2. Make a request

curl "https://visitourhouse.nz/api/pois?lat=-36.8485&lon=174.7633&categories=education" \
  -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/properties Search properties properties:read
GET /api/pois Find places near a point pois:read
GET /api/pois/nearest Find the nearest place of one kind pois:read

Using places data

Places come from OpenStreetMap. Wherever you show them. On a brochure, a website or a listing. Include the attribution in meta.attribution (© OpenStreetMap contributors).

Not in the API yet

Adding and editing listings, open homes, agents, branches, appraisal leads and boosts isn't available through the API yet. Use the agency and agent pages in the app for those. See My Properties and Our Properties. New endpoints are added to the reference as soon as they're available.