oanda_view {ichimoku} | R Documentation |
OANDA View Market Performance
Description
Provides a snapshot overview of markets on an intraday basis, showing the relative performance of individual constituents.
Usage
oanda_view(
market = c("allfx", "bonds", "commodities", "fx", "metals", "stocks"),
price = c("M", "B", "A"),
server,
apikey
)
Arguments
market |
string specifying the market: 'allfx' for all available currencies, 'bonds' for government bonds, 'commodities' for commodities, 'fx' for major currency pairs, 'metals' for metals and 'stocks' for global stock markets. |
price |
[default "M"] pricing component, one of "M" (midpoint), "B" (bid) or "A" (ask). |
server |
(optional) specify the "practice" or "live" server according to
the account type held. If not specified, will default to "practice", unless
this has been changed by |
apikey |
(optional) string containing the OANDA fxTrade API key (personal
access token), or function that returns this string. Does not need to be
specified if already stored as the environment variable
|
Details
This function is designed for interactive use.
For further details please refer to the OANDA fxTrade API vignette by
calling: vignette("xoanda", package = "ichimoku")
.
Value
A data.frame containing the daily open, high, low and last prices, along with the percentage price change from the open, ordered by the percentage change. The instrument names are set as row names.
The first timestamp retrieved and the pricing component are printed to the console as well as saved as attributes to the dataframe. The dataframe is also printed to the console.
Examples
## Not run:
# OANDA fxTrade API key required to run this example
oanda_view("fx")
## End(Not run)