Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/walkjivefly/LOC-Extension

LibreOffice Cryptocurrency extension
https://github.com/walkjivefly/LOC-Extension

altcoin bitcoin calc crypto cryptocurrency ethereum exchange extension libreoffice libreoffice-extension lookup ticker

Last synced: 2 months ago
JSON representation

LibreOffice Cryptocurrency extension

Lists

README 

        
LOC-Extension: LibreOffice calc Cryptocurrency market functions

===

The LOC extension allows you to create customized spreadsheets with cryptocurrency market data directly from the web. This version (0.2.3) provides 2 lookup functions: a dedicated getPoloniex() (for compatibility with version 0.1.0) and a generic ccxt() which uses an embedded snapshot of the amazing [ccxt](https://github.com/ccxt/ccxt) library. This means over 90 exchanges are now supported.



### Download   

You can download the current version of the LOC Extension here [0.2.3](https://github.com/walkjivefly/LOC-Extension/releases/tag/v0.2.3)



The LOC extension is also available from the [LibreOffice Extension Center](https://extensions.libreoffice.org/extensions/loc-extension-for-libreoffice-calc).



**NOTE**: The extension itself is LOC.oxt.  The example .ods worksheet demonstrates how to use the extension.



### Usage



The LOC Extension adds two new functions to Calc. The first is:  

```

GETPOLONIEX(Ticker,Datacode) 

```  



Quotes **must** be used when entering the ticker directly ex: ```GETPOLONIEX("BTC_ETH","last")```, but are **not** needed when referencing another cell ex: ```GETPOLONIEX(A1,A2)```.



In the latter case the data in A1 should be ```BTC_ETH```, not ```"BTC_ETH"```.



**NOTE**: The full set of datacodes are demonstrated in the example .ods worksheet included with the release. The worksheet also contains a full list of the available symbols/currency-pairs.



The second new function is:

```

CCXT(Exchange, Ticker, Datacode)

```



Exchange is any exchange name supported by the embedded ccxt snapshot (version 1.9.262). Quotes **must** be used according to the same rules as for GETPOLONIEX().



Ticker is a currency pair from the ccxt unified API.

**NOTE**: The format of the ticker is different from that for GETPOLONIEX(). The valid values depend on the exchange being addressed. They are generally coin/coin, eg: ETH/BTC when buying/selling ETH and paying/getting paid in BTC.



Datacode is one of the ccxt supported data items for the fetch_ticker function. The one you'll probably use most is "last".



### Performance 



v0.2.3 introduces caching for some of the ccxt supported exchanges. This relies on the ccxt load_markets() function downloading data for every ticker combination supported by the exchange. The cached information is then used for every subsequent lookup for that exchange. If you're pulling the prices for many tickers and you have a slow internet connection this provides a very substantial, very worthwhile, performance improvement after the first fetch. 



The exchanges which provide caching are bitmex, coinmarketcap, gatecoin, lakebtc, livecoin, luno, nova, poloniex, qryptos, quoine, therock and vaultoro.



If you bought coins from, or store coins on (NOT recommnded), multiple exchanges and you have less than stellar internet performance you might want to consider getting price information from a single caching exchange if it carries all of your coins. If no one caching exchange carries all of your coins then consider getting data from Coinmarketcap if performance is more important than up to the minute accuracy.



### Coinmarketcap  (Updated 27 November 2018)



Coinmarketcap plan to deprecate their "public" API on 4 December 2018. They have released a tiered "professional" API replacement. This has various levels of functionality/price points, including a free "basic" level. None of the levels provide identical functionality to the deprecated API. 



After they make the switch, LOC-Extension will no longer be able to pull data from Coinmarketcap. 



~~Coinmarketcap is supported by ccxt but it is not a regular exchange; it is an aggregator. It works slightly differently to a regular exchange. It doesn't provide coin/coin tickers. Instead, it provides coin/fiat tickers for 15 supported fiat currencies (AUD, BRL, CAD, CHF, CNY, EUR, GBP, HKD, IDR, INR, JPY, KRW, MXN, RUB, and USD). In addition it provides some special data like total market cap in USD and bitcoin crypto-currency market percentage dominance. These are accessed using a special ticker, "GLOBAL", and datacode items "market_cap" and "dominance". Further, there are 2 special data items for each coin: market cap in USD, and rank. These are accessed from the coin/USD ticker with datacodes "market_cap_usd" and "rank". Since the data is aggregated from multiple exchanges and not real-time this is one of the sources which uses caching. If you just want a reasonable approximation of the current value of each coin in your portfolio then coinmarketcap is the quickest way to get it via the LOC-Extension. **Coinmarketcap is a bit of a work-in-progress and right now returns cached data from the markets info field, the contents and labels of which are not the same as in the fetch_ticker() function. So right now instead of using "last" for the price it is necessary to use "price_btc" or "price_usd".**~~



### Windows users



At the present time v[0.2.2](https://github.com/walkjivefly/LOC-Extension/tree/v0.2.2) is the only version recommended for Windows users. This is because some have experienced problems installing v0.2.0. LOC-Extension includes some logging which worked on the test Windows (7) machine I had access to but which is incompatible with (at least some) other machines. I do not currently have access to a Windows (any version) machine for testing.



Windows users are **STRONGLY** recommended to make a system snapshot before installing this or any other LibreOffice extension. Then when it goes horribly wrong you'll have a much simpler time recovering.

 

### Upgrading



The LibreOffice extension mechanism is poorly documented and extremely fragile. It is **STRONGLY** recommended that you remove the previous version of LOC-Extension before adding this one. If you use the replace option you might or might not end up with indecipherable error messages or an unusable extension. 



LibreOffice does not handle extension files with spaces in the names well. The spaces usually end up being there because your browser renames files to things like "LOC (1).oxt" if there is already a (previous) version in your download directory. If you attempt to install/upgrade using such a file the process will fail and leave the extension in an inconsistent state: it won't appear in the installed extensions list but if you try to install the same version again it will say it is already installed. Take care to remove previous downloads before downloading the latest extension, or to rename it after downloading and remove any spaces from the filename. See bug [114708](https://bugs.documentfoundation.org/show_bug.cgi?id=114708)



If you/LibreOffice really screw things up I recommend closing LibreOffice, renaming the entire customisation directory (~/.config/libreoffice/4 on linux), restarting it and re-installing (all) your extensions. 



Recovering from a messed-up extension installation/upgrade is much harder for Windows users. Really, make a system snapshot before installing or upgrading any LibreOffice extension. 



### Dependencies



LOC-Extension is fully standalone. It includes an embedded snapshot of Igor Kroitor's [ccxt](http://github.com/ccxt/ccxt). 



### Support



For general support please visit the [forums](http://forum.openoffice.org/en/forum/index.php). If you find a bug or wish to request a feature please file an issue at the [issue tracker](http://github.com/walkjivefly/LOC-Extension/issues).



### Contribute



Help is always welcome with development.  If you would like to contribute you will need to fork the main repo, make your changes, and send a [pull request](http://github.com/walkjivefly/LOC-Extension/pulls) to have your changes moderated and merged back into the main repo. Details on that process can be found [here](https://help.github.com/articles/set-up-git/).  



### License



The LOC Extension is released under the [![][shield:LGPL3]][License:3.0] which in layman's terms means:  



* You are permitted to use, copy and redistribute the work "as-is".

* You may adapt, remix, transform and build upon the material, releasing any derivatives under your own name.

* You may use the material for commercial purposes as long as the derivative is licenced under the GPL.

* You must track changes you make in the source files.

* You must include or make available the source code with your release.



ccxt is released under the MIT license.



### Warranty



There is **NO** warranty of any kind. You use the software entirely at your own risk. I am not responsible if anything goes wrong.



### Other Contributors and Thanks!

* madsailor - provided the original SMF Extension that LOC is based on

* Igor Kroitor - actively maintains the [ccxt](https://github.com/ccxt/ccxt) library



### Donate



If you find the extension useful and feel like throwing some coins my way, please use one of these addresses:



* LTC: MDH8P4XcaZEwrX7PrQVxag4matzHmmjnVa



[GIT:release]: http://github.com/walkjivefly/LOC-Extension/releases/latest

[License:3.0]: http://www.gnu.org/licenses/lgpl.html

[shield:LGPL3]: http://img.shields.io/badge/license-LGPL%20v.3-blue.svg