Ready to get started?

Learn more about the EDGAR Online PowerShell Cmdlets or download a free trial:

Download Now

PowerShell Scripting to Replicate EDGAR Online Data to MySQL

Write a simple PowerShell script to replicate EDGAR Online data to a MySQL database.

The CData Cmdlets for EDGAR Online offer live access to EDGAR Online data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for EDGAR Online and the CData Cmdlets for MySQL in PowerShell to replicate EDGAR Online data to a MySQL database.

After obtaining the needed connection properties, accessing EDGAR Online data in PowerShell and preparing for replication consists of four basic steps.

  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.

Collecting EDGAR Online Data

  1. Install the module:

    Install-Module EdgarOnlineCmdlets
  2. Connect to EDGAR Online:

    $edgaronline = Connect-EdgarOnline -AppKey $AppKey
  3. Retrieve the data from a specific resource:

    $data = Select-EdgarOnline -Connection $edgaronline -Table "Subscriptions"

    You can also use the Invoke-EdgarOnline cmdlet to execute pure SQL-92 statements:

    $data = Invoke-EdgarOnline -Connection $edgaronline -Query 'SELECT * FROM Subscriptions WHERE SubscriberEmail = @SubscriberEmail' -Params @{'@SubscriberEmail'='user@domain.com'}
  4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting EDGAR Online Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the EDGAR Online data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the EDGAR Online resource (Subscriptions) and to exist in the database.

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Subscriptions" -Columns $columns -Values $values }

You have now replicated your EDGAR Online data to a MySQL database. This gives you freedom to work with EDGAR Online data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

  • Once you have connected to EDGAR Online and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-EdgarOnline -Connection $edgaronline -Table "Subscriptions" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Subscriptions" -Columns $columns -Values $values }
  • If you wish to replicate the EDGAR Online data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-EdgarOnline cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}