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

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

Async ready API wrapper for Revolt API written in Python.

Mutiny Async ready API wrapper for Revolt API written in Python. Installation Python 3.9 or higher is required To install the library, you can just ru

16 Mar 29, 2022

A Python API wrapper for the Twitter API!

PyTweet PyTweet is an api wrapper made for twitter using twitter's api version 2! Installation Windows py3 -m pip install PyTweet Linux python -m pip

1 Nov 19, 2022

YARSAW is an Async Python API Wrapper for the Random Stuff API.

Yet Another Random Stuff API Wrapper - YARSAW YARSAW is an Async Python API Wrapper for the Random Stuff API. This module makes it simpler for you to

6 Mar 27, 2022

EpikCord.py - This is an API Wrapper for Discord's API for Python

EpikCord.py - This is an API Wrapper for Discord's API for Python! We've decided not to fork discord.py and start completely from scratch for a new, better structuring system!

28 Oct 10, 2022

A simple Python API wrapper for Cloudflare Stream's API.

python-cloudflare-stream A basic Python API wrapper for working with Cloudflare Stream. Arbington.com started off using Cloudflare Stream. We used the

3 Sep 8, 2022

An API wrapper around the pythonanywhere's API.

pyaww An API wrapper around the pythonanywhere's API. The name stands for pythonanywherewrapper. 100% api coverage most of the codebase is documented

7 Dec 11, 2022

An API Wrapper for Gofile API

Gofile2 from gofile2 import Gofile g_a = Gofile() print(g_a.upload(file="/home/itz-fork/photo.png")) An API Wrapper for Gofile API. About API Gofile

16 Dec 10, 2022

A simple API wrapper for the Tenor API

Gifpy A simple API wrapper for the Tenor API Installation Python 3.9 or higher is recommended python3 -m pip install gifpy Clone repository: $ git cl

4 Dec 22, 2021

An API wrapper around Discord API.

NeoCord This project is work in progress not for production use. An asynchronous API wrapper around Discord API written in Python. Features Modern API