{"id":17740573,"url":"https://github.com/rusq/aklapi","last_synced_at":"2025-05-08T19:32:48.334Z","repository":{"id":57514367,"uuid":"242426940","full_name":"rusq/aklapi","owner":"rusq","description":"Auckland Rubbish, Recycling and Foodscraps API","archived":false,"fork":false,"pushed_at":"2024-08-22T09:10:29.000Z","size":214,"stargazers_count":18,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T10:18:10.503Z","etag":null,"topics":["api-client","api-rest","api-server","auckland","golang","json","rest-api","utilities"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/ffffuuu/aklapi","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rusq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-22T23:30:53.000Z","updated_at":"2025-03-16T20:17:43.000Z","dependencies_parsed_at":"2022-09-06T03:01:49.888Z","dependency_job_id":"2cf13260-42c3-4a3f-bbe8-00f807058a05","html_url":"https://github.com/rusq/aklapi","commit_stats":{"total_commits":46,"total_committers":3,"mean_commits":"15.333333333333334","dds":0.08695652173913049,"last_synced_commit":"7e35f3328925f4248993847d0bb160537decf6d4"},"previous_names":["rusq/aklrubbish"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rusq%2Faklapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rusq%2Faklapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rusq%2Faklapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rusq%2Faklapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rusq","download_url":"https://codeload.github.com/rusq/aklapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246510416,"owners_count":20789342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","api-rest","api-server","auckland","golang","json","rest-api","utilities"],"created_at":"2024-10-26T03:06:36.940Z","updated_at":"2025-04-01T07:30:33.521Z","avatar_url":"https://github.com/rusq.png","language":"HTML","readme":"# Auckland Council API (unofficial)\n\nFull list of available endpoints, for detailed description see below.\n\n| Name                        | Endpoint        | Parameters              | Comments                            |\n|:----------------------------|:----------------|:------------------------|:------------------------------------|\n| Address                     | `/api/v1/addr`  | `addr`: partial address | Address Query                       |\n| Rubbish and Recycling short | `/api/v1/rr`    | `addr`: partial address | Rubbish and Recycling, short format |\n| Rubbish and Recycling       | `/api/v1/rrext` | `addr`: partial address | Rubbish and Recycling               |\n| Healthcheck                 | `/healthcheck`  |                         | Returns OK if alive                 |\n\n\n### Address search\n\n* `/api/v1/addr`, parameter: `addr` - \n\n### Rubbish and Recycling\n\nTwo endpoints so far, both accepting `addr` parameter.\n\n* `/api/v1/rr/` - rubbish and recycling, returns the JSON of the following format:\n\n      {\n          \"rubbish\": \"2020-02-25\",\n          \"recycle\": \"2020-02-25\",\n          \"address\": \"Britomart, CBD\"\n      }\n\n* `/api/v1/rrext/` - extended rubbish and recycling.  Returns the JSON in the following format:\n\n      {\n          \"Collections\": [\n              {\n                  \"Day\": \"Monday 24 January\",\n                  \"Date\": \"2020-01-24T00:00:00+13:00\",\n                  \"Rubbish\": true,\n                  \"Recycle\": true\n              },\n              {\n                  \"Day\": \"Monday 31 January\",\n                  \"Date\": \"2020-01-31T00:00:00+13:00\",\n                  \"Rubbish\": true,\n                  \"Recycle\": false\n              }\n          ],\n          \"Address\": {\n              \"ACRateAccountKey\": \"12342478585\",\n              \"Address\": \"500 Queen Street, Auckland Central\",\n              \"Suggestion\": \"500 Queen Street, Auckland Central\"\n          }\n      }\n\nExample:\n\n```sh\n$ curl --location --request GET 'https://\u003cserver\u003e/api/v1/rr/?addr=500%20Queen%20Street'\n{\"rubbish\":\"2020-02-24\",\"recycle\":\"2020-02-24\",\"address\":\"500 Queen Street, Auckland Central\"}\n```\n\n### Integrating with Home Assistant\n\nAssuming your aklapi API server running on localhost:5010, add the following\nto your `configuration.yaml`:\n\n```yaml\nsensor:\n  - platform: rest\n    resource: \"http://localhost:5010/api/v1/rr/?addr=xx\"\n    name: Recycle\n    scan_interval: 300\n    value_template: \"{{ value_json.recycle }}\"\n    method: GET\n    unique_id: recycle_date\n\n  - platform: rest\n    resource: \"http://localhost:5010/api/v1/rr/?addr=xx\"\n    name: Food Scraps\n    scan_interval: 300\n    value_template: \"{{ value_json.foodscraps }}\"\n    method: GET\n    unique_id: foodscraps_date\n\n  - platform: rest\n    resource: \"http://localhost:5010/api/v1/rr/?addr=xx\"\n    name: Rubbish\n    scan_interval: 300\n    value_template: \"{{ value_json.rubbish }}\"\n    method: GET\n    unique_id: rubbish_date\n\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frusq%2Faklapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frusq%2Faklapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frusq%2Faklapi/lists"}