Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matthiasgomolka/simfinapi
Makes 'SimFin' data (https://simfin.com/) easily accessible in R.
https://github.com/matthiasgomolka/simfinapi
api simfin-data
Last synced: about 1 month ago
JSON representation
Makes 'SimFin' data (https://simfin.com/) easily accessible in R.
- Host: GitHub
- URL: https://github.com/matthiasgomolka/simfinapi
- Owner: matthiasgomolka
- Created: 2019-12-30T21:27:33.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T21:35:59.000Z (8 months ago)
- Last Synced: 2024-11-03T19:50:06.189Z (about 2 months ago)
- Topics: api, simfin-data
- Language: R
- Homepage:
- Size: 1.47 MB
- Stars: 19
- Watchers: 3
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.Rmd
- Contributing: .github/CONTRIBUTING.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
- awesome-quant - simfinapi - Makes 'SimFin' data (<https://simfin.com/>) easily accessible in R. (R / Data Sources)
README
---
output: github_document
---
```{r include=FALSE}
library(badger)
library(knitr)
library(ggplot2)
opts_chunk$set(
fig.width = 8,
fig.height = 4.5,
fig.path = "man/figures/README-",
dpi = 150,
collapse = TRUE,
comment = "#>",
out.width = "100%"
)
options(sfa_api_key = Sys.getenv("SIMFIN_API_KEY"))
options(sfa_cache_dir = tempdir())
options("future.rng.onMisuse" = "ignore")
theme_set(theme_minimal())
```
# simfinapi 
`r badge_lifecycle("experimental")` [](https://CRAN.R-project.org/package=simfinapi)
[](https://www.repostatus.org/#active)
[](https://github.com/matthiasgomolka/simfinapi/actions)
[](https://app.codecov.io/gh/matthiasgomolka/simfinapi)
`r badge_dependencies()`
## What does simfinapi do?
simfinapi wraps the Web-API to make 'SimFin' data easily available in R.
*To use the package, you need to register at and obtain a 'SimFin'
API key.*
## Example
In this example, we download some stock price data and turn these into a simple plot.
```{r download_data}
# load package
# library(simfinapi)
devtools::load_all()
# download stock price data
tickers <- c("AMZN", "GOOG") # Amazon, Google
prices <- sfa_load_shareprices(tickers)
```
Please note that all functions in simfinapi start with the prefix `sfa_`. This makes it easy to
find all available functionality.
The downloaded data looks like this:
```{r show_data, echo=FALSE}
kable(head(prices))
```
Let's turn that into a simple plot.
```{r plot_data}
# load ggplot2
library(ggplot2)
# create plot
ggplot(prices) +
aes(x = Date, y = `Last Closing Price`, color = name) +
geom_line()
```
## Installation
From [CRAN](https://CRAN.R-project.org/package=simfinapi):
```{r install_cran, eval = FALSE}
install.packages("simfinapi")
```
If you want to try out the newest features you may want to give the development version a try and
install it from [GitHub](https://github.com/matthiasgomolka/simfinapi):
```{r install_github, eval=FALSE}
remotes::install_github("https://github.com/matthiasgomolka/simfinapi")
```
## Setup
Using simfinapi is much more convenient if you set your API key and cache directory[^1] globally
before you start downloading data. See `?sfa_set_api_key` and `?sfa_set_cache_dir` for details.
[^1]: simfinapi always caches the results from your API calls to obtain results quicker and to
reduce the number of API calls. If you set the cache directory to a permanent directory (the
default is `tempdir()`), simfinapi will be able to reuse this cache in subsequent R sessions.
## Code of Conduct
Please note that the 'simfinapi' project is released with a [Contributor Code of
Conduct](https://github.com/matthiasgomolka/simfinapi/blob/master/.github/CODE_OF_CONDUCT.md). By
contributing to this project, you agree to abide by its terms.