Ready to get started?

Learn more about the CData Python Connector for EDGAR Online or download a free trial:

Download Now

Use Dash to Build to Web Apps on EDGAR Online Data

The CData Python Connector for EDGAR Online enables you to create Python applications that use pandas and Dash to build EDGAR Online-connected web apps.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for EDGAR Online, the pandas module, and the Dash framework, you can build EDGAR Online-connected web applications for EDGAR Online data. This article shows how to connect to EDGAR Online with the CData Connector and use pandas and Dash to build a simple web app for visualizing EDGAR Online data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live EDGAR Online data in Python. When you issue complex SQL queries from 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).

Connecting to EDGAR Online Data

Connecting to EDGAR Online data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

  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.

After installing the CData EDGAR Online Connector, follow the procedure below to install the other required modules and start accessing EDGAR Online through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install pandas
pip install dash
pip install dash-daq

Visualize EDGAR Online Data in Python

Once the required modules and frameworks are installed, we are ready to build our web app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.edgaronline as mod
import plotly.graph_objs as go

You can now connect with a connection string. Use the connect function for the CData EDGAR Online Connector to create a connection for working with EDGAR Online data.

cnxn = mod.connect("AppKey=20dd8ce9904d422ed89ebde1ad40d")

Execute SQL to EDGAR Online

Use the read_sql function from pandas to execute any SQL statement and store the result set in a DataFrame.

df = pd.read_sql("SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'", cnxn)

Configure the Web App

With the query results stored in a DataFrame, we can begin configuring the web app, assigning a name, stylesheet, and title.

app_name = 'dash-edgaronlineedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Configure the Layout

The next step is to create a bar graph based on our EDGAR Online data and configure the app layout.

trace = go.Bar(x=df.Id, y=df.Name, name='Id')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='EDGAR Online Subscriptions Data', barmode='stack')
		})
], className="container")

Set the App to Run

With the connection, app, and layout configured, we are ready to run the app. The last lines of Python code follow.

if __name__ == '__main__':
    app.run_server(debug=True)

Now, use Python to run the web app and a browser to view the EDGAR Online data.

python edgaronline-dash.py

Free Trial & More Information

Download a free, 30-day trial of the EDGAR Online Python Connector to start building Python apps with connectivity to EDGAR Online data. Reach out to our Support Team if you have any questions.



Full Source Code

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.edgaronline as mod
import plotly.graph_objs as go

cnxn = mod.connect("AppKey=20dd8ce9904d422ed89ebde1ad40d")

df = pd.read_sql("SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'", cnxn)
app_name = 'dash-edgaronlinedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.Id, y=df.Name, name='Id')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='EDGAR Online Subscriptions Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)