Full list of available endpoints, for detailed description see below.

• /api/v1/addr, parameter: addr -

Two endpoints so far, both accepting addr parameter.

• /api/v1/rr - rubbish and recycling, returns the JSON of the following format:

  {
   "rubbish": "2020-02-25",
   "recycle": "2020-02-25",
   "address": "Britomart, CBD"
  }
  

• /api/v1/rrext - extended rubbish and recycling. Returns the JSON in the following format:

  {
   "Collections": [
   {
   "Day": "Monday 24 January",
   "Date": "2020-01-24T00:00:00+13:00",
   "Rubbish": true,
   "Recycle": true
   },
   {
   "Day": "Monday 31 January",
   "Date": "2020-01-31T00:00:00+13:00",
   "Rubbish": true,
   "Recycle": false
   }
   ],
   "Address": {
   "ID": "12342478585",
   "Address": "500 Queen Street, Auckland Central"
   }
  }
  

Example:

$ curl --location --request GET 'https://<server>/api/v1/rr?addr=500%20Queen%20Street'
{"rubbish":"2020年02月24日","recycle":"2020年02月24日","address":"500 Queen Street, Auckland Central"}

Assuming your aklapi API server running on localhost:5010, add the following to your configuration.yaml:

rest:
 - resource: http://localhost:5010/api/v1/rr?addr=xx
 method: GET
 scan_interval: 300
 sensor:
 - name: Recycle
 value_template: "{{ value_json.recycle }}"
 device_class: date
 unique_id: recycle_date
 - name: Food Scraps
 value_template: "{{ value_json.foodscraps }}"
 device_class: date
 unique_id: foodscraps_date
 - name: Rubbish
 value_template: "{{ value_json.rubbish }}"
 device_class: date
 unique_id: rubbish_date