uvatradier

uvatradier is a Python package that serves as a wrapper for the Tradier brokerage API. This package simplifies the process of making API requests, handling responses, and performing various trading and account management operations.

The package was originally developed by data science graduate students at the University of Virginia.

Wahoowa.

Features

• Account Management: Retrieve profile, balance, gain/loss, orders, and positions related to a trading account.
• Trading: Place, modify, and cancel equity and option orders.
• Market Data: Access real-time and historical market data for equities and options.
• Options Data: Retrieve options chains, strikes, and expiration dates.
• Stream Market Events: Stream market events via WebSocket.

Installation

To install uvatradier, you can use pip:

pip install uvatradier

Hello World

Steps to get started:

• Create an account with Tradier.com.

• Grab Account Number and Access Token from your Tradier dashboard.

  • Log into Tradier > Preferences (gear icon) > API Access (left panel) > Account Access (section).

• Create a .env file in the appropriate working directory on your computer.

  • Launch text editor application.

  • Save the file as .env.

  • In the file, add the following lines, replacing the appropriate placeholder fields:
    tradier_acct=<YOUR_ACCOUNT_NUMBER_FROM_TRADIER_DASHBOARD>

    tradier_token=<YOUR_ACCESS_TOKEN_FROM_TRADIER_DASHBOARD>

• Within the aforementioned working directory, initiate a new python session (interactive python, jupyter notebook, etc.).

• To authenticate yourself, add the following lines of code to the top of your python script or jupyter notebook:
  import os, dotenv

  from uvatradier import Tradier, Account, Quotes, EquityOrder, OptionsData, OptionsOrder, Stream

  dotenv.load_dotenv()

  tradier_acct = os.getenv('tradier_acct')

  tradier_token = os.getenv('tradier_token')

• To instantiate the class objects, use:
  account = Account(tradier_acct, tradier_token)

  quotes = Quotes(tradier_acct, tradier_token)

  equity_order = EquityOrder(tradier_acct, tradier_token)

  options_data = OptionsData(tradier_acct, tradier_token)

  options_order = OptionsOrder(tradier_acct, tradier_token)

• To enable live trading:

  • Modify the instantiation statements to include a third argument, live_trade=True.

  • Ensure that the tradier_acct and tradier_token variables correspond to your production account.
    

    tradier = Tradier(tradier_acct, tradier_token, live_trade=True)

    account = Account(tradier_acct, tradier_token, live_trade=True)

• If live trading is enabled, then you can utilize the Stream class to stream market events:

  stream = Stream(tradier_acct, tradier_token, live_trade=True)

Usage

This section provides examples of the most basic functionality. The examples include the minimal arguments needed for a valid function call.

For most of the class methods, additional examples can be found in their docstring (for example, help(Quotes.get_historical_quotes)).

You can also check the /examples/ directory if you're really desparate, but it is not (and has not been) updated in awhile.

Account Management

• Get User Profile:

  user_profile = account.get_user_profile()

• Get Account Balance:

  account_balance = account.get_account_balance()

• Get Gain/Loss:

  gain_loss = account.get_gainloss()

• Get Orders:

  orders = account.get_orders()

• Get Positions:

  positions = account.get_positions()

Trading

• Place Equity Order:

  order_response = equity_order.order(symbol='GOOD', side='buy', quantity=1, order_type='market', duration='day')

• Place Options Order:

  order_response = options_order.options_order(occ_symbol='GOOD241018C00015000', order_type='market', side='buy_to_open', quantity=1, duration='day')

Market Data

• Get Quote for Single Stock:

  stock_quote = quotes.get_quote_day('TAP')

• Get Historical Quotes:

  historical_quotes = quotes.get_historical_quotes('TAP')

• Get Time Sales:

  timesales = quotes.get_timesales('TAP')

• Get Quote for Multiple (List of) Stocks:

  quote_data = quotes.get_quote_data(['TAP', 'BUD', 'SAM'])

Options Data

• Get a Stock's Option Chain:

  option_chain = options_data.get_chain_day('FUN')

• Get Nearest Expiry Date to a Specified Number of Days into Future:

  option_closest_expiry = options_data.get_closest_expiry('FUN', num_days=45)

• Get Future Expiry Dates:

  option_expiry_dates = options_data.get_expiry_dates('FUN')

• Get All OCC Symbols for a Stock:

  option_symbols = options_data.get_options_symbols('FUN')

Stream Market Events

• Start market event stream for JP Morgan Chase:

  stream.stream_market_events(symbol_list=['JPM'])

• Stream Exxon Mobil and Kinder Morgan market events and filter for quote updates and trade events only with a line break to separate each new event:

  stream.stream_market_events(symbol_list=['XOM', 'KMI'], filter_list=['trade', 'quote'], line_break=True)

Development

To contribute or make changes to the uvatradier package, feel free to create a fork, clone the fork, make some improvements and issue a pull request. From the terminal/command prompt:

• Clone the forked branch to your local machine:

  git clone https://github.com/YOUR_USERNAME/uvatradier.git

• Navigate to the directory where the relevant code is kept:

  cd uvatradier

• If you need to be careful about dependencies, create a new Python virtual environment:
  

  python -m venv replace_this_with_desired_venv_name [Mac]
  

  venv\Scripts\activate [Windows]

Questions?

Happy to help! Feel free to contact Tom Hammons by email at qje5vf@virginia.edu.
Thanks much in advance for your interest in using the package.

License

uvatradier is licensed under the Apache License 2.0