Implements highfrequency financial econometrics tools.
Project description
Table of Contents
 HFFE: HighFrequency Financial Econometrics
 Introduction
 Stocks
 Options
 Under development
 Redo introduction
 Add examples on how to use stock.py
 Add examples on how to use options.py
 Change file stock.py to stocks.py
 Add citations
 Sample data
 [stock.py] Change internals to pandas dataframe
 [stock.py]
 [stock.py] Truncated variance estimator
 [stock.py] Local volatility estimator
 [stock.py] Confidence intervals
HFFE: HighFrequency Financial Econometrics
Introduction
This package implements some tools of the highfrequency financial econometrics literature.
The HFFE package provides a class Stock
. This class can be used in two ways:
 Instantiate the class and provide stock data. The instance
__init__
method will automatically compute geometric returns, realized and bipower variances, and separate diffusive from jump returns using the stock data supplied.  Use the class methods by themselves as needed. All of the methods in
Stock
are static methods and can be used without instantiating the class.
The class can be instantiated via the default constructor by supplying an iterable containing prices (floats) and an iterable containing date stamps (in the format YYYYMMDD for year, month and day). The default constructor also takes an optional iterable containing time stamps (in the format HHMM for hour and minute or HHMMSS for hour, minute and second). The data is assumed to be rectangular, meaning that each day contains the same number of price observations.
Prices are assumed to be observed (N) times per day, at the same discrete intervals. For example, if prices are sampled every 5 minutes starting from 9:30 AM and finishing at 4:00 PM, then we will have (N=79) price observations per day. Prices are assumed to be observed for (T) total days. In each of these (T) days we have (N) price observations. Geometric returns (logreturns) are computed for each of the days and for each of the discrete sampling intervals. However, overnight returns are not considered, and the packaged only focuses on the analysis of intraday returns. If there are (N=79) price observations each day, then we will have (n=78) returns each day.
Example:
from hffe import Stock
from random import normalvariate as randn
# generate some fake data
prices = np.array([10.0 + randn(0, 1) for _ in range(10)])
dates = ['20181112']*len(prices)
times = [f'093{i}' for i in range(10)]
# instantiate class
stock = Stock(prices, dates, times)
# at this point we can access the returns, variance measures and
# obtain the diffusive returns separated from the jump returns
print(f'Number of prices per day: {stock.total["prices"]}\n'
f'Number of days: {stock.total["days"]}')
print(stock.returns)
# print measures of variance
print(f'Realized Variance: {stock.RV}\n'
f'Annualized Realized Variance: {(252*stock.RV)**0.5}\n'
f'Bipower Variance: {stock.BV}\n'
f'Annualized Bipower Variance: {(252*stock.BV)**0.5}')
Stocks
Options
Under development
TODO Redo introduction
TODO Add examples on how to use stock.py
TODO Add examples on how to use options.py
TODO Change file stock.py to stocks.py
TODO Add citations

TODO To volatility estimators

TODO To jump threshold and separtion

TODO To timeofday factor
TODO Sample data

TODO Sample stock data

TODO Sample SPX options data
TODO [stock.py] Change internals to pandas dataframe
TODO [stock.py]
TODO [stock.py] Truncated variance estimator
TODO [stock.py] Local volatility estimator
TODO [stock.py] Confidence intervals
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.