Ready to get started?

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

Download Now

Pipe EDGAR Online Data to CSV in PowerShell

Use standard PowerShell cmdlets to access EDGAR Online tables.

The CData Cmdlets Module for EDGAR Online is a standard PowerShell module offering straightforward integration with EDGAR Online. Below, you will find examples of using our EdgarOnline Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your EDGAR Online Data

  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.

$conn = Connect-EdgarOnline  -AppKey "$AppKey"

Selecting Data

Follow the steps below to retrieve data from the Subscriptions table and pipe the result into to a CSV file:

Select-EdgarOnline -Connection $conn -Table Subscriptions | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySubscriptionsData.csv -NoTypeInformation

You will notice that we piped the results from Select-EdgarOnline into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-EdgarOnline -Connection $conn -Table Subscriptions -Where "SubscriberEmail = user@domain.com" | Remove-EdgarOnline

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into EDGAR Online, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MySubscriptionsUpdates.csv | %{
  $record = Select-EdgarOnline -Connection $EdgarOnline -Table Subscriptions -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-EdgarOnline -Connection $edgaronline -Table Subscriptions -Columns ("Id","Name") -Values ($_.Id, $_.Name) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-EdgarOnline -Connection $edgaronline -Table Subscriptions -Columns ("Id","Name") -Values ($_.Id, $_.Name)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!