Ready to get started?

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

Download Now

Natively Connect to EDGAR Online Data in PHP

The CData ODBC driver for EDGAR Online enables you to create PHP applications with connectivity to EDGAR Online data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for EDGAR Online into your LAMP or WAMP stack to build EDGAR Online-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to EDGAR Online data, execute queries, and output the results.

Configure a DSN

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.

Establish a Connection

Open the connection to EDGAR Online by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC EdgarOnline Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC EdgarOnline Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Subscriptions WHERE SubscriberEmail = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC EdgarOnline Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Subscriptions WHERE SubscriberEmail = ?"); $success = odbc_execute($query, array('user@domain.com'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC EdgarOnline Source","user","password"); $query = odbc_exec($conn, "SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC EDGAR Online data Source","user","password"); $query = odbc_exec($conn, "SELECT Id, Name FROM Subscriptions WHERE SubscriberEmail = 'user@domain.com'"); while($row = odbc_fetch_array($query)){ echo $row["Id"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC EDGAR Online data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Subscriptions WHERE SubscriberEmail = ?"); $success = odbc_execute($query, array('user@domain.com')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are EDGAR Online-specific adaptations of the PHP community documentation for all ODBC functions.