Ready to get started?

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

Download Now

Using the CData ODBC Driver for EDGAR Online in PyCharm

Connect to EDGAR Online as an ODBC data source in PyCharm using the CData ODBC Driver for EDGAR Online.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for EDGAR Online from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for EDGAR Online as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to EDGAR Online

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

  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.

Below is the syntax for a DSN:

[CData EdgarOnline Source] Driver = CData ODBC Driver for EDGAR Online Description = My Description AppKey = 20dd8ce9904d422ed89ebde1ad40d

Execute SQL to EDGAR Online

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for EdgarOnline};AppKey = 20dd8ce9904d422ed89ebde1ad40d') cursor = cnxn.cursor() cursor.execute("SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Name)

After connecting to EDGAR Online in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to EDGAR Online data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.