Data

Tools

Indexes

Applications

Experiments

Open Source Science

simfinapi

Makes 'SimFin' data (https://simfin.com/) easily accessible in R.

https://github.com/matthiasgomolka/simfinapi

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (18.5%) to scientific vocabulary

Keywords

api simfin-data
Last synced: 10 months ago · JSON representation

Repository

Makes 'SimFin' data (https://simfin.com/) easily accessible in R.

Basic Info
  • Host: GitHub
  • Owner: matthiasgomolka
  • Language: R
  • Default Branch: main
  • Homepage:
  • Size: 1.48 MB
Statistics
  • Stars: 20
  • Watchers: 3
  • Forks: 5
  • Open Issues: 9
  • Releases: 5
Topics
api simfin-data
Created over 6 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing Code of conduct Support

README.Rmd 

---
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")` [![CRAN
release](https://www.r-pkg.org/badges/version/simfinapi)](https://CRAN.R-project.org/package=simfinapi)
[![Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-CMD-check](https://github.com/matthiasgomolka/simfinapi/workflows/R-CMD-check/badge.svg)](https://github.com/matthiasgomolka/simfinapi/actions)
[![](https://codecov.io/gh/matthiasgomolka/simfinapi/branch/main/graph/badge.svg)](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.

Owner

  • Name: Matthias Gomolka
  • Login: matthiasgomolka
  • Kind: user
  • Location: Frankfurt, Germany
  • Company: Deutsche Bundesbank

GitHub Events

Total
  • Issues event: 1
  • Watch event: 1
  • Push event: 1
Last Year
  • Issues event: 1
  • Watch event: 1
  • Push event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 161
  • Total Committers: 7
  • Avg Commits per committer: 23.0
  • Development Distribution Score (DDS): 0.068
Past Year
  • Commits: 23
  • Committers: 2
  • Avg Commits per committer: 11.5
  • Development Distribution Score (DDS): 0.217
Top Committers
Name Email Commits
Matthias m****a@p****e 150
snirhali s****i@s****m 5
bryce s****e@g****m 2
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
Committer Domains (Top 20 + Academic)
simfin.com: 1 posteo.de: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 45
  • Total pull requests: 20
  • Average time to close issues: 6 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 12
  • Total pull request authors: 4
  • Average comments per issue: 2.38
  • Average comments per pull request: 0.85
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • matthiasgomolka (20)
  • MislavSag (8)
  • GitHubGeniusOverlord (6)
  • thf24 (2)
  • ogig33 (2)
  • bxhorn (1)
  • saffcap (1)
  • vsoler (1)
  • zos474 (1)
  • snvv (1)
  • msperlin (1)
  • anuragjalan (1)
Pull Request Authors
  • matthiasgomolka (19)
  • Shivam-Nirhali (2)
  • superchordate (2)
  • knapply (1)
Top Labels
Issue Labels
enhancement (7) internal (5) bug (4) documentation (4)
Pull Request Labels
bug (2)

Packages

  • Total packages: 1
  • Total downloads:
    • cran 261 last-month
  • Total docker downloads: 41,971
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
cran.r-project.org: simfinapi

Accessing 'SimFin' Data

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 261 Last month
  • Docker Downloads: 41,971
Rankings
Forks count: 12.8%
Stargazers count: 15.6%
Downloads: 16.1%
Average: 21.9%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Maintainers (1)
matthias.gomolka@posteo.de
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5 depends
  • RcppSimdJson >= 0.1.1 imports
  • bit64 * imports
  • checkmate >= 2.0.0 imports
  • data.table >= 1.12.8 imports
  • future.apply >= 1.4.0 imports
  • httr * imports
  • memoise >= 1.1.0 imports
  • progressr * imports
  • utils * imports
  • knitr * suggests
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/R-CMD-check-standard.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite