getOrders: Retrieve Orders Information from Brokers

View source: R/getOrders.R

getOrdersR Documentation

Retrieve Orders Information from Brokers

Description

This function retrieves information about orders from different brokers/exchanges

Usage

getOrders(
  src = "",
  board = "MOEX",
  api.key = "",
  orderId = "",
  clientId = "",
  stopOrders = FALSE,
  verbose = TRUE
)

Arguments

src

Character string specifying the source broker/exchange (e.g., "tinkoff", "finam", "alor")

board

Character string specifying the trading board (default is "MOEX")

api.key

Character string specifying the API key for the broker/exchange

orderId

Character string specifying the order ID to retrieve (default is "")

clientId

Character string specifying the client ID for the broker/exchange

stopOrders

Logical specifying whether to retrieve stop orders (default is FALSE)

verbose

Logical specifying whether to display additional information (default is TRUE)

Value

A list containing order information from the broker/exchange

Note

Not for the faint of heart. All profits and losses related are yours and yours alone. If you don't like it, write it yourself.

Author(s)

Vyacheslav Arbuzov

See Also

getTrades cancelOrder placeOrder

Examples

# Retrieve all orders from Tinkoff
getOrders(src = "tinkoff", api.key = "your_api_key", clientId = "your_client_id")

# Retrieve all orders from Finam
getOrders(src = "finam", api.key = "your_api_key", clientId = "your_client_id")

# Retrieve all orders from Alor
getOrders(src = "alor", api.key = "your_api_key", clientId = "your_client_id")

rusquant documentation built on Sept. 30, 2024, 9:42 a.m.

Related to getOrders in rusquant...