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 DBeaver

Manage EDGAR Online data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for EDGAR Online implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to EDGAR Online data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for EDGAR Online Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.edgaronline.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the EdgarOnlineDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.edgaronline.EdgarOnlineDriver.
  6. Add jdbc:edgaronline: in the URL Template field.

Create a Connection to EDGAR Online Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to 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 connection string:

    jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d

Query EDGAR Online Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.