# Stock-Snap
Stock-Snap is a Python library for extracting real-time stock market data. It provides an easy-to-use interface for fetching stock quote details across various exchanges.
## Features
- **Fetch Real-Time Data**: Retrieve real-time stock quotes for any ticker symbol.
- **Multi-Exchange Support**: Get stock data from multiple exchanges.
- **Easy Integration**: Simple and efficient methods to integrate into your projects.
## Installation
Install the package using pip:
```bash
pip install stock-snap
```
Fetching Stock Details
```python
ticker_symbol = 'AAPL'
details = stock_snap.fetch_details(ticker_symbol)
print(details)
```
```
ticker_symbol = 'GOOGL'
exchange_symbol = 'NASDAQ'
details = stock_snap.fetch_details_by_exchange(ticker_symbol, exchange_symbol)
```
### Example Output
The `fetch_details` method returns a dictionary with exchange symbols as keys and their corresponding stock quote details as values.
## Requirements
- Python 3.12
## Contributing
Contributions are welcome! Follow these steps to contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit them (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a pull request.
## Demo
[Youtube Tutorial](https://youtu.be/kFupzwhbY5I?si=wQEbURStkkrEs57B)
This project is licensed under the MIT License.
## Contact
For any issues or questions, please open an issue on this repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/omrawal/Stock-Snap",
"name": "stocksnap",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, stock, BSE, API, NSE, scraping, web scraping",
"author": "Om Rawal",
"author_email": "omrawal2801@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/96/75/49b8815e21f77b32f64ade67281daa0b037b182def82f6d1ea675df7806f/stocksnap-0.1.1.tar.gz",
"platform": null,
"description": "\r\n# Stock-Snap\r\n\r\n\r\n\r\nStock-Snap is a Python library for extracting real-time stock market data. It provides an easy-to-use interface for fetching stock quote details across various exchanges.\r\n\r\n\r\n\r\n## Features\r\n\r\n\r\n\r\n- **Fetch Real-Time Data**: Retrieve real-time stock quotes for any ticker symbol.\r\n\r\n- **Multi-Exchange Support**: Get stock data from multiple exchanges.\r\n\r\n- **Easy Integration**: Simple and efficient methods to integrate into your projects.\r\n\r\n\r\n\r\n## Installation\r\n\r\n\r\n\r\nInstall the package using pip:\r\n\r\n\r\n\r\n```bash\r\n\r\npip install stock-snap\r\n\r\n```\r\n\r\nFetching Stock Details\r\n\r\n```python\r\n\r\nticker_symbol = 'AAPL'\r\n\r\ndetails = stock_snap.fetch_details(ticker_symbol)\r\n\r\nprint(details)\r\n\r\n```\r\n\r\n```\r\n\r\nticker_symbol = 'GOOGL'\r\n\r\nexchange_symbol = 'NASDAQ'\r\n\r\ndetails = stock_snap.fetch_details_by_exchange(ticker_symbol, exchange_symbol)\r\n\r\n```\r\n\r\n\r\n\r\n### Example Output\r\n\r\n\r\n\r\nThe `fetch_details` method returns a dictionary with exchange symbols as keys and their corresponding stock quote details as values.\r\n\r\n\r\n\r\n## Requirements\r\n\r\n\r\n\r\n- Python 3.12\r\n\r\n\r\n\r\n## Contributing\r\n\r\n\r\n\r\nContributions are welcome! Follow these steps to contribute:\r\n\r\n\r\n\r\n1. Fork the repository.\r\n\r\n2. Create a new branch (`git checkout -b feature-branch`).\r\n\r\n3. Make your changes and commit them (`git commit -m 'Add new feature'`).\r\n\r\n4. Push to the branch (`git push origin feature-branch`).\r\n\r\n5. Create a pull request.\r\n\r\n\r\n\r\n## Demo\r\n\r\n[Youtube Tutorial](https://youtu.be/kFupzwhbY5I?si=wQEbURStkkrEs57B)\r\n\r\n\r\n\r\nThis project is licensed under the MIT License.\r\n\r\n\r\n\r\n## Contact\r\n\r\n\r\n\r\nFor any issues or questions, please open an issue on this repository.\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Fetch stock data via Google Finance",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/omrawal/Stock-Snap"
},
"split_keywords": [
"python",
" stock",
" bse",
" api",
" nse",
" scraping",
" web scraping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78aa0aec5710ab9c35deb3ee7d251ec227a047c85d61fa59e0dbb9c197b6aa6c",
"md5": "2a2058c9ee94ddbc09ce1dd88f317412",
"sha256": "b0d3e2f6e81d639e789f651749cfc1b3e14440c63a6f7029c70a13d768666c09"
},
"downloads": -1,
"filename": "stocksnap-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a2058c9ee94ddbc09ce1dd88f317412",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5307,
"upload_time": "2024-12-25T14:08:20",
"upload_time_iso_8601": "2024-12-25T14:08:20.316967Z",
"url": "https://files.pythonhosted.org/packages/78/aa/0aec5710ab9c35deb3ee7d251ec227a047c85d61fa59e0dbb9c197b6aa6c/stocksnap-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "967549b8815e21f77b32f64ade67281daa0b037b182def82f6d1ea675df7806f",
"md5": "38f161d40b2bdb02424a5c6a115bb6a7",
"sha256": "7039def56524dfdd10b7ac57eeeb0c47a350b73d439d73c2d82180686204da01"
},
"downloads": -1,
"filename": "stocksnap-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "38f161d40b2bdb02424a5c6a115bb6a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5216,
"upload_time": "2024-12-25T14:08:22",
"upload_time_iso_8601": "2024-12-25T14:08:22.632692Z",
"url": "https://files.pythonhosted.org/packages/96/75/49b8815e21f77b32f64ade67281daa0b037b182def82f6d1ea675df7806f/stocksnap-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-25 14:08:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "omrawal",
"github_project": "Stock-Snap",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "beautifulsoup4",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "bs4",
"specs": [
[
"==",
"0.0.2"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.7.4"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "et-xmlfile",
"specs": [
[
"==",
"1.1.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "openpyxl",
"specs": [
[
"==",
"3.1.5"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.2.2"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2024.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "soupsieve",
"specs": [
[
"==",
"2.5"
]
]
},
{
"name": "tzdata",
"specs": [
[
"==",
"2024.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.2"
]
]
}
],
"lcname": "stocksnap"
}
JSON
