The CoinpaprikaAPI Instance¶

class coinpaprikaAPI.coinpaprikaAPI.Coinpaprika(debug=False, headers=None, proxy=None, *args, **kwargs)[source]¶

Bases: coinpaprikaAPI.common.request.Request

coin(coin_id)[source]¶

Get coin data by ID.

Parameters:	coin_id (`str`) –
Return type:	`Dict`[`str`, `Union`[`str`, `int`, `Dict`[~KT, ~VT]]]

coin_exchanges(coin_id)[source]¶

Get exchanges by coin ID.

Parameters:	coin_id (`str`) –
Return type:	`List`[`Dict`[`str`, `Union`[`str`, `int`, `List`[`Dict`[~KT, ~VT]]]]]

coins()[source]¶

List all available coins.

Parameters:	coin_id –
Return type:	`List`[`Dict`[`str`, `Union`[`str`, `int`]]]

events(coin_id)[source]¶

Get coin events by coin ID.

Parameters:	coin_id (`str`) –
Return type:	`List`[`Dict`[`str`, `Union`[`str`, `bool`]]]

exchange(exchange_id, quotes='')[source]¶

Get exchange by ID.

Parameters:	exchange_id (`str`) – quotes (`str`) – Comma separated list of quotes to return.

exchange_markets(exchange_id, quotes='')[source]¶

Get markets by exchange ID.

Parameters:	exchange_id (`str`) – quotes (`str`) – Comma separated list of quotes to return.

exchanges(quotes='')[source]¶

List exchanges.

Parameters:	quotes (`str`) – Comma separated list of quotes to return.

global_market()[source]¶

Get market overview.

Return type:	`Dict`[`str`, `Union`[`str`, `int`]]

historical_tickers(coin_id, *, start_date, end_date='', limit=1000, quote='usd', interval='5m')[source]¶

Get historical tickers for specific coin.

Parameters:	coin_id (`str`) – start_date (`str`) – Start point for historical data. end_date (`str`) – End point for historical data. limit (`int`) – Limit of result rows. quote (`str`) – Returned data quote. interval (`str`) – Returned points interval.

markets(coin_id)[source]¶

Get markets by coin ID.

Parameters:	coin_id (`str`) –
Return type:	`List`[`Dict`[`str`, `Union`[`str`, `bool`, `float`, `Dict`[`str`, `Dict`[`str`, `float`]]]]]

ohlc(coin_id, quote='usd')[source]¶

Get OHLC for last full day.

Parameters:	coin_id – quote – Returned data quote.
Return type:	`List`[`Dict`[`str`, `Union`[`str`, `int`]]]

ohlcv(coin_id, *, start_date, end_date='', limit=1, quote='usd')[source]¶

Get historical OHLC.

Parameters:	coin_id – start_date (`str`) – Start point for historical data. end_date (`str`) – End point for ohlcv (max 1 year). limit (`int`) – Limit of result rows. quote (`str`) – Returned data quote.

ohlcv_today(coin_id, quote='usd')[source]¶

Get today OHLC.

Parameters:	coin_id – quote – Returned data quote.

people(person_id)[source]¶

Get people by ID.

Parameters:	person_id (`str`) –

price_converter(base_currency_id, quote_currency_id, amount=0)[source]¶

Convert currencies.

Parameters:	base_currency_id (`str`) – quote_currency_id (`str`) – amount (`int`) –

search(query, categories='', modifier='', limit=6)[source]¶

Search the Coinpaprika API.

Parameters:	query (`str`) – Phrase to search for. c – One or more categories (comma separated) to search. modifier (`str`) – Set modifier for search results. limit (`int`) – Limit of results per category.

tag(tag_id, additional_fields='')[source]¶

Get tag by ID.

Parameters:	tag_id (`str`) – additional_fields – Comma separated list of additional fields to include in query result for each tag.

tags(additional_fields='')[source]¶

List tags.

Parameters:	additional_fields – Comma separated list of additional fields to include in query result for each tag.

ticker(coin_id, quotes='')[source]¶

Get ticker information for specific coin.

Parameters:	coin_id (`str`) – quotes – Comma separated list of quotes to return.

tickers(quotes='')[source]¶

Get tickers for all coins.

Parameters:	quotes – Comma separated list of quotes to return.

twitter(coin_id)[source]¶

Get twitter timeline for coin.

Parameters:	coin_id (`str`) –
Return type:	`List`[`Dict`[`str`, `Union`[`str`, `int`]]]