Unofficial https://stake.com.au API wrapper.
Project description
Stake
Stake is an unofficial Python client for the Stake trading platform.
This library wraps the current Stake RPC api and allows common trade operations, such as submitting buy/sell requests, checking your portfolio etc...
Please note that, at the current stage, the Stake client is asynchronous.
Installation
pip install stake
Quickstart
After you install the package, you will need to authenticate to Stake in order to get authorization to interact with your account.
In order to successfully issue requests to the Stake platform you will need to authenticate to it. Every requests to the Stake endpoints will need to contain a Stake-Session-Token
in the request headers.
Using an existing Session-Token
You can retrieve one of these Stake-Session-Token
by using the developer tools in your browser for example and inspecting some of the request headers sent to some of the https://global-prd-api.hellostake.com/
host.
They are usually valid for 30 days and seem to get refreshed before expiry so you should be good to use them directly.
If you already have an existing token you can pass it on to the StakeClient
as such:
from stake import StakeClient, SessionTokenLoginRequest, CredentialsLoginRequest
import asyncio
login_request = SessionTokenLoginRequest(token="secrettoken")
async def print_user():
async with StakeClient(login_request) as stake_session:
print(stake_session.user.first_name)
print(stake_session.headers.stake_session_token)
asyncio.run(print_user())
NOTE: The default value of the token is read from the
STAKE_TOKEN
environment variable. If you have that env-var set you should be able to just use:async with StakeClient() as stake_session: ...
Login with your credentials
If you prefer to pass in your username/password credentials to login instead, it's easy to do:
If you do not have two-factor authentication enabled:
from stake import StakeClient, SessionTokenLoginRequest, CredentialsLoginRequest
import asyncio
login_request = CredentialsLoginRequest(
username="youruser@name.com", # os.getenv("STAKE_USER") by default
password="yoursecretpassword") # os.getenv("STAKE_PASS") by default
async def print_user():
async with StakeClient(login_request) as stake_session:
print(stake_session.user.first_name)
print(stake_session.headers.stake_session_token)
asyncio.run(print_user())
If you have two-factor authentication enabled:
In this case you need to have your phone around, get the current code from the authenticator app and add it to the CredentialsLoginRequest
as such:
login_request = CredentialsLoginRequest(username="youruser@name.com",password="yoursecretpassword",
otp="Your-authenticator-app-code")
Obviously, this can become a bit inconvenient, since you will need to provide the otp code every time you instantiate a new StakeClient
instance. Therefore, you could probably authenticate once with your credentials, retrieve the session token from the headers(stake_session.headers.stake_session_token
), and store it in the STAKE_TOKEN
env-var for subsequent usages.
Examples
With stake-python
you can do most of the operations that are available through the web app.
Here are some examples:
Display the contents of your portfolio
from stake import StakeClient, SessionTokenLoginRequest, CredentialsLoginRequest
import asyncio
async def show_portfolio():
# here the client will use the STAKE_TOKEN env var for authenticating
async with StakeClient() as stake_session:
my_equities = await stake_session.equities.list()
for my_equity in my_equities.equity_positions:
print(my_equity.symbol, my_equity.yearly_return_value)
return my_equities
asyncio.run(show_portfolio())
Which will return something like:
AAPL 80.48
ADBE 251.35
GOOG 559.89
GRPN -13.77
HTZ -10.52
MSFT 97.14
NFLX 263.55
NIO 17.3
NVDA 410.04
OKTA 96.31
SHOP 690.68
SPOT 142.88
SQ 101.75
TQQQ 115.82
TSLA 402.37
VGT 130.08
ZM 331.1
Buy/Sell shares
You can send buy/sell orders to the platform quite easily by just issuing trade requests.
Please check the stake.trade
module for more details.
async def example_limit_buy():
symbol = "UNKN" # should be the equity symbol, for ex: AAPL, TSLA, GOOGL
async with StakeClient() as stake_session:
return trades.buy(
LimitBuyRequest(symbol=symbol, limitPrice=10, quantity=1000)
)
asyncio.run(example_limit_buy())
To perform multiple requests at once you can use an asyncio.gather
operation to run all the buy trades in parallel.
async def example_stop_sell():
"""THis example will add a stop sell request for one of your equities"""
my_equities = await show_portfolio()
symbol = "T.SLA" # mispelt on purpose so that no trade actually happens, should be TSLA.
tsla_equity = [equity for equity in my_equities.equity_positions if equity.symbol == symbol]
stop_sell_request = stake.StopSellRequest(symbol=tsla_equity.symbol,
stopPrice=stop_price,
comment="My stop sell.",
quantity=current_equity.available_for_trading_qty)
result = await stake_client.trades.sell(request=stop_sell_request)
symbol = "UNKN" # should be the equity symbol, for ex: AAPL, TSLA, GOOGL
async with StakeClient() as stake_session:
return trades.buy(
LimitBuyRequest(symbol=symbol, limitPrice=10, quantity=1000)
)
asyncio.run(example_limit_buy())
Contributors
Contributors on GitHub
License
- see LICENSE file
Contact
- Created by Stefano Tabacco
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.