Skip to content

Issue 12 #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rpesche wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Issue 12 #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08e0eab
add tests whene price pair is not available
May 16, 2019
d076614
bug: fix getting price where a coin pair is not available
May 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 113 additions & 106 deletions cryptocompy/price.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,102 +1,109 @@
from deepmerge import always_merger
# price.py

from .helper_functions import build_url, load_data, timestamp_to_date, \
date_to_timestamp


def get_current_price(fsyms, tsyms, e='all', try_conversion=True, full=False,
format='raw'):
"""Get latest trading price or full trading information in display or raw
format for the specified FROM/TO currency pairs.

Args:
fsyms: Single string or list of FROM symbols.
tsyms: Single string or list of TO symbols.
e: Default returns average price across all exchanges. Can be set to the
name of a single exchange.
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try to get values without using any conversion at all.
full: Default of False returns only the latest price. True returns the
following dictionary structure containing the full trading info:
format: Default returns the 'RAW' format. Can be set to 'DISPLAY'
format.
Returns:
Returns a dictionary containing the latest price pairs if full is set to
false:

{fsym1: {tsym1: ..., tsym2:..., ...},
fsym2: {...},
...}

or full trading info dictionaries for all the price pairs in the other
case:

{fsym1: {tsym1: {'CHANGE24HOUR': ...,
'CHANGEPCT24HOUR': ...,
'FLAGS': ...,
'FROMSYMBOL': ...,
'HIGH24HOUR': ...,
'LASTMARKET': ...,
'LASTTRADEID': ...,
'LASTUPDATE': ...,
'LASTVOLUME': ...,
'LASTVOLUMETO': ...,
'LOW24HOUR': ...,
'MARKET' ...,
'MKTCAP': ...,
'OPEN24HOUR': ...,
'PRICE': ...,
'SUPPLY': ...,
'TOSYMBOL': ...,
'TYPE': ...,
'VOLUME24HOUR': ...,
'VOLUME24HOURTO': ...},
tsym2: ..., ...},
fsym2: {...},
...}
"""

# select API function based on 'full' parameter value
if not full:
func = 'pricemulti'
else:
func = 'pricemultifull'

# convert single fsym and tsym input to single element lists
if not isinstance(fsyms, list):
fsyms = [fsyms]
if not isinstance(tsyms, list):
tsyms = [tsyms]

# load data
url = build_url(func, fsyms=fsyms, tsyms=tsyms, e=e,
try_conversion=try_conversion)
data = load_data(url)

# select right format to return for full requests
if full and format == 'raw':
data = data['RAW']
elif full and format == 'display':
data = data['DISPLAY']

return data


def get_current_trading_info(fsym, tsym, markets='all', try_conversion=True,
def get_current_price(fsyms, tsyms, e='all', try_conversion=True, full=False,
format='raw'):
"""Get latest trading price or full trading information in display or raw
format for the specified FROM/TO currency pairs.

Args:
fsyms: Single string or list of FROM symbols.
tsyms: Single string or list of TO symbols.
e: Default returns average price across all exchanges.
Can be set to the name of a single exchange.
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion.
If set to false, it will try to get values
without using any conversion at all.
full: Default of False returns only the latest price. True returns the
following dictionary structure containing the full trading info:
format: Default returns the 'RAW' format. Can be set to 'DISPLAY'
format.
Returns:
Returns a dictionary containing the latest price pairs
if full is set to false:

{fsym1: {tsym1: ..., tsym2:..., ...},
fsym2: {...},
...}

or full trading info dictionaries for all the price pairs in the other
case:

{fsym1: {tsym1: {'CHANGE24HOUR': ...,
'CHANGEPCT24HOUR': ...,
'FLAGS': ...,
'FROMSYMBOL': ...,
'HIGH24HOUR': ...,
'LASTMARKET': ...,
'LASTTRADEID': ...,
'LASTUPDATE': ...,
'LASTVOLUME': ...,
'LASTVOLUMETO': ...,
'LOW24HOUR': ...,
'MARKET' ...,
'MKTCAP': ...,
'OPEN24HOUR': ...,
'PRICE': ...,
'SUPPLY': ...,
'TOSYMBOL': ...,
'TYPE': ...,
'VOLUME24HOUR': ...,
'VOLUME24HOURTO': ...},
tsym2: ..., ...},
fsym2: {...},
...}
"""

# select API function based on 'full' parameter value
if not full:
func = 'pricemulti'
else:
func = 'pricemultifull'

# convert single fsym and tsym input to single element lists
if not isinstance(fsyms, list):
fsyms = [fsyms]
if not isinstance(tsyms, list):
tsyms = [tsyms]

# load data
data = {}
for tsym in tsyms:
url = build_url(func, fsyms=fsyms, tsyms=[tsym], e=e,
try_conversion=try_conversion)
pair_data = load_data(url)
if pair_data.get('Response') == 'Error':
continue
data = always_merger.merge(data, pair_data)

# select right format to return for full requests
if full and format == 'raw':
data = data['RAW']
elif full and format == 'display':
data = data['DISPLAY']

return data


def get_current_trading_info(fsym, tsym, markets='all', try_conversion=True,
format='raw'):
"""
Get the latest trading info of the requested pair as a volume weighted
Get the latest trading info of the requested pair as a volume weighted
average based on the markets requested.

Args:
fsym: FROM symbol.
tsym: TO symbol.
markets: List containing the market names.
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try to get values without using any conversion at all.
format: Default returns the 'RAW' format. Can be set to 'DISPLAY'
format: Default returns the 'RAW' format. Can be set to 'DISPLAY'
format.

Returns:
Expand All @@ -122,7 +129,7 @@ def get_current_trading_info(fsym, tsym, markets='all', try_conversion=True,
'LASTVOLUME': ...}
"""

# load data
# load data
url = build_url('generateAvg', fsym=fsym, tsym=tsym, markets=markets,
try_conversion=try_conversion)
data = load_data(url)
Expand All @@ -136,7 +143,7 @@ def get_current_trading_info(fsym, tsym, markets='all', try_conversion=True,
return {fsym: {tsym: data}}


def get_day_average_price(fsym, tsym, e='all', try_conversion=True,
def get_day_average_price(fsym, tsym, e='all', try_conversion=True,
avg_type='HourVWAP', utc_hour_diff=0):
"""
Get the current days average price of a currency pair.
Expand All @@ -146,8 +153,8 @@ def get_day_average_price(fsym, tsym, e='all', try_conversion=True,
tsym: TO symbol.
e: Default returns average price across all exchanges. Can be set to the
name of a single exchange.
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try to get values without using any conversion at all.
avg_type: 'HourVWAP' returns a volume weighted average of the hourly
close price. The other option 'MidHighLow' gives the average between
Expand All @@ -163,15 +170,15 @@ def get_day_average_price(fsym, tsym, e='all', try_conversion=True,
######################

Returns:
Returns a price dictionairy containing the current days average price as
Returns a price dictionairy containing the current days average price as
float.

{fsym: {tsym: price}}
"""

# load data
url = build_url('dayAvg', fsym=fsym, tsym=tsym, e=e,
try_conversion=try_conversion, avg_type=avg_type,
url = build_url('dayAvg', fsym=fsym, tsym=tsym, e=e,
try_conversion=try_conversion, avg_type=avg_type,
utc_hour_diff=utc_hour_diff)
data = load_data(url)

Expand All @@ -182,7 +189,7 @@ def get_day_average_price(fsym, tsym, e='all', try_conversion=True,


def get_historical_eod_price(fsym, tsyms, date, e='all', try_conversion=True):
"""Get end of day price for cryptocurrency in any other currency for the
"""Get end of day price for cryptocurrency in any other currency for the
requested timestamp.

Args:
Expand All @@ -191,12 +198,12 @@ def get_historical_eod_price(fsym, tsyms, date, e='all', try_conversion=True):
date: Date as string with this format: "Y-m-d H:M:S".
e: Default returns average price across all exchanges. Can be set to the
name of a single exchange.
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try to get values without using any conversion at all.

Returns:
Returns a dictionary containing the end of day price pairs for the
Returns a dictionary containing the end of day price pairs for the
provided date.

{fsym: {tsym1: ..., tsym2: ..., ...}}
Expand All @@ -210,31 +217,31 @@ def get_historical_eod_price(fsym, tsyms, date, e='all', try_conversion=True):
ts = date_to_timestamp(date)

# load data
url = build_url("pricehistorical", fsym=fsym, tsyms=tsyms, ts=ts,
url = build_url("pricehistorical", fsym=fsym, tsyms=tsyms, ts=ts,
e=e, try_conversion=try_conversion)
data = load_data(url)

return data


def get_historical_data(fsym, tsym, freq, info='full', e='all',
try_conversion=True, aggregate=1, limit=1440,
def get_historical_data(fsym, tsym, freq, info='full', e='all',
try_conversion=True, aggregate=1, limit=1440,
to_ts=False):
"""Get minute-by-minute historical price and volume information for
"""Get minute-by-minute historical price and volume information for
the requested currency pair. Available data is limited to the last 7 days.

Args:
fsym: FROM symbol.
tsym: TO symbol.
freq: Frequency of the data. Can be set to 'minute', 'hour' or 'day'.
info: Select price or volume information to return. Default of 'full'
returns all of them. Can be set to 'high', 'low', 'open', 'close',
returns all of them. Can be set to 'high', 'low', 'open', 'close',
'volumefrom', and 'volumeto' or a list containing several of those
values.
e: Default returns average price across all exchanges. Can be set to the
name of a single exchange.
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try_conversion: If the crypto does not trade directly into the toSymbol
requested, BTC will be used for conversion. If set to false, it will
try to get values without using any conversion at all.
aggregate: Aggregates the minute prices into bins of the specified size.
limit: Number of minute prices. The limit settings depend on the freq
Expand All @@ -243,7 +250,7 @@ def get_historical_data(fsym, tsym, freq, info='full', e='all',
hour: default = 168, min = 1, max 2000
day: default = 30, min = 1, max 2000

Using aggregate reduces the maximum number of points that can be
Using aggregate reduces the maximum number of points that can be
returned by a factor equal to the chosen bin size.

# add 'toTs' parameter
Expand All @@ -265,8 +272,8 @@ def get_historical_data(fsym, tsym, freq, info='full', e='all',
"""

# load data
url = build_url(freq, fsym=fsym, tsym=tsym, freq=freq, e=e,
try_conversion=try_conversion, aggregate=aggregate,
url = build_url(freq, fsym=fsym, tsym=tsym, freq=freq, e=e,
try_conversion=try_conversion, aggregate=aggregate,
limit=limit, to_ts=to_ts)
data = load_data(url)
data = data['Data']
Expand All @@ -288,4 +295,4 @@ def get_historical_data(fsym, tsym, freq, info='full', e='all',
if k not in info and k != 'time':
del d[k]

return data
return data
2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@

deepmerge==0.0.5
Empty file added tests/__init__.py
View file
Open in desktop
Empty file.
Loading