Ready to get started?

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

Download Now

Query EDGAR Online Data in ColdFusion

Write standard ColdFusion data access code to connect to EDGAR Online data.

The CData JDBC Driver for EDGAR Online seamlessly integrates connectivity to EDGAR Online data with the rapid development tools in ColdFusion. This article shows how to connect to EDGAR Online data in ColdFusion and query EDGAR Online tables.

Create a JDBC Data Source for EDGAR Online in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:edgaronline: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      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.

      A typical JDBC URL is below:

      jdbc:edgaronline:AppKey=20dd8ce9904d422ed89ebde1ad40d
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.edgaronline.EdgarOnlineDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData EDGAR Online data source in the Actions column. After reporting a status of OK, the EDGAR Online data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to EDGAR Online, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="EdgarOnlineQuery" dataSource="CDataEdgarOnline"> SELECT * FROM Subscriptions WHERE SubscriberEmail = <cfqueryparam value="#SubscriberEmail#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#EdgarOnlineQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Subscriptions WHERE SubscriberEmail = ?", 
  [
    { value="user@domain.com", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataEdgarOnline" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?SubscriberEmail=user@domain.com