🚀 Anndromeda RoyaleAPI

Anndromeda RoyaleAPI, also known as Royale High API or RHAPI, is a powerful Quart + Puppeteer API designed to fetch the names of items from the popular Roblox game Royale High and their associated community values from Traderie. The API returns results in JSON format, making it easy to integrate and use for various applications or analysis.

This API was created to interact with the Traderie website, a platform where the Royale High community buys and sells in-game items. With the API, you can easily access the most up-to-date information on item names and their community values, providing the necessary data for further processing or for custom interfaces.

---

📦 Features

• Item Fetching: Real-time retrieval of items and values.
• Targeted Queries: Fetch specific items by the item's id.
• JSON Output: Easy parsing in Python, JS, Power Query, etc.
• Bulk Retrieval: Optimize performance for full item lists.
• Integration Ready: Works with Excel, Google Sheets, Power BI, or custom apps.

---

🧪 Supported Platforms

• Developed on: Windows 11
• Compatible: Linux, macOS
• Requirements: Python 3.x, Node.js, Google Chrome

---

⚙️ Requirements

System Requirements

• Python 3.x & pip
• Node.js & npm
• Google Chrome (required by Puppeteer)

Core Dependencies

• Python: quart, quart-cors
• Node: puppeteer

See requirements.txt and package.json for details.

---

🚀 Installation

Pre-made guides for deploying on a PaaS: Render | Northflank

Via Docker

You can run RoyaleAPI via Docker using the Dockerfile:

docker build -t royaleapi:v1 .
docker run -d -p <HOST-PORT>:5000 --name royaleapi-deploy royaleapi:v1

If you wish, you may also want to create a volume using docker volume create to persist the SQLite-generated index files across containers.

OR locally, without Docker, using the following steps:

Locally (without Docker)

1. Clone Repository

git clone https://github.com/Xelvanta/Anndromeda-RoyaleAPI
cd Anndromeda-RoyaleAPI

2. Optional: Python Virtual Environment

py -3.13 -m venv venv
venv\Scripts\activate

3. Install Node Dependencies

npm ci

4. Install Python Dependencies

pip install -r requirements.txt

5. Run the API

python app.py

The default config.json settings bind to 127.0.0.1:5000 (or 0.0.0.0:{PORT} if PORT is in environment variables).
It is highly advised to set API_KEY as an environment variable; otherwise the one from config.json will be used.

• Access endpoints: /items, /item?id=<ID>, /health, or /node/restart
• Documentation: See API_DOCUMENTATION.md

---

⚠️ Common Issues

• Node.js not recognized: Ensure Node.js is installed and in your PATH.
• Puppeteer Chrome error: Make sure Google Chrome is installed.
• Dependencies missing: Ensure pip install -r requirements.txt or npm ci completed successfully.
• Windows PATH for Node.js: Add Node.js folder to system PATH.
• PowerShell Execution Policy: Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

---

💡 Contributing

Fork, contribute, and submit PRs. See CONTRIBUTING.md.

---

📝 License

GPL-3.0. See LICENSE.

---

📬 Contact

Anndromeda / Xelvanta Group Systems
Email: Xelvanta@proton.me
GitHub: https://github.com/Xelvanta