MarketWatch's API
Project description
Marketwatch API Python Library
Broken in developpement
A Python libary to interact with the MarketWatch Stock Market Game Based on code from
Feature
- Logging in and out of the site
- Getting the current price of a stock
- Getting information about games on the site
- Buying, selling, shorting, and covering stocks in a game
- Creating, adding to, getting, and deleting watchlists
- Getting, adding to, and deleting items from a portfolio
- Getting and cancelling pending orders
- Checking if the game is down
Installation
pip install marketwatch
pip install git+https://github.com/antoinebou12/marketwatch.git
git clone https://github.com/antoinebou12/marketwatch.git
Usage
Here are some examples of how you can use the MarketWatch class:
Import
First, import the MarketWatch class from the script:
from marketwatch import MarketWatch
Login
Then, create an instance of the MarketWatch class using your MarketWatch username and password:
marketwatch = MarketWatch(username, password)
Get Stock Price
To get the current price of a stock:
marketwatch.get_price("AAPL")
Interact with Games
https://www.marketwatch.com/games
To get information about games on the site:
marketwatch.get_games()
Get Game
marketwatch.get_game("game-name")
Get Game Settings
marketwatch.get_game_settings("game-name")
Get Leaderboard
marketwatch.get_leaderboard("game-name")
Get Portfolio
marketwatch.get_portfolio("game-name")
Get Positions
marketwatch.get_positions("game-name")
Get Pending Orders
marketwatch.get_pending_orders("game-name")
Buy Stock
marketwatch.buy(game_id, "AAPL", 100)
Sell Stock
marketwatch.sell("game-name", "AAPL", 100)
Create Watchlist
https://www.marketwatch.com/watchlist
To create a watchlist:
marketwatch.create_watchlist('My Watchlist')
Add Stock to Watchlist
To add stocks to a watchlist:
marketwatch.add_to_watchlist(watchlist_id, ['AAPL', 'GOOG'])
Get All Watchlists
To get all watchlists:
watchlists = marketwatch.get_watchlists()
Delete Watchlist
To delete a watchlist:
marketwatch.delete_watchlist(watchlist_id)
Example
import os
username = os.environ.get("MARKETWATCH_USERNAME")
password = os.environ.get("MARKETWATCH_PASSWORD")
marketwatch = MarketWatch(username, password)
print(f"Price: {marketwatch.get_price('AAPL')} \n")
print(f"Games: {marketwatch.get_games()} \n")
games1 = marketwatch.get_games()[0]["name"].lower().replace(" ", "-")
print(f"Game: {marketwatch.get_game(games1)} \n")
print(f"Game Settings: {marketwatch.get_game_settings(games1)} \n")
print(f"Leaderboard: {marketwatch.get_leaderboard(games1)} \n")
print(f"Porfolio: {marketwatch.get_portfolio(games1)} \n")
print(f"Position: {marketwatch.get_positions(games1)}")
print(f"Orders Pending: {marketwatch.get_pending_orders(games1)}")
marketwatch.buy(games1, "AAPL", 100)
print(f"Position diff: {marketwatch.get_positions(games1)}")
Contributing
Contributions are welcome. Please open an issue or submit a pull request.
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for marketwatch-0.2.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 846c644a8289958bdf5c22e1c78f5e748213a6c9d1448413b887b7ab62c3d686 |
|
MD5 | 94508265a7a5d02dd6642369d47d1580 |
|
BLAKE2b-256 | 46f8fad6a9c897f7d455a8d3ad15859dfb06ba0a3a64619b51ee17174442c5d4 |