In schardtbc/intrinoR: Intrino Market Data Api Wrapper

knitr::opts_chunk$set(echo = TRUE)

intrinoR

An R language wrapper for the INTRINO market data Api.

You will need an account and api keys, signup for a free starter account.

Installation

To install as a dependancy into your project at the R REPL command prompt

install.github("schardtbc/intrinoR")

then in your .env or .Renviron file add the following keys

INTRINO_BASE_URL = "https://api-v2.intrinio.com"
INTRINO_PRODUCTION_KEY  = "your production key here"
INTRINO_SANDBOX_KEY = " your sandbox key here"
INTRINO_API_VERSION = "v2"

# use production and snadbox keys from your intrino account
# make sure the .env file is in your .gitignore file
# do not hard code the keys into your application code
# do not upload the keys to github.
# you can easily change the keys at intrino.com if they become compromised

Api documentation documentation.

Usage Example

library(intrinoR)
useSandbox()
# useProduction()

res <- getSecurityStockPrices("AAPL", opts = list(start_date = "2019-01-01"))
res

Companies

| | Endpoint | function call | |-----|:----------------------------------------------|:-------------------------------------------------------------------| | [X] | /companies | getAllCompanies | | [ ] | /companies/search | | | [X] | /companies/{identifier} | getCompany | | [X] | /companies/{identifier}/securties | getCompanySecurities | | [X] | /companies/{identifier}/news | getCompanyNews | | [X] | /company/{identifier}/fundamentals | getCompanyFundamentals | | [X] | /company/{identifier/filings} | getCompanyFilings | | [X] | /company/{identifier}/data_point/{tag}/number | getCompanyDataPointNumber | | [X] | /company/{identifier}/data_point/{tag}/text | getCompanyDataPointText | | [X] | /company/{identifier}/historical_data/{tag} | getCompanyDataPointHistory |

Securities

| | Endpoint | function call | |-----|:----------------------------------------------|:-------------------------------------------------------------------| | [X] | /securities | getAllSecurities | | [X] | /securities/{identifier} | getSecurityById | | [X] | /securities/{identifier}/prices | getSecurityStockPrices | | [X] | /securities/{identifier}/prices/realtime | getSecurityRealtimePrice | | [X] | /securities/{identifier}/prices/intraday | getSecurityIntradayPrices | | [X] | /securities/{identifier}/dividends/latest | getSecurityDividendsLatest | | [X] | /securities/{identifier}/earnings/latest | getSecurityEarningsLatest | | [X] | /securities/{identifier}/zacks/analyst_ratings/snapshot | getSecurityZacksAnalystRatingsSnapshot | | [X] | /securities/{identifier}/data_point/{tag}/number | getSecurityDataPointNumber | | [X] | /securities/{identifier}/data_point/{tag}/text | getSecurityDataPointText | | [X] | /securities/{identifier}/historical_data/{tag} | getSecurityDataPointHistory |

Fundamentals

| | Endpoint | function call | |-----|:----------------------------------------------|:-------------------------------------------------------------------| | [X] | /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | lookupFundamental | | [X] | /fundamentals/{id} | getFundamentalById | | [X] | /fundamentals/{id}/standardized_financials | getStandardizedFinancials | | [X] | /fundamentals/{id}/standardized_financials | getStandardizedFinancialsTable | | [X] | /fundamentals/{id}/reported_financials | getReportedFinancials | | [X] | /fundamentals/{id}/reported_financials | getReportedFinancialsTable |

Indices

| | Endpoint | function call | |-----|:-----------------------------------------------------|:--------------------------------------------------------------| | [X] | /indices/stock_market | getAllStockMarketIndicies | | [X] | /indices/economic | getAllEconomicIndicies | | [X] | /indices/sic | getAllSicIndicies | | [X] | /indices/{type}/{identifier}/data_point/{tag}/number | getIndicesDataPointNumber | | [X] | /indices/{type}/{identifier}/data_point/{tag}/text | getIndicesDataPointText | | [X] | /indices/{type}/{identifier}/historical_data/{tag} | getIndicesDataPointHistory |