Ready to get started?

Learn more about the CData JDBC Driver for EDGAR Online or download a free trial:

Download Now

Analyze EDGAR Online Data in R

Use standard R functions and the development environment of your choice to analyze EDGAR Online data with the CData JDBC Driver for EDGAR Online.

Access EDGAR Online data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for EDGAR Online and the RJDBC package to work with remote EDGAR Online data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to EDGAR Online and visualize EDGAR Online data by calling standard R functions.

Install R

You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.

Load the RJDBC Package

To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:

library(RJDBC)

Connect to EDGAR Online as a JDBC Data Source

You will need the following information to connect to EDGAR Online as a JDBC data source:

  • Driver Class: Set this to cdata.jdbc.edgaronline.EdgarOnlineDriver
  • Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.

The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for EDGAR Online:

driver <- JDBC(driverClass = "cdata.jdbc.edgaronline.EdgarOnlineDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.edgaronline.jar", identifier.quote = "'")

You can now use DBI functions to connect to EDGAR Online and execute SQL queries. Initialize the JDBC connection with the dbConnect function.

  1. Navigate to https://developer.edgar-online.com/ and create an account.
  2. Register a new application and retrieve the AppKey. You should select one of the available Web APIs this application will use like HackPack, Insider Trades or Institutional Ownership.
    Note: HackPack is the most important Web API that an application can use since it supports a large number of endpoints. If you are getting the "Access Denied" error you must create a new app and select the correct Web API which supports the resource you are querying.
  3. After successfully creating a new app, you can access your keys through your "my account" area. Set the AppKey connection property value equal to the Key of your application.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the EDGAR Online JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.edgaronline.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample dbConnect call, including a typical JDBC connection string:

conn <- dbConnect(driver,"jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d")

Schema Discovery

The driver models EDGAR Online APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

dbListTables(conn)

Execute SQL Queries

You can use the dbGetQuery function to execute any SQL query supported by the EDGAR Online API:

subscriptions <- dbGetQuery(conn,"SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'")

You can view the results in a data viewer window with the following command:

View(subscriptions)

Plot EDGAR Online Data

You can now analyze EDGAR Online data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(subscriptions$Name, main="EDGAR Online Subscriptions", names.arg = subscriptions$Id, horiz=TRUE)