convex-value-python
Python API wrapper library for Convex Value API.
Further Links:
Authentication
Grab your API key from Convex Value terminal. This will be used when instantiating a CVObject
.
To avoid hardcoding your token in, set it as an environment variable if you'd like: export CV_API_KEY=
Using
# import the library
from convexvalue.core import CVObject
# instantiate a CV Object
cvx = CVObject('
Supported methods
Method Name
Description
Object Method
Parameters
getFlowTableParams
gets the available parameters for usage in fields and filters
CVObject.getFlowTableParams()
None
getChain
gets the options chain for a symbol
CVObject.getChain(sym: str, otm: str, stks: int, exp: str, fields: str)
sym
: symbol of the stock ticker, e.g. AAPl
otm
: out-of-the-money, e.g. True
stks
: e.g. 5
exp: expiration dates, e.g. 1,2,3
fields
: fields to bring into chart, e.g. vol,delta,gamma
tasQuery
gets database result
CVObject.tasQuery(lim: int, filters: str, root: str, dir: str, orderby: str)
lim
: limit of data, e.g. 100
filters
: query filters, e.g. size>100
root
: symbol of stock, e.g. AAPL
dir: direction, e.g. desc
orderby
: field to order by, e.g. size
getSeries
gets simple series data for a symbol
CVObject.getSeries(sym: str)
sym
: symbol of the stock ticker, e.g. AAPl
activeOptionsQuery
gets the options database result
CVObject.activeOptionsQuery(lim: int, filters: str, dir: str, orderby: str)
lim
: limit of data, e.g. 100
filters
: query filters, e.g. volm>100,delta<0.05,delta>0.05
dir
: direction, e.g. desc
orderby
: field to order by, e.g. dayVolume
getFlowTable
gets the options flow table
CVObject.getFlowTable(lim: int, fields: str, cat: str, list: str, page: int, minprem: int, maxprem: int)
lim
: limit of data, e.g. 100
fields
: fields to bring into chart, e.g. value,price,volatility
cat
: direction, e.g. ALL
list
: field to order by, e.g. ALL
page
: pagination marker, e.g. 1
minprem
: minium premium filter, e.g. 0
maxprem
: maximum premium filter, e.g. 0
getFlowRep
gets the options flow rep
CVObject.getFlowRep()
None