Package 'RTTWebClient'

Title: Web Client to 'TickTrader'
Description: R Web Client to 'TickTrader' platform. Provides you access to 'TickTrader' platform through Web API <https://ttlivewebapi.fxopen.net:8443/api/doc/index>.
Authors: Yury Maisiayonak [aut, cre]
Maintainer: Yury Maisiayonak <[email protected]>
License: GPL-2
Version: 0.1.3
Built: 2024-12-04 07:14:15 UTC
Source: CRAN

Help Index

Get Bar History

Description

Get Bar History

Arguments

symbol

a character. Symbol Name.
barsType.

a character. Bars Type. One from c("Ask", "Bid").
periodicity.

a character. Periodicity. From c("S1", "S10", "M1", "M5", "M15", "M30", "H1", "H4", "D1", "W1","MN1")
startTime

a POSIXct obj. Start Time in UTC.
endTime

a POSIXct obj. End Time in UTC.
count.

Integer. Count of returned Bars from startTime. Max is 1000. Can be negative. If count == 0, use time interval between startTime and endTime.

Value

data.table with Bar Info

Get All Currency

Description

Get All Currency

Value

data.table with currency info

Get All Current Quotes

Description

Get All Current Quotes

Value

a data.table with current quotes

Get All Dividend

Description

Get All Dividend

Value

a data.table with dividends.

Get Pips Value

Description

Get Pips Value

Arguments

targetCurrency

a character. Currency Name.
symbols

a character vectors. Symbols vector.

Value

a data.table with pips value in targetCurrency for every symbol in symbols vector

Get All Symbols

Description

Get All Symbols

Value

data.table with symbol info

Get Ticks History

Description

Get Ticks History

Arguments

symbol.

A character. Symbol Name.
startTime

a POSIXct obj. Start Time in UTC.
endTime

a POSIXct obj. End Time in UTC.
count.

Integer. Count of returned Ticks from startTime. Max is 1000. Can be negative. If count == 0, use time interval between startTime and endTime.

Value

data.table with Ticks Info.

Init RTTWebApiHost

Description

Init RTTWebApiHost

Usage

InitRTTWebApiHost(
  server = "ttlivewebapi.fxopen.com",
  port = 8443L,
  id = NULL,
  key = NULL,
  secret = NULL
)

Arguments

server

a character. Web Address.
port

an integer. Port Number. Default is 8443
id

a character. HMAC client id.
key

a character. HMAC client key.
secret

a character. HMAC secret key.

Value

RTTWebApiHost ref class.

RTTWebApiHost

Description

RTTWebApiHost

Fields

client.

RTTWebClient obj.

Methods

GetBarsHistory( symbol, barsType = "Bid", periodicity = "M1", startTime, endTime = as.POSIXct(Sys.Date(), tz = "GMT"), count = 0L )

Get Bar History

GetCurrencyInfo()

Get All Currencies

GetCurrentQuotes()

Get All Current Quotes

GetDividends()

Get All Dividends

GetPipsValue(targetCurrency, symbols)

Get Pips Value

GetSymbolsInfo()

Get All Symbols

GetTickHistory( symbol, startTime, endTime = as.POSIXct(Sys.Date(), tz = "GMT"), count = 0L )

Get Bar History