Skip to content

StonksAPI v1.0.0

Choose a tag to compare

@matextrem matextrem released this 17 Apr 02:07
· 23 commits to release since this release

We are excited to announce the release of Stonks API version 1.0.0! This initial release brings our users the capability to access real-time stock data, leveraging the powerful scraping capabilities of Cheerio and the performance of serverless architecture provided by Vercel.

New Features

  • Support for Finviz: Users can now fetch real-time data from Finviz, including stock prices, changes, and percentage changes.
  • Serverless Architecture: Fully implemented on Vercel, ensuring scalability and reliability.
  • Dynamic Provider Configuration: Flexibility to add or change data providers with minimal code adjustment.
  • Easy Setup: Simple setup and local development environment, with detailed instructions provided in the README.

Enhancements

  • Optimized Data Fetching: Improved the data fetching logic to ensure faster responses and more reliable performance.
  • Enhanced Configuration Handling: Streamlined environment configuration to facilitate easier deployments and management.

Getting Started

  • Clone the repository and follow the setup instructions to get started with local development. Comprehensive documentation is available in the project README to help new users and developers understand how to use and extend the API.

Known Issues

  • Currently, only Finviz is fully supported. Plans to extend support to other financial data providers are underway.

Upcoming Features

  • Support for Additional Providers: We are planning to add more providers to give users access to a broader range of financial data.
  • API Enhancements: Future releases will include advanced data analysis features and improved API endpoints.

How to Update

  • If you are setting up Stonks API for the first time, follow the installation instructions in our README.
  • For existing setups, pull the latest changes from the master branch and follow any specific migration steps detailed in the project documentation.

Community and Contributions

  • We thrive on community collaboration. Please contribute by forking the project, making your changes, and submitting a pull request. Whether it's a bug fix, a new feature, or documentation enhancements, all contributions are welcome!

Acknowledgments

  • Thanks to all contributors who have helped shape this first release. Special thanks to the open-source community for the continuous support and inspiration.