{"id":13741281,"url":"https://github.com/matthiasgomolka/simfinapi","last_synced_at":"2026-02-21T12:01:55.874Z","repository":{"id":47149616,"uuid":"230982121","full_name":"matthiasgomolka/simfinapi","owner":"matthiasgomolka","description":"Makes 'SimFin' data (https://simfin.com/) easily accessible in R.","archived":false,"fork":false,"pushed_at":"2024-04-17T21:35:59.000Z","size":1544,"stargazers_count":19,"open_issues_count":8,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-03T19:50:06.189Z","etag":null,"topics":["api","simfin-data"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matthiasgomolka.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-12-30T21:27:33.000Z","updated_at":"2024-08-14T20:19:25.000Z","dependencies_parsed_at":"2024-01-25T05:09:12.477Z","dependency_job_id":"0a34add5-60e5-4813-947f-bdcba9571541","html_url":"https://github.com/matthiasgomolka/simfinapi","commit_stats":{"total_commits":161,"total_committers":7,"mean_commits":23.0,"dds":0.06832298136645965,"last_synced_commit":"39c0de7b7489c529d7ab3573b9ff6b910f228919"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthiasgomolka%2Fsimfinapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthiasgomolka%2Fsimfinapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthiasgomolka%2Fsimfinapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthiasgomolka%2Fsimfinapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matthiasgomolka","download_url":"https://codeload.github.com/matthiasgomolka/simfinapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224774738,"owners_count":17367786,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","simfin-data"],"created_at":"2024-08-03T04:00:57.442Z","updated_at":"2025-10-22T05:36:57.962Z","avatar_url":"https://github.com/matthiasgomolka.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":["Data Sources"],"readme":"---\noutput: github_document\n---\n\n```{r include=FALSE}\nlibrary(badger)\nlibrary(knitr)\nlibrary(ggplot2)\n\nopts_chunk$set(\n    fig.width = 8,\n    fig.height = 4.5,\n    fig.path = \"man/figures/README-\",\n    dpi = 150,\n    collapse = TRUE,\n    comment = \"#\u003e\",\n    out.width = \"100%\"\n)\n\noptions(sfa_api_key = Sys.getenv(\"SIMFIN_API_KEY\"))\noptions(sfa_cache_dir = tempdir())\noptions(\"future.rng.onMisuse\" = \"ignore\")\n\ntheme_set(theme_minimal())\n```\n\n# simfinapi \u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"139\"/\u003e\n\n`r badge_lifecycle(\"experimental\")` [![CRAN\nrelease](https://www.r-pkg.org/badges/version/simfinapi)](https://CRAN.R-project.org/package=simfinapi)\n[![Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![R-CMD-check](https://github.com/matthiasgomolka/simfinapi/workflows/R-CMD-check/badge.svg)](https://github.com/matthiasgomolka/simfinapi/actions)\n[![](https://codecov.io/gh/matthiasgomolka/simfinapi/branch/main/graph/badge.svg)](https://app.codecov.io/gh/matthiasgomolka/simfinapi)\n`r badge_dependencies()`\n\n## What does simfinapi do?\n\nsimfinapi wraps the \u003chttps://www.simfin.com/\u003e Web-API to make 'SimFin' data easily available in R.\n\n*To use the package, you need to register at \u003chttps://app.simfin.com/login\u003e and obtain a 'SimFin'\nAPI key.*\n\n## Example\n\nIn this example, we download some stock price data and turn these into a simple plot.\n\n```{r download_data}\n# load package\n# library(simfinapi)\ndevtools::load_all()\n\n# download stock price data\ntickers \u003c- c(\"AMZN\", \"GOOG\") # Amazon, Google\nprices \u003c- sfa_load_shareprices(tickers)\n```\n\nPlease note that all functions in simfinapi start with the prefix `sfa_`. This makes it easy to\nfind all available functionality.\n\nThe downloaded data looks like this:\n\n```{r show_data, echo=FALSE}\nkable(head(prices))\n```\n\nLet's turn that into a simple plot.\n\n```{r plot_data}\n# load ggplot2\nlibrary(ggplot2)\n\n# create plot\nggplot(prices) +\n    aes(x = Date, y = `Last Closing Price`, color = name) +\n    geom_line()\n```\n\n## Installation\n\nFrom [CRAN](https://CRAN.R-project.org/package=simfinapi):\n\n```{r install_cran, eval = FALSE}\ninstall.packages(\"simfinapi\")\n```\n\nIf you want to try out the newest features you may want to give the development version a try and\ninstall it from [GitHub](https://github.com/matthiasgomolka/simfinapi):\n\n```{r install_github, eval=FALSE}\nremotes::install_github(\"https://github.com/matthiasgomolka/simfinapi\")\n```\n\n## Setup\n\nUsing simfinapi is much more convenient if you set your API key and cache directory[^1] globally\nbefore you start downloading data. See `?sfa_set_api_key` and `?sfa_set_cache_dir` for details.\n\n[^1]: simfinapi always caches the results from your API calls to obtain results quicker and to\n    reduce the number of API calls. If you set the cache directory to a permanent directory (the\n    default is `tempdir()`), simfinapi will be able to reuse this cache in subsequent R sessions.\n\n## Code of Conduct\n\nPlease note that the 'simfinapi' project is released with a [Contributor Code of\nConduct](https://github.com/matthiasgomolka/simfinapi/blob/master/.github/CODE_OF_CONDUCT.md). By\ncontributing to this project, you agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthiasgomolka%2Fsimfinapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatthiasgomolka%2Fsimfinapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthiasgomolka%2Fsimfinapi/lists"}