rgdax (version 1.2.1)

list_orders: Get List of All Orders for the User

Description

This is an auth based function. User must have valid api keys generated by GDAX which must be passed as mandatory arguments. The function will return all open orders by default for Bitcoin This is an extension of open_orders.

Usage

list_orders(
  api.key,
  secret,
  passphrase,
  product_id = "BTC-USD",
  status = "open"
)

Arguments

api.key

Mandatory character value. This is the API key as generated by GDAX. Typically a 32 character value.

secret

Mandatory character value. This is the API secret as generated by GDAX. Typically a 88 character value.

passphrase

Mandatory character value. This is the passphrase as generated by GDAX. Typically a 11 character value.

product_id

Optional character value for the currency pair. The default is "BTC-USD". This param is case insensitive and must be one of the valid currency-pair. The list of valid currency-pairs can be fetched using public_info.

status

Optional character value. Limit list of orders to either of `open`, `pending`, or `active` statuses. Passing `all` returns orders of all statuses.

Value

Dataframe with all orders for a given status for that currency.

Examples

# NOT RUN {
list_orders(api.key = your_key,
secret = your_api_secret,
passphrase = your_api_pass)

list_orders(api.key=your_api_key,secret=your_secret,
passphrase=your_passphrase,
product_id="BTC-EUR",status="active")
# }
# NOT RUN {
# }