Ready to get started?

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

Download Now

Work with EDGAR Online Data in Apache Spark Using SQL

Access and process EDGAR Online Data in Apache Spark using the CData JDBC Driver.

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for EDGAR Online, Spark can work with live EDGAR Online data. This article describes how to connect to and query EDGAR Online data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live EDGAR Online data due to optimized data processing built into the driver. When you issue complex SQL queries to EDGAR Online, the driver pushes supported SQL operations, like filters and aggregations, directly to EDGAR Online and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can work with and analyze EDGAR Online data using native data types.

Install the CData JDBC Driver for EDGAR Online

Download the CData JDBC Driver for EDGAR Online installer, unzip the package, and run the JAR file to install the driver.

Start a Spark Shell and Connect to EDGAR Online Data

  1. Open a terminal and start the Spark shell with the CData JDBC Driver for EDGAR Online JAR file as the jars parameter: $ spark-shell --jars /CData/CData JDBC Driver for EDGAR Online/lib/cdata.jdbc.edgaronline.jar
  2. With the shell running, you can connect to EDGAR Online with a JDBC URL and use the SQL Context load() function to read a table.
    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.

    Configure the connection to EDGAR Online, using the connection string generated above.

    scala> val edgaronline_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d").option("dbtable","Subscriptions").option("driver","cdata.jdbc.edgaronline.EdgarOnlineDriver").load()
  3. Once you connect and the data is loaded you will see the table schema displayed.
  4. Register the EDGAR Online data as a temporary table:

    scala> edgaronline_df.registerTable("subscriptions")
  5. Perform custom SQL queries against the Data using commands like the one below:

    scala> edgaronline_df.sqlContext.sql("SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = user@domain.com").collect.foreach(println)

    You will see the results displayed in the console, similar to the following:

Using the CData JDBC Driver for EDGAR Online in Apache Spark, you are able to perform fast and complex analytics on EDGAR Online data, combining the power and utility of Spark with your data. Download a free, 30 day trial of any of the 190+ CData JDBC Drivers and get started today.