@mynameistito/hcc-bin-day
v0.1.2
Published
TypeScript client for Hamilton City Council Fight the Landfill bin-day lookup API.
Maintainers
Readme
@mynameistito/hcc-bin-day
TypeScript client for the Hamilton City Council Fight the Landfill bin-day lookup API.
What it does
- searches Hamilton addresses
- resolves a street address to a bin collection schedule
- supports text and JSON output
API endpoints
This client talks to the public Hamilton City Council backend used by the Fight the Landfill page:
GET /FightTheLandFill/get_Addresses?search_string=...GET /FightTheLandFill/get_Collection_Dates?address_string=...
Base URL:
https://api2.hcc.govt.nzUsage
npx @mynameistito/hcc-bin-day
npx @mynameistito/hcc-bin-day search "12 Grey Street"
npx @mynameistito/hcc-bin-day lookup "12 Grey Street"
npx @mynameistito/hcc-bin-day schedule "12 Grey Street"
npx @mynameistito/hcc-bin-day --json lookup "12 Grey Street"Output modes
searchreturns matching addressesschedulereturns the collection schedule for an exact matchlookupsearches for an exact match and falls back to suggestions--jsonprints structured JSON for scripting
Project structure
src/
hamilton-api.ts
index.ts
types.tsDevelopment
bun install
bun run check
bun run typecheck
bun run fix
bun run buildTooling
- Type checking:
@typescript/native-previewviatsgo - Bundling:
tsdowntargeting Node.js
Disclaimer
This project is unofficial and is not affiliated with, endorsed by, supported by, or associated with Hamilton City Council.
It is provided independently as a convenience for accessing publicly available collection data. API behavior, availability, response formats, and returned data may change without notice.
