Python API wrapper library for Convex Value API.
Further Links:
Use environment variables for your ConvexValue credentials. This will be used when instantiating a ConvexValue.
Avoid hardcoding your credentials, set them as environment variables:
export CONVEX_VALUE_EMAIL=<email>
export CONVEX_VALUE_PASSWORD=<password>
# import the library
from convexvalue import ConvexValue
# instantiate a CV Object
cvx = ConvexValue()
# print out the flow rep for Cloudflare (NET)
print(cvx.getFlowRep('NET'))
| 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 |
Here are the tables available to be queried with SQL.
schema,name,type
public,daylist,materialized view
public,futrootdir,table
public,opt_dir,table
public,opt_full,materialized view
public,opt_full_view,view
public,opt_greeks,table
public,opt_oich,materialized view
public,opt_profile,table
public,opt_quote,table
public,opt_summary,table,
public,opt_tas,table
public,opt_trade,table
public,opth,table
public,opth_exps,materialized view
public,tas,table
public,tash,table
public,trm,table
public,trmh,table
public,und_dir,table
public,und_flow,table
public,und_full,materialized view
public,und_full_view,view
public,und_profile,table
public,und_quote,table
public,und_summary,table
public,und_tas,table
public,und_trade,table
public,und_underlying,table
public,undh,table