forked from matbarofex/rRofex
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
93 lines (62 loc) · 2.24 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
options(tibble.print_min = 5, tibble.print_max = 5)
```
# rRofex! <img src='man/figures/r-rofex.png' align="right" height="139"/>
## Overview
This package lets you access ROFEX APIs using R. Having this will enable to integrate ROFEX data easily into R workflows.
## Installation
At the moment `rRofex` is only available through GitHub usind `devtools`.
#### Installing with `devtools`
1. In R install the package `devtools`.
```{r, eval=FALSE}
install.packages("devtools")
```
2. Once `devtools` is installed.
```{r, eval=FALSE}
library(devtools)
devtools::install_github("gruporofex/rRofex")
```
## References
We provide a convinient wrapper for consuming data from ROFEX APIs:
- **Trading API (in development)**
- Risk API (to be developed)
- BackOffice API (to be developed)
### Trading API (in development)
These are the currently available methods:
- LogIn method
- Request for Reference Data
- Market Data Real Time
- Historical Market Data
- Send Orders
Available environments:
- *Demo environrment*: go to [reMarkets](https://remarkets.primary.ventures/) to get credentials.
- *Production*: it needs credetentials. Please contact: <mpi@primary.com.ar> for more information.
## Examples
```{r, eval=FALSE}
library(rRofex)
# Once you have cretencials, you'll be able to get a token when you login
rRofex::trading_login(username = XXX, password = XXX, env ='reMarkets')
# You can get a complete Reference Data list with details
rRofex::trading_instruments(request = "securities", sec_detailed = T)
# Real Time Prices using the REST APP
rRofex::trading_md(symbol = "DODic19")
# Historical Trades
rRofex::trading_mdh(symbol = "DOJul19", date = "2019-06-06")
```
## Acknowledgements
Development of this software was driven by [Primary](https://www.primary.com.ar/)
as part of an Open Source initiative of [Grupo Rofex](https://www.rofex.com.ar/).
#### Author/Maintainer
- [Augusto Hassel](https://github.com/augustohassel)
#### Internal Contributors
- [Juan Francisco Gomez](https://github.com/jfgomezok)