| Type: | Package |
| Title: | R Interface to OpenFIGI |
| Version: | 0.2.8 |
| Author: | Ruokun Huang <hruokun.2008@gmail.com> |
| Maintainer: | Ruokun Huang <hruokun.2008@gmail.com> |
| Description: | Provide a simple interface to Bloomberg's OpenFIGI API. Please see https://openfigi.com for API details and registration. You may be eligible to have an API key to accelerate your loading process. |
| License: | GPL (≥ 3) |
| LazyData: | TRUE |
| URL: | https://github.com/HuangRicky/ROpenFIGI |
| Imports: | httr, jsonlite |
| Suggests: | testthat, dplyr |
| RoxygenNote: | 5.0.1 |
| Packaged: | 2016-06-03 00:51:28 UTC; hrk |
| NeedsCompilation: | no |
| Repository: | CRAN |
| Date/Publication: | 2016-06-04 08:38:44 |
ROpenFIGI
Description
ROpenFIGI
Details
Provide a simple interface to OpenFIGI by Bloomberg. parse data into data.frame
Author(s)
Ruokun Huang hruokun.2008@gmail.com
Maintainer: Ruokun Huang hruokun.2008@gmail.com
OpenFIGI main function
Description
OpenFIGI main function
Usage
OpenFIGI(input, apikey = NULL,
openfigiurl = "https://api.openfigi.com/v1/mapping", preferdf = F)
Arguments
input |
input data.frame or json, and others that can be feed into toJSON |
apikey |
your API key |
openfigiurl |
Bloomberg's OpenFIGI URL, please see https://openfigi.com/api |
preferdf |
if only supply 1 input, do you prefer to see the data.frame directly |
Details
you may need to setInternet2() or set up proxy if needed
Value
a list of data.frame, of a data.frame if preferdf=T and only 1 request
Examples
## Not run:
setInternet2()
figirst = OpenFIGI(sampleOpenFIGIdf())
## End(Not run)
Create mapping table out of OpenFIGI
Description
Create mapping table out of OpenFIGI
Usage
OpenFIGI_MappingCreator(input, apikey = NULL,
openfigiurl = "https://api.openfigi.com/v1/mapping",
additioncols = c("ID_ISIN", "ID_BB_UNIQUE", "ID_SEDOL", "ID_COMMON",
"ID_WERTPAPIER", "ID_CUSIP", "ID_BB", "ID_ITALY", "ID_EXCH_SYMBOL",
"ID_FULL_EXCHANGE_SYMBOL", "COMPOSITE_ID_BB_GLOBAL",
"ID_BB_GLOBAL_SHARE_CLASS_LEVEL", "ID_BB_SEC_NUM_DES", "ID_BB_GLOBAL",
"TICKER", "ID_CUSIP_8_CHR", "OCC_SYMBOL", "UNIQUE_ID_FUT_OPT", "OPRA_SYMBOL",
"TRADING_SYSTEM_IDENTIFIER"))
Arguments
input |
input data.frame or json, and others that can be feed into toJSON |
apikey |
your API key |
openfigiurl |
Bloomberg's OpenFIGI URL, please see https://openfigi.com/api |
additioncols |
additional columns you would like to include in the data.frame |
Details
assiging ISIN, CUSIP and other columns needed. Requires dplyr package to bind rows.
Value
a data.frame
Examples
## Not run:
setInternet2()
figirst = OpenFIGI_MappingCreator(sampleOpenFIGIdf())
## End(Not run)
Assign addition cols
Description
Assign addition cols
Usage
OpenFIGI_assignadditionalcols(rst1, additioncols)
Arguments
rst1 |
a result list |
additioncols |
additional columns you would like to include in the data.frame |
Details
internal function
Value
a data.frame with new columns
Generate a Sample data.frame for FIGI request
Description
Generate a Sample data.frame for FIGI request
Usage
sampleOpenFIGIdf()
Value
a data.frame of sample request
Generate FIGI Supported Identifiers
Description
Generate FIGI Supported Identifiers
Usage
showFIGIIDType()
Value
a char vector