bt_getorder: Order Data for a Specified Order

View source: R/private-interface.r

bt_getorderR Documentation

Order Data for a Specified Order

Description

The bt_getorder() function retrieves open order data on https://bittrex.com. This function can only be used after you provide information for authentication.

Usage

bt_getorder(uuid)

Arguments

uuid

the uuid of the order.

Value

A named list with the following elements:

  • success: a boolean indicating whether the request was successful.

  • message: a string describing the error if the request was not successful, otherwise an empty string.

  • result: a data.frame providing information about the open order including (but not limited to) the market, quantity remaining in the order, the type of order, and when the order was opened.

References

https://bittrex.com/api/v1.1/account/getorder

See Also

bt_authenticate(), bt_getopenorders()

Examples

## Not run: 
# Note you must authenticate and define a uuid first.
bt_getorder(uuid)
# $success
# [1] TRUE
#
# $message
# [1] ""
#
# $result
#   account_id                           order_uuid exchange      type quantity
# 1         NA 63181c27-dd14-476e-960c-1bd8366bb312  ETH-LTC LIMIT_BUY        1
#   quantity_remaining limit reserved reserve_remaining commission_reserved
# 1                  1 0.001    0.001             0.001             2.5e-06
#   commission_reserve_remaining commission_paid price price_per_unit
# 1                      2.5e-06               0     0             NA
#                    opened closed is_open                             sentinel
# 1 2017-07-11T17:05:55.583     NA    TRUE 78b210fa-a156-4f4d-8043-51163740056f
#   cancel_initiated immediate_or_cancel is_conditional condition
# 1            FALSE               FALSE          FALSE      NONE
#   condition_target
# 1               NA

## End(Not run)

ropensci/bittrex documentation built on July 6, 2022, 7:53 a.m.