API Documentation for Programmers
Wall Street Birds API Home
API is an abbreviation for application programming interface, which is a set of routines, protocols and tools designed to help programmers build software applications.
The Wall Street Birds API makes it possible to develop trading programs by providing all the building blocks. A programmer can put the blocks together to create a custom trading application, which can then be used in a professional setting.
The API can be used for anything from personal trading to advanced high frequency trading. This is possible because the system operates in real-time. Signals are generated only a few milliseconds after the prices are updated at the stock exchange.
Your custom program may be used to place discretionary trades, to trade automatically (automated trading) or your broker may use the program to manage your account on your behalf.
Note that if you are not a programmer, but would like help with building a custom trading application, we may be able to help you.
Access to this API requires a
Pro
API membership. Use of the API is governed by the Wall
Street Birds Pro API license agreement.Methods
The following tables list the public methods exposed by the Wall Street Birds API.
Public
Methods
| Name | Description | |
|---|---|---|
 | SignIn | The SignIn method must be called prior to any other method. |
|
| FindSymbols | Finds and returns a list of symbols that match a partial or full symbol or company name. |
|
| GetWSBData | Returns a list of EmotionPoint data points based on the supplied arguments. |
|
| GetSignal | Returns a single Wall Street Birds stock signal in the form of a SignalValue object. |
|
| GetDJIASignal | The GetDJIASignal method returns a single Wall Street Birds stock signal for the Dow Jones Industrial Average. |
|
| GetAllSignals | Returns all Wall Street Bird signals (approximately 15,000) in the form of of Dictionary<SignalKey, int>. |
|
| SetUserSymbols | SetUserSymbols sets the list of symbols that are displayed on the website for a particular user. |
|
| GetUserSymbols | Returns a list of symbols that are displayed on the website for a particular user. |
|
| GetSymbolRankings | Returns all emotion rankings for the symbols in the S&P 500 index in the form of List<WSBRank>. |
|
| GetEmotionEvents | Returns all Wall Street Bird emotion events in the form of List<WSBEmotionEvent>. |
|
| GetCriticalEvents | Returns all Wall Street Bird critical events in the form of List<DateTime>. |
|
| GetTimeStamp | The GetTimestamp method returns the current server timestamp. |
Classes
The following tables list the public classes exposed by the Wall Street Birds API.
Public
| Name | Description | |
|---|---|---|
 | EmotionPoint | EmotionPoint objects contain all Wall Street Birds index values for a specific point in time. |
|
| Fundamental | The Wall Street Birds API provides fundamental data via the FindSymbols method. |
|
| SignalValue | SignalValue is used as the return type for the GetSignal method, which is used to return a Wall Street Birds signal for a specific stock symbol. |
|
| SignalKey | SignalKey is used as a Dictionary key by the GetAllSignals method, to return a list of signals for all stocks. |
|
| WSBEmotionEvent | Contains a time stamp and Emotion point data. This class is the return value for GetEmotionEvents. |
|
| WSBRank | Contains the Wall Street Birds rank, mood and emotion values for a specific stock. This class is the return value for GetSymbolRankings. |
Enumerations
The following tables list the public enumerations exposed by the Wall Street Birds API.
Public
Enumerations
| Name | Description | |
|---|---|---|
 | SignalType | SignalType is used by the GetSignal and GetDJIASignal methods to return a signal for a specific symbol or for the Dow Jones Industrial Average. |
|
| Periodicity | The periodicity enumeration is used mainly by the GetWSBData method to return data based on a specific time frequency. |
