Quote/0 API Serverless Microservice
Manage events and bin collection information on AWS, then push updates to Quote/0 through the official Text API.
Quote/0 API is a serverless microservice built on AWS Lambda and DynamoDB. Its Bearer-protected HTTP API accepts calendar events, combines them with Reading Council bin collection schedules, and actively updates the device through the official Quote/0 Text API.
Features
- Push-only delivery: Lambda updates Quote/0 through the official Text API; the device does not call this service
- Event management: Creates a single event or up to 100 events in one batch
- Bin collection integration: Retrieves Reading Council collection data and stores it in DynamoDB
- Scheduled updates: EventBridge runs the collection sync and device refresh at 01:10 UTC each day by default
- API authorization: Every HTTP endpoint requires
Authorization: Bearer <API_AUTH_TOKEN> - Serverless deployment: Uses API Gateway, Lambda, DynamoDB, and EventBridge
API
| Method | Path | Purpose |
|---|---|---|
POST | /api/events | Create one event and immediately update Quote/0 |
POST | /api/events/batch | Create up to 100 events and update Quote/0 |
Development deployments also expose POST /test/scheduled-update for manually invoking the scheduled task.
Requirements
- An AWS account that can deploy Lambda, API Gateway, DynamoDB, and EventBridge
- Node.js 18 or later and the Serverless Framework
- A Quote/0 Text API endpoint and Token
- A separate Bearer Token for protecting the project HTTP API
- A UPRN for an address served by Reading Council
Primary environment variables include QUOTE0_TEXT_API, QUOTE0_AUTH_TOKEN, API_AUTH_TOKEN, UPRN, and READING_API_URL.
Service area and secrets
Bin collection support is specific to Reading Council and requires a property UPRN. Treat the UPRN, AWS credentials, Quote/0 Token, and API Bearer Token as sensitive data, and do not commit them to the repository.
Did this solve your problem?
Join our community