Skip to content

v5.1.1-alpha

Pre-release
Pre-release

Choose a tag to compare

View all tags
@Xelvanta Xelvanta released this 16 Feb 13:16
· 126 commits to main since this release
v5.1.1-alpha
50f4e4b
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🚀 Anndromeda™ RoyaleAPI v5.1.1-alpha

Release Date: 2025-02-16

IMPORTANT: This is an alpha release and is mostly stable, though still in active development. It is NOT intended for production use but is expected to perform well for testing.

📌 Highlights

  • 🔹 New ‘name’ Query Parameter – Added the name query parameter to allow users to retrieve a specific item’s value more efficiently.
    Endpoint:

    GET /item?name=<ITEM_NAME>
    • If the name parameter is provided, the API will return the value of the specific item.
    • If no name is given, the API will return a list of all items.
    • The scraper now stops as soon as the item is found, making it faster than the previous /items endpoint.

  • 🔹 Bug Fix for Server Shutdown – Resolved an issue where the server would not stop after scraping all pages. The scraper now returns data immediately when it receives an empty array from JavaScript, preventing the need to scrape through all pages.

  • 🔹 Documentation Update – Added a docs/ folder with detailed usage guides, including examples for Excel, Insomnia, Postman, and more. Also included a general API guide—highly recommended to read.

  • 🔹 Quality of Life Improvements – Added several updates to enhance the overall user experience and stability.

  • 🔹 Code of Conduct and Security – Added CODE_OF_CONDUCT.md and SECURITY.md to the project to promote a welcoming and secure development environment.

  • 🔹 Dependencies Update – Introduced requirements.txt for easier dependency management.

🛠️ Bug Fixes

  • 🐞 Server Shutdown Issue – Fixed the issue where the Quart server wouldn't stop correctly after the last page of data was scraped. Now, the server stops promptly, and empty arrays trigger an immediate return of data, eliminating the need to wait for additional pages.

📦 Improvements

  • 📈 Optimized Performance – Significantly improved scraping speed. The scraper will now stop once the requested item is found, rather than continuing until page 100.

  • 📈 Enhanced API Documentation – Expanded the documentation to include new endpoints, use cases, and examples for different environments like Excel, Insomnia, and Postman.

  • 📈 Architecture Enhancements – Updated project structure for improved maintainability and readability, making it easier to extend in future versions.

🔧 Known Issues

  • ⚠️ Occasional Slowdowns – Scraping performance may experience brief slowdowns during pagination or when fetching data from multiple pages. This issue is being worked on in future updates.

  • ⚠️ Minor Instabilities – Some parts of the scraper may still exhibit occasional issues or bugs. It is recommended for testing and development use at this stage.

  • ⚠️ Incomplete Feature Set – Certain features are still under development. Future updates will continue to improve functionality and stability.

Assets 3
Loading