Introduction

My House Geek's API can be accessed via the main maps.myhousegeek.com.au site. There are two key references:

My House Geek's API reference can use both JWT and HMAC authentication schemes provided in the API keys site. The API documentation uses concepts described below.

Maps usage

Embed map in your webpage using an <iframe> HTML tag

  • e.g. <iframe src="https://maps.myhousegeek.com.au/listing/30tzG/" height=500px width=500px></iframe>

It is not recommended to have an iframe width less than 500 pixels as the sidebar requires a minimum of 80 pixels. One can also use the style attribute to inherit width and heights from parent DOM objects, such as:

  • e.g. <iframe src="https://maps.myhousegeek.com.au/listing/30tzG/" style="border-style: none; width: 100%; height: 500px;"> </iframe>

Concepts

Categories

Categories are the sidebar classifications for each point of interest.

Metrics

A metric is a type (such as a distance or commute time) and a value (a distance in kilometres, or commute time in minutes). The following screenshot has a transit (public transport) metric type, with a 15 minute metric value

Routing

A route between two points is made up of at least one leg: a leg involves using a particular mode of transport. In the example there are three legs:
• an initial walk to a light rail stop,
• a light rail trip, and
• a subsequent walk to the destination.

Each leg is made up of multiple steps: a step is an instruction (such as ”Continue north for 100 metres on Harwood Street”) to be used for turn-by-turn navigation.

Listing Configuration

A listing can be tailored by:

  • Basemaps used for web maps
  • Category: category colours can be altered, and can be enabled (can be turned off or on in the sidebar) and made available (whether a user can see a category in the sidebar)
  • Icon set, for the sidebar and the map icons. These icon sets need to be uploaded by My House Geek technology personnel.

The following table shows the possible configuration options as mentioned in the API reference.

Listing Configuration

Type

Option

Value

Custom URL to basemap

basemap

-map
- satellite

a URL to a basemap, such as http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png, empty to use default

Default zoom level

default_zoom_level

N/A

An integer value specifying a map’s zoom level

Enable/disable category being shown on map

category_enabled

Category (see list of categories message).

- true
- false

Activate/deactivate category (whether a user can see a category in sidebar)

category_available

Category (see list of categories message).

- true
- false

Move category

category_order

Category (see list of categories message).

- up
- down

Category colour

category_colour

Category (see list of categories message).

- true
- false

Icon set

icon_set

(ignored)

(a string)

White labelling (show/hide the “My House Geek” text

white_label

(ignored)

- true
- false

Progress bar

progress_bar

(ignored)

(blank)
progress-bar-success
progress-bar-info
progress-bar-warning
progress-bar-danger

Button colours(the colour of buttons like the zoom in, zoom out, recenter map, change basemap buttons)

button_colour

- text_colour
- hover_text_colour
- background_colour

A valid HTML colour (such as “#FFDDEE”), empty to use default

Foundations

Endpoint: https://maps.myhousegeek.com.au/api/v1
Operations:
  • Request token
  • Create listing
  • Get data (category list)
  • Get data (metrics list)
  • Get data (point list)
  • Get data (point detail)
  • Create

Icon sets

Map point-of-interest icons (in folder ”map-poi-icons”)
aged-care.png
ambulance.png
beach.png
bus.png
childcare.png
ferry.png
fire-station.png
generic.png
hospital.png
listing.png
place-of-worship-buddhism.png
place-of-worship-christianity.png
place-of-worship-hindu.png
place-of-worship-islam.png
place-of-worship-jewish.png
place-of-worship-sikh.png
place-of-worship.png
police-station.png
post-office.png
recreation.png
school.png
shopping.png
tertiary.png
train.png
tram.png
Map point-of-interest icons (in folder ”map-poi-icons”)
education.png
childcare.png
healthcare.png
bus.png
train.png
tram.png
ferry.png
recreation.png
shopping.png
place-of-worship.png
emergency-services.png
wifi.png
other-info.png