Ready to get started?

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

Download Now

Connect to EDGAR Online Data in JRuby

Create a simple JRuby app with access to live EDGAR Online data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for EDGAR Online makes it easy to integrate connectivity to live EDGAR Online data in JRuby. This article shows how to create a simple JRuby app that connects to EDGAR Online data, executes a query, and displays the results.

Configure a JDBC Connection to EDGAR Online Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for EDGAR Online\lib).

JRuby natively supports JDBC, so you can easily connect to EDGAR Online and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

  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

Create a JRuby App with Connectivity to EDGAR Online Data

Create a new Ruby file (for example: EdgarOnlineSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for EDGAR Online 2018/lib/cdata.jdbc.edgaronline.jar' url = "jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Name FROM Subscriptions") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your EDGAR Online data with JRuby. To do so, simply run your file from the command line:

jruby -S EdgarOnlineSelect.rb

Writing SQL-92 queries to EDGAR Online allows you to quickly and easily incorporate EDGAR Online data into your own JRuby applications. Download a free trial today!