get_custom_average()

Compute the current trading info (price, vol, open, high, low etc) of the requested pair as a volume weighted average based on the exchanges requested.

1. fsym [Required]: The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
2. tsym [Required]: The currency symbol to convert into [ Min length - 1] [ Max length - 30]
3. e [Required]: The exchange to obtain data from [ Min length - 2] [ Max length - 150]
4. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
5. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_exchange_volume(duration::String, tsym::String; e::String="all", aggregate::Int=1, aggregatePredictableTimePeriods::Bool=true, limit::Int=30,toTs::String="", extraParams::String="", sign::Bool=false)

Get total volume from the daily historical exchange data. The values are based on 00:00 GMT time. We store the data in BTC and we multiply by the BTC-tsym value. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}.

1. tsym [Required]: The currency symbol to convert into [ Min length - 1] [ Max length - 30]
2. e: The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - CCCAGG]
3. aggregate: Time period to aggregate the data over (for daily it's days, for hourly it's hours and for minute histo it's minutes) [ Min - 1] [ Max - 30] [ Default - 1]
4. aggregatePredictableTimePeriods: Only used when the aggregate param is also in use. If false it will aggregate based on the current time.If the param is false and the time you make the call is 1pm - 2pm, with aggregate 2, it will create the time slots: ... 9am, 11am, 1pm.If the param is false and the time you make the call is 2pm - 3pm, with aggregate 2, it will create the time slots: ... 10am, 12am, 2pm.If the param is true (default) and the time you make the call is 1pm - 2pm, with aggregate 2, it will create the time slots: ... 8am, 10am, 12pm.If the param is true (default) and the time you make the call is 2pm - 3pm, with aggregate 2, it will create the time slots: ... 10am, 12am, 2pm. [ Default - true]
5. limit: The number of data points to return. If limit * aggregate > 2000 we reduce the limit param on our side. So a limit of 1000 and an aggerate of 4 would only return 2000 (max points) / 4 (aggregation size) = 500 total points + current one so 501. [ Min - 1] [ Max - 2000] [ Default - 30]
6. toTs: Returns historical data before that timestamp. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}
7. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
8. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_historical_daily(fsym::String; limit::Int=30, toTs::String="", extraParams::String="", sign::String="", api_key::String=api_key)

1. fsym [Required]: The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 10]
2. limit: The number of data points to return. [ Min - 1] [ Max - 2000] [ Default - 30]
3. toTs: Returns historical data before that timestamp. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}
4. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
5. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_historical_data(duration::String, fsym::String, tsym::String; tryConversion::Bool=true,
                            e::String="all", aggregate::Int=1, aggregatePredictableTimePeriods::Bool=true, 
                            limit::Int=30, allData::Bool=false, toTs::String="", explainPath::Bool=false, extraParams::String="", sign::Bool=false)

Get open, high, low, close, volumefrom and volumeto from the daily/hourly/minutewise historical data. The values are based on 00:00 GMT time. If e=CCCAGG and tryConversion=true, it attempts conversion through BTC or ETH to determine the best possible path. The conversion type and symbol used are appended per historical point. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}.

1. tryConversion: If set to false, it will try to get only direct trading values. This parameter is only valid for e=CCCAGG value [ Default - true]
2. fsym [Required]: The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
3. tsym [Required]: The currency symbol to convert into [ Min length - 1] [ Max length - 30]
4. e: The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - CCCAGG]
5. aggregate: Time period to aggregate the data over (for daily it's days, for hourly it's hours and for minute histo it's minutes) [ Min - 1] [ Max - 30] [ Default - 1]
6. aggregatePredictableTimePeriods: Only used when the aggregate param is also in use. If false it will aggregate based on the current time.If the param is false and the time you make the call is 1pm - 2pm, with aggregate 2, it will create the time slots: ... 9am, 11am, 1pm.If the param is false and the time you make the call is 2pm - 3pm, with aggregate 2, it will create the time slots: ... 10am, 12am, 2pm.If the param is true (default) and the time you make the call is 1pm - 2pm, with aggregate 2, it will create the time slots: ... 8am, 10am, 12pm.If the param is true (default) and the time you make the call is 2pm - 3pm, with aggregate 2, it will create the time slots: ... 10am, 12am, 2pm. [ Default - true]
7. limit: The number of data points to return. If limit * aggregate > 2000 we reduce the limit param on our side. So a limit of 1000 and an aggerate of 4 would only return 2000 (max points) / 4 (aggregation size) = 500 total points + current one so 501. [ Min - 1] [ Max - 2000] [ Default - 30]
8. allData: Returns all data (only available on histo day) [ Default - false]
9. toTs: Returns historical data before that timestamp. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}
10. explainPath: If set to true, each point calculated will return the available options it used to make the calculation path decision. This is intended for calculation verification purposes, please note that manually recalculating the returned data point values from this data may not match exactly, this is due to levels of caching in some circumstances. [ Default - false]
11. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
12. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_latest_news(; lang::String=EN, feeds::Array{String,1}, categories::Array{String,1}, ITs::Int64, sortOrder::String)

Gets the latest/popular news from CryptoCompare API.

Input parameters:

1. feeds: Specific news feeds to retrieve news from [ Min length - 1] [ Max length - 1000] [ Default - ALLNEWSFEEDS]
2. categories: Category of news articles to return [ Min length - 3] [ Max length - 1000] [ Default - ALLNEWSCATEGORIES]
3. excludeCategories: News article categories to exclude from results [ Min length - 3] [ Max length - 1000] [ Default - NOEXCLUDEDNEWS_CATEGORIES]
4. lTs: Returns news before that timestamp [ Min - 0] [ Default - 0]
5. lang: Preferred language - English (EN) or Portuguese (PT) [ Min length - 1] [ Max length - 4] [ Default - EN]
6. sortOrder: The order to return news articles - latest or popular [ Min length - 1] [ Max length - 8] [ Default - latest]
7. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
8. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_mining_calculator_data(fsyms::Array{String,1}, tsyms::Array{String,1}, extraParams::String, sign::Bool, api_key::String)

Get the price, the total supply, the hash rate, the block reward and the block time. Based on these values you can calculate the profitability of a mining rig.

1. fsyms [Required]: Comma separated cryptocurrency symbols list [ Min length - 1] [ Max length - 300]
2. tsyms [Required]: Comma separated cryptocurrency symbols list to convert into [ Min length - 1] [ Max length - 100]
3. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
4. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_multisymbol_fulldata(fsyms::Array{String,1}, tsyms::Array{String,1}; tryConversion::Bool=true, relaxedValidation::Bool=true, e::String="cccagg_or_exchange", extraParams::String="", sign::Bool=false)

Get all the current trading info (price, vol, open, high, low etc) of any list of cryptocurrencies in any other currency that you need. If the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion. This API also returns Display values for all the fields. If the opposite pair trades we invert it (eg.: BTC-XMR)

1. tryConversion: If set to false, it will try to get only direct trading values. This parameter is only valid for e=CCCAGG value [ Default - true]
2. fsyms [Required]: Comma separated cryptocurrency symbols list [ Min length - 1] [ Max length - 300]
3. tsyms [Required]: Comma separated cryptocurrency symbols list to convert into [ Min length - 1] [ Max length - 100]
4. relaxedValidation: Setting this to true will make sure you don't get an error on non trading pairs, they will just be filtered out of the response. [ Default - true]
5. e: The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - cccaggorexchange]
6. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
7. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_multisymbol_price(fsyms::Array{String,1}, tsyms::Array{String,1}; tryConversion::Bool=true, relaxedValidation::Bool=true, e::String="cccagg_or_exchange", extraParams::String="", sign::Bool=false)

Same as single API path but with multiple from symbols.

1. tryConversion: If set to false, it will try to get only direct trading values. This parameter is only valid for e=CCCAGG value [ Default - true]
2. fsyms [Required]: Comma separated cryptocurrency symbols list [ Min length - 1] [ Max length - 300]
3. tsyms [Required]: Comma separated cryptocurrency symbols list to convert into [ Min length - 1] [ Max length - 100]
4. relaxedValidation: Setting this to true will make sure you don't get an error on non trading pairs, they will just be filtered out of the response. [ Default - true]
5. e: The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - cccaggorexchange]
6. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
7. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_news_categories(; extraParams::String="", sign::Bool=false)

Gets the list of news categories from CryptoCompare API.

Input parameters:

1. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
2. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_news_feeds(; extraParams="", sign::Bool=false)

Gets the list of feeds from CryptoCompare API.

Input parameters:

1. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
2. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_news_feeds_and_categories(; extraParams::String="", sign::Bool=false)

Gets the list of feeds and categories from CryptoCompare API.

Input parameters:

1. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
2. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_symbol_price()

Get the current price of any cryptocurrency in any other currency that you need. If the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion. If the opposite pair trades we invert it (eg.: BTC-XMR)

1. tryConversion: If set to false, it will try to get only direct trading values. This parameter is only valid for e=CCCAGG value [ Default - true]
2. fsym [Required]: The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
3. tsyms [Required]: Comma separated cryptocurrency symbols list to convert into [ Min length - 1] [ Max length - 500]
4. relaxedValidation: Setting this to true will make sure you don't get an error on non trading pairs, they will just be filtered out of the response. [ Default - true]
5. e: The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - cccaggorexchange]
6. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
7. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_symbol_volume(duration::String, fsym::String, tsym::String; aggregate::Int=1, limit::Int=30, toTs::String="", extraParams::String="", sign::Bool=false)

Get total volumes from the daily historical symbol volume data. The volumes are stored in fsym (base) and are converted using the matching historical fsym - tsym conversion rates. For example if you are asking for the fsym BTC and tsym USD, the volume returned is the total BTC that was part of all trades (base and quote) converted using the BTC-USD exchange rate The value is based on 00:00 GMT time and is calculated as the sum of all trades where the symbol/asset was involved either as the from/base or as the to/quote/counter. The toptiervolumequote and base are totals based on exchanges included in our exchange benchmark that are ranked as AA, A or B. cccaggvolumequote and _base are based on the exchanges included in our CCCAGG average. totalvolume_quote and _base are the sum of all trades across all markets where the asset/coin was either the fsym/base or the tsym/quote/counter If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}.

1. fsym [Required]: The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
2. tsym [Required]: The currency symbol to convert into [ Min length - 1] [ Max length - 30]
3. aggregate: Time period to aggregate the data over (for daily it's days, for hourly it's hours and for minute histo it's minutes) [ Min - 1] [ Max - 30] [ Default - 1]
4. limit: The number of data points to return. If limit * aggregate > 2000 we reduce the limit param on our side. So a limit of 1000 and an aggerate of 4 would only return 2000 (max points) / 4 (aggregation size) = 500 total points + current one so 501. [ Min - 1] [ Max - 2000] [ Default - 30]
5. toTs: Returns historical data before that timestamp. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}
6. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
7. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]

get_symbol_volume_single_exchange(duration::String, fsym::String, tsym::String; e::String="all", aggregate::Int=1, limit::Int=30, toTs::String="", extraParams::String="", sign::Bool=false)

Get the daily from and to volume for a symbol on an exchange. The value is based on 00:00 GMT time and is calculated as the sum of all trades where the symbol/asset was involved either as the from/base or as the to/quote/counter on the requested exchange. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}.

1. fsym [Required]: The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
2. tsym [Required]: The currency symbol to convert into [ Min length - 1] [ Max length - 30]
3. e: The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - CCCAGG]
4. aggregate: Time period to aggregate the data over (for daily it's days, for hourly it's hours and for minute histo it's minutes) [ Min - 1] [ Max - 30] [ Default - 1]
5. limit: The number of data points to return. If limit * aggregate > 2000 we reduce the limit param on our side. So a limit of 1000 and an aggerate of 4 would only return 2000 (max points) / 4 (aggregation size) = 500 total points + current one so 501. [ Min - 1] [ Max - 2000] [ Default - 168]
6. toTs: Returns historical data before that timestamp. If you want to get all the available historical data, you can use limit=2000 and keep going back in time using the toTs param. You can then keep requesting batches using: &limit=2000&toTs={the earliest timestamp received}
7. extraParams: The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
8. sign: If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]