Whalewisdom Shell Help
The Shell's primary purpose is to let you test the Whalewisdom API. The command you enter in the Shell will be the same command you set as the "args" parameter when doing an API call directly. The Whalewisdom Shell will also streamlines how you interact with the Whalewisdom database and let you quickly query for the data you're after. Many commands let you output data on screen, to a CSV file, or to a JSON formatted file.
What can I do with this?Just about anything you can do currently in Whalewisdom, just streamlined for efficiency
Do a comparison of Apple stock holders for the 9/30/2010 and 12/31/2010 quarters
and dump it to a CSV file:
stock_comparison --stockid 195 --q1id 39 --q2id 40 --output CSV
Do a holdings comparison of Paulson & Co. between 9/30/2010 and 12/31/2010
and format the results in JSON
holdings_comparison -fid 2182 --q1id 39 --q2id 40 --output JSON
Queue up Backtester reports and have them emailed to you when completed
backtester --filers 2182,349 --q1id 36
Getting StartedThere are a few basic keys that you will need to understand before using the Shell:
identifying quarters, filers, and stocks
- Most commands will require you to enter the id for the quarter (time period) you wish to query against. The quarter id can be found by running the "quarters" command. Type "quarters" in the Shell and you will get a list of all quarters in the system as well as which ones you have access to. For example quarter id 1 is for 3/31/2001 while quarter id 40 is for 12/31/2010.
- Use the "filer_lookup" command to find a 13F filer's id in the system. Provide a partial name or CIK of the filer you want to find and if the filer is in our system it will return the id to you. Enter "help filer_lookup" at the Shell for exact instructions and examples for using this command.
- Use the "stock_lookup" command to find a stock's id in our system. Provide a ticker symbol or partial name and the stock_lookup command will return a list of matching stocks along with their ids. Enter "help stock_lookup" at the Shell for exact instructions and examples for using this command.