Skip to content

Liriosha/GAGAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grow a Garden Logo The (Unoffical) Grow a Garden API

License: MIT Downloads Issues

An API that provides live stock and weather data from Grow a Garden.
It connects to a Grow a Garden WebSocket to receive real-time updates and exposes endpoints to access current data about gear, seeds, eggs, cosmetics, event shop items, and weather.

✨ Features

  • Real-time data synchronization via WebSocket connection
  • REST API endpoints to query current stock and weather data
  • Rate limiting to prevent abuse (5 requests/minute per client IP)
  • CORS enabled with open origins
  • Self-hosted Swagger UI for API exploration

🔧 Prerequisites

  • Python 3.11+
  • pip package manager

🚀 Getting Started

  1. Clone the repository:
    git clone https://github.com/Liriosha/GAGAPI.git
  2. Setup
    cd GAGAPI
    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    pip install -r requirements.txt
  3. Run!
    uvicorn main:app --host 0.0.0.0 --port 80

🤝 Contributing

Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
Check the contributing guide.

📝 License

Copyright © 2025 Liriosha.
This project is MIT licensed.