Ready to get started?

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

Download Now

Connect to EDGAR Online Data in Ruby

Connect to EDGAR Online data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData ODBC Driver for EDGAR Online makes it easy to integrate connectivity to live EDGAR Online data in Ruby. This article shows how to create a simple Ruby app that connects to EDGAR Online data, executes a query, and displays the results.

Create an ODBC Connection to EDGAR Online Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

  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.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi gem install dbd-odbc gem install ruby-odbc

Create a Ruby 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:

#connect to the DSN require 'DBI' cnxn = DBI.connect('DBI:ODBC:CData EdgarOnline Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'") #display the names of the columns resultSet.column_names.each do |name| print name, "\t" end puts #display the results while row = resultSet.fetch do (0..resultSet.column_names.size - 1).each do |n| print row[n], "\t" end puts end resultSet.finish #close the connection cnxn.disconnect if cnxn

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

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