Description Usage Arguments Details Value Note See Also Examples
Unified processing of API call according to API dictionary api.dict
. Limited to markets and currency processing defined in api.dict
, in case of currency pairs and methods not availble in dictionary use market.api.query
directly. This function perform pre processing of request and post processing of API call response to unified structure across markets.
1 2 3 4 |
market |
character, example: |
currency_pair |
character vector of length 2, e.g. |
action |
character, defined process/method to get organized data.
|
req |
list of action details (price, amount, tid, oid, etc.) unified across the markets specific per action, see examples. |
skip_post_process |
logical skip post-processing and return results only after |
api.dict |
data.table user custom API dictionary definition, if not provided function will use default Rbitcoin |
verbose |
integer. Rbitcoin processing messages, print to console if |
... |
objects to be passed to
|
By default it will perform antiddos check and wait if required, it can be turned off but in such case you should expect to be banned quite easily. Read ?antiddos
.
Unless skip_post_process==TRUE
the returned value depends on the action
param but does not depend on market
anymore.
It returns a list or data.table.
It will also result truncation of most (not common across the markets) attributes returned. If you need the full set of data returned by markets API you might use skip_post_process=TRUE
.
All actions will return API call response but also metadata about API call itself, in a common structure across different markets.
Follow Rbitcoin introduction vignette or examples.
The api dictionary was not fully tested, if you find any bugs please report. Use only api dictionaries from trusted source or review them before using!
market.api.query
, api.dict
, antiddos
, query.dict
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | ## Not run:
# get ticker from market
market.api.process(market = 'kraken', currency_pair = c('BTC', 'EUR'), action='ticker')
# get ticker from few markets and combine
op <- options("Rbitcoin.antiddos.verbose" = 1) # will print antiddos waiting time
ticker_all <- rbindlist(list(
market.api.process(market = 'bitstamp', currency_pair = c('BTC', 'USD'), action='ticker'),
market.api.process(market = 'btce', currency_pair = c('LTC', 'USD'), action='ticker'),
market.api.process(market = 'btce', currency_pair = c('LTC', 'BTC'), action='ticker'),
market.api.process(market = 'kraken', currency_pair = c('BTC','EUR'), action='ticker'),
market.api.process(market = 'kraken', currency_pair = c('LTC','EUR'), action='ticker'),
market.api.process(market = 'kraken', currency_pair = c('BTC','LTC'), action='ticker')
))
options(op)
print(ticker_all)
# get wallet from market
market.api.process(market = 'kraken', action = 'wallet', key = '', secret = '')
# get wallet from all markets and combine
wallet_all <- rbindlist(list(
market.api.process(market = 'bitstamp', action = 'wallet',
client_id = '', key = '', secret = '')[['wallet']],
market.api.process(market = 'btce', action = 'wallet',
method = '', key = '', secret = '')[['wallet']],
market.api.process(market = 'kraken', action = 'wallet',
key = '', secret = '')[['wallet']]
))
print(wallet_all)
# get order book from market
market.api.process(market = 'kraken', currency_pair = c('BTC', 'EUR'), action = 'order_book')
# get open orders from market
market.api.process(market = 'kraken', action = 'open_orders', key = '', secret = '')
# place limit order
market.api.process(market = 'kraken', currency_pair = c('BTC', 'EUR'), action = 'place_limit_order',
req = list(type = 'sell', amount = 1, price = 8000), # sell 1 btc for 8000 eur
key = '', secret = '')
# cancel order
market.api.process(market = 'kraken', action = 'cancel_order',
req = list(oid = 'oid_from_open_orders'),
key = '', secret = '')
# get trades, since arg allowed: `req = list(tid = "123456")`
market.api.process(market = 'kraken', currency_pair = c('BTC', 'EUR'), action = 'trades')
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.