cancelOrder: Cancel an order on a broker/exchange platform

View source: R/cancelOrder.R

cancelOrderR Documentation

Cancel an order on a broker/exchange platform

Description

This function cancels an existing order on a specified broker or exchange platform

Usage

cancelOrder(
  src = "",
  api.key = "",
  orderId = "",
  clientId = "",
  board = "",
  live = TRUE,
  verbose = TRUE
)

Arguments

src

character string, the name of the broker/exchange platform, e.g. "tinkoff", "finam", "alor"

api.key

character string, the API key required for authentication

orderId

character string, the ID of the order to be cancelled

clientId

character string, the ID of the client account

board

character string, the name of the exchange board, required for some platforms

live

logical, whether to execute the order in a live environment, default is TRUE

verbose

logical, whether to print the HTTP response message, default is TRUE

Value

character string, the response message from the HTTP request

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.

Examples

cancelOrder(src = 'Finam',api.key = 'finam_token',orderId = 'otderID',clientId = 'your cliend id')

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