jojothebandit/blockfolio-sdk

Unofficial SDK for manipulation of cryptocurrency values in the blockfolio app

dev-master 2017-08-26 22:36 UTC

This package is not auto-updated.

Last update: 2024-06-12 20:07:03 UTC


README


A php wrapper around some Blockfolio requests
Now you can edit your crypto values in the app through this little SDK
DISCLAIMER: Since this is totally unofficial it can stop working at any time
I will try to keep up and fix stuff if it breaks, but I am not promising anything

How to install (Composer)

composer require "jojothebandit/blockfolio-sdk":"dev-master"

or add to your project's composer.json

"require": {
    "jojothebandit/blockfolio-sdk": "~1.0"
}

How to use

Find your client id in the settings part of Blockfolio
Instantiate the SDK with a client id

    use jojothebandit\BlockfolioSDK\BlockfolioSDK;

    $blockfolio = new BlockfolioSDK();
    $blockfolio->setClientId('YOUR_CLIENT_ID');

Get your whole portfolio in JSON

    $blockfolio->getPortfolio()

Get value of your portfolio(default currency is USD)
    $blockfolio->getPortfolioValue('USD')

Get quantity of coins of a specific crypto
    $blockfolio->getQuantity('ETH')

Add a "sell" transaction
    $blockfolio->sell(0.12, 'BTC');

Add a "buy" transaction
    $blockfolio->buy(0.67, 'ETH');

Add a sell transaction, with the amount being the amount you have currently in the app for a specific crypto
    $blockfolio->sellAll('ETH');

Make a trade, does two transactions, removes x of the first crypto, and adds y of the second
    $blockfolio->trade(5, 'LTC', 3, 'BTC'));

Find the exchange rate between two cryptos, mostly goes one way, BTC being the source crypto
    $blockfolio->getExchangeRate('BTC', 'ETH');

You can set the exchange with
    $blockfolio->setExchangeName('poloniex');

You can internally set the source and destination crypto
    $blockfolio->setSourceCrypto('BTC');
    $blockfolio->setDestinationCrypto('BCC');

Contribute

Contributions are more than welcome :)

Questions, problems?

I'll do my best to answer all issues

License

MIT License