Load EDGAR Online Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

EDGAR Online JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with EDGAR Online.



Use CData JDBC Driver for EDGAR Online with the open source ETL/ELT tool Embulk to load EDGAR Online data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for EDGAR Online, Embulk easily loads data from EDGAR Online to any supported destination. In this article, we explain how to use the CData JDBC Driver for EDGAR Online in Embulk to load EDGAR Online data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live EDGAR Online data. 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 client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to EDGAR Online Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for EDGAR Online\lib).

Embulk supports JDBC connectivity, so you can easily connect to EDGAR Online and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with EDGAR Online.

  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 typical JDBC connection string for EDGAR Online:

jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d

Load EDGAR Online Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load EDGAR Online data into MySQL using Embulk.

Create a Job to Load EDGAR Online Data

Start by creating a config file in Embulk, using a name like edgaronline-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for EDGAR Online, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.edgaronline.EdgarOnlineDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (edgaronline-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for EDGAR Online 20xx\lib\cdata.jdbc.edgaronline.jar driver_class: cdata.jdbc.edgaronline.EdgarOnlineDriver url: jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d table: "Subscriptions" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Subscriptions" mode: insert

After creating the file, run the Embulk job.

embulk run edgaronline-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered EDGAR Online Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for EDGAR Online 20xx\lib\cdata.jdbc.edgaronline.jar driver_class: cdata.jdbc.edgaronline.EdgarOnlineDriver url: jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d query: "SELECT Id, Name FROM Subscriptions WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Subscriptions" mode: insert

More Information & Free Trial

By using CData JDBC Driver for EDGAR Online as a connector, Embulk can integrate EDGAR Online data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.