events |
 |
recognia/api/events?crt=drn:eq:thisweek,cfm:eq:C,cnr:ge:50,ecl:eq:C,tct:eq:R,exc:eq:US&sta=p_200d_ma:gt:1.2 |
Return a list of events that match a set of criteria.
The date range for the search period is a major factor in the time this
call takes to return. The shorter the date range, the quicker the return.
The sample call will return the 100 most recent Reversal Classic Pattern
events on US equity exchanges from this week where the confirmation type was Close,
the event close price to 200-day moving average ratio was 1.2,
and the Recognia Consensus Rating was at least 50.
Please note that for securities exchanges, Recognia does not currently support querying across multiple countries; attempting
to query based on exchanges in different countries will return an error.
Name |
Type |
Required |
Default |
Description |
crt |
String |
true |
|
The parameter specifies the criteria to use for selecting events to return.
Criteria take the form of: [criteria]:[operator]:[value]. You can specify
multiple criteria by separating them with a comma. Eg. crt=cfm:eq:C,cls:ge:10
operator can be any of the following:
Value |
Description |
lt |
less than |
le |
less than or equal to |
eq |
equal to |
ge |
greater than or equal to |
gt |
greater than |
ne |
not equal to |
any |
any of a list. The list is separated by a colon. Eg. cfm:any:3:C:P |
between |
value must be between two values (inclusive). The two values are separated by a colon. Eg. cls:between:10:20 |
criteria can be any of the following
Value |
Description |
bbs |
The instrument symbol formatted to mimic the style used by Belzberg. All operators supported. |
cfm |
Confirmation Type for the event. :eq:, :any:,
:ne: operators supported
Value |
Description |
P |
Penetration |
3 |
3% Penetration |
C |
Close |
D |
Date |
N |
Not confirmed |
U |
Unknown |
If omitted then the appropriate Confirmation type based on each Event Type
will be used. Confirmation types match up as follows: C,
3, P apply to Classic events
(ecl=C) and represent the difference in pattern formation on the confirmation
day of the event. A C indicates that the close price
crosses the confirmation line of the event, a 3
indicates that the high or low price crossed the confirmation line by 3% or
more and a P indicates that the high or low crossed the
confirmation line by less than 3%. If unspecified then only classic events with
a confirmation type of C will be returned. All Short-term
events (ecl=S) have confirmation type of C. Indicator
events (ecl=I) can have a confirmation type of D,
U or N.
For many Technical Events the Confirmation Type is part of the consensus
rating. For these events a selection of any other confirmation type without a
corresponding override of the default Consensus Rating will result in no events
returned.
|
cls |
Close Price for the instrument on the confirmation date for the event.
:lt:, :le:,
:eq:, :ge:,
:gt:, :between: operators are
supported.
|
cms |
The instrument symbol formatted to mimic the style used by the exchange on which this instrument is traded. All operators supported. |
cnr |
Consensus Rating for the event. Consensus Rating is [-100,100] integer. If
omitted then the API call will return all events with a Consensus Rating
greater than 0. The Consensus Rating is a Recognia generated number that
represents how closely a specific event corresponds to the "industry
consensus" for that event. Factors include such areas as the appearance of
the event and its relationship to the inbound trend. Volume traded for the
instrument on the confirmation date for the event.
:lt:, :le:,
:eq:, :ge:,
:gt:, :between: operators are
supported.
|
drn |
Date Range Name. A string which allows for the selection of pre-defined date
ranges. Valid names are: yesterday, thisweek, lastweek, thismonth, lastmonth,
thisyear, lastyear, Xday, Xmonth, Xyear (X being a number). :eq: operator supported.
|
ead |
Event Active Date. Each event is active for a period of time after it is found.
Return only events that were active on the given date. :eq:
operator supported.
In addition, :eq:current is a short-form
for the current date, :eq:any returns both active and inactive
events, and :ne:current returns only events not currently
active.
|
ecl |
Event Class. A single character indicating the class of events to return.
:eq:, :ne:,
:any: operators supported. Possible values are
Value |
Description |
C |
Classic Patterns |
S |
Short-term Patterns |
I |
Indicators |
O |
Oscillators |
|
edr |
An integer number which is the number of price periods (usually trading days)
of the event spans. :lt:, :le:,
:eq:, :ge:,
:gt:, :between: operators are supported.
|
eid |
Event Id. Each event has a unique, case-sensitive, string id. If you specify this criteria
then all other criteria are ignored. :eq: and
:any: operators supported.
|
eti |
Event Type Id. An integer value that indicates the type of event. See
Event Types for a list of the currently
supported event types.
:lt:, :le:,
:eq:, :ge:,
:gt:, :ne:,
:between:, :any: operators are
supported.
|
exc |
Exchange Symbol. A string representing the exchange to search against. See
Exchanges for a list of the currently
supported exchanges. :eq:, :ne:,
:any: operators supported. Please note that for securities exchanges, Recognia does not currently support querying across multiple countries; attempting
to query based on exchanges in different countries will return an error.
|
iid |
The Instrument ID is a unique string that identifies the instrument. This can be used to request a specific instrument instead of passing a symbol and exchange combination in the call. :eq: operator supported. |
ist |
The issue type of the instrument.
:eq:, :ne:,
:any: operators supported. For Exchange-Traded Funds, specify ETF. Otherwise exclude this criterion from your query in order to return instruments of any issue type (common, preferred, ETFs, etc.).
|
ity |
Instrument Type. A character representing the type of financial instrument to
be selected. Possible values are S for Security,
I for Index, C for
Currency, and M for Futures. If you do not specify this criteria it defaults to S. :eq:
operator supported.
|
ixs |
The instrument symbol formatted to mimic the ILX style used by Thomson Financial. All operators supported. |
ooa |
On or After. Confirmation date for the event must have occurred on or after the
date specified. The date must be of the format YYYY-MM-DD
(for example 2002-09-07). :eq: operator supported.
|
oob |
On or Before. Confirmation date for the event must have occurred on or before the
date specified. The date must be of the format YYYY-MM-DD
(for example 2002-09-07). :eq: operator supported.
|
opt |
Options Available. Whether options are available for the instrument. :eq: operator supported. e.g. opt:eq:T or opt:eq:F
|
pds |
The instrument symbol formatted to mimic the style used by SunGard PowerData. All operators supported. |
per |
Price Period. A character representing the price period for the event.
Currently supported price periods are: [D]aily. If this criteria is not
specified it defaults to D. :eq: operator supported.
|
pmv |
Possible Percentage Price Move for the event. Percentage is expressed as a
decimal, i.e. 15% is 0.15.
:lt:, :le:,
:eq:, :ge:,
:gt:, :between: operators are
supported.
|
rts |
The instrument symbol formatted to mimic the style used by Reuters. All operators supported. |
sic |
Sector-Industry Code. An eight digit number that represents the industry code for the
instrument. The API will accept wildcard values in order to access a higher level
sector grouping: ? to match a single digit; * to match any number of digits. The
first digit is the super-sector; the first three digits are the sector; the first 5
digits are an industry group; all 8 digits are the industry. For example, sic:eq:101*
or sic:eq:101????? will return instruments designated as industry 10100000 through
10199999. :eq:, :any:,
:ne: operators supported.
|
sym |
Symmetry Rating. A Recognia Proprietary characteristic that measures the
symmetry of Classic technical events. The Symmetry Rating is an integer from 0
to 100 that rates the overall symmetry of each pattern that forms a technical
event. The higher the number the more symmetrical the pattern.
:lt:, :le:,
:eq:, :ge:,
:gt:, and :between: operators
supported.
|
tct |
Trend Change Type. A character that represents the change in the existing trend.
Valid Trend change type codes are: R for Reversal,
C for Continuation,
E for End, and
U for Undefined. Reversal changes indicated that the
existing trend will reverse to the opposite trend, so a downtrend will change
to an uptrend. Continuation indicates that the existing trend will continue.
End indicates that the existing trend will end such that it may reverse or the
price may move sideways (no trend) for a period of time. Undefined indicates
that this technical event does not indicate any change to the existing trend.
:eq:, :any:,
:ne: operators supported.
|
tdr |
Trend Duration. An integer number which is the number of price periods (usually trading days)
of the Inbound Trend.
:lt:, :le:,
:eq:, :ge:,
:gt:, :between: operators are
supported.
|
thz |
Trading horizon. A character that represents the length of the trade supported
by the event.
Valid trading horizon codes are: S for short-term (2 - 6 weeks),
I for intermediate-term (6 - 39 weeks), and
L for long-term (9 months - 2 years+).
:eq:, :any:,
:ne: operators supported.
|
tty |
Trade Type. The direction of the expected move for an event. TTY will be
L, S, or U
representing Long, Short or Undefined. Long events are those where the
price is expected to rise and Short events are those where the price is expected
to fall. Undefined events do not indicate the possible price move.
:eq:, :ne:, :any:
operators are supported. |
vol |
Volume traded for the instrument on the confirmation date for the event.
:lt:, :le:,
:eq:, :ge:,
:gt:, :between: operators are
supported.
|
vol10 |
10 period average volume traded for the instrument on the confirmation date for the event.
:lt:, :le:,
:eq:, :ge:,
:gt:, :between: operators are
supported.
|
The following is an example of the criteria portion of an events call:
crt=ecl:eq:I,ooa:eq:2002-09-01,tty:eq:L,cfm:any:D:U
This will find all Indicator events that ended on or after September 1st,
2002 with a Trade Type of Long and with a Confirmation Type of Date or
Unknown.
|
lang |
String |
false |
en |
Specify the language of the events returned. Possible language codes are: 'en' (English) and
'fr' (French). |
qty |
Integer |
false |
100 |
Specify the maximum number of matching events to return. |
sch |
String |
false |
standard |
The schema for the information in the event block. The following schemas are supported:
Value |
Description |
summary |
Basic event information. |
standard |
Basic event information plus full pricing and event symmetry. |
fundamental |
Basic event information plus instrument fundamentals. |
|
srt |
String |
false |
|
Specify the sort order for the events returned. Possible sort fields are: cfm,
cls, cnr, ecl, edr, eid, end, eti, exc, cms, rts, pds, ixs, ity, per, pmv, str, sym, tct, tdr,
tty, vol, vol10. str is the Start Date for the event. Sort
order is specified by appending a :desc to the sort field dor a descending
sort and :asc for an ascending sort. Sorting is ascending by default. Multiple
sort criteria can be specified by separating them with a comma. Eg.
srt=end:desc,vol:desc
|
sta |
String |
false |
|
The parameter specifies the criteria to use for selecting events to return.
Criteria take the form of: [state]:[operator]:[value]. You can only specify
one criterion. Eg. sta=p_21w_ma:lt:1.08
operator can be any of the following:
Value |
Description |
lt |
less than |
le |
less than or equal to |
eq |
equal to |
ge |
greater than or equal to |
gt |
greater than |
ne |
not equal to |
any |
any of a list. The list is separated by a colon. Eg. p_200d_ma:any:3:4:5 |
between |
value must be between two values (inclusive). The two values are separated by a colon. Eg. p_200d_ma:between:1.0:2.0 |
state can be any of the following
Value |
Description |
p_200d_ma |
Close price to 200-day moving average ratio. |
p_50d_ma |
Close price to 50-day moving average ratio. |
p_21d_ma |
Close price to 21-day moving average ratio. |
p_200w_ma |
Close price to 200-week moving average ratio. |
p_50w_ma |
Close price to 50-week moving average ratio. |
p_21w_ma |
Close price to 21-week moving average ratio. |
p_200m_ma |
Close price to 200-month moving average ratio. |
p_50m_ma |
Close price to 50-month moving average ratio. |
p_21d_ma |
Close price to 21-month moving average ratio. |
|
<list count="" type="event"> tag if no errors. Count contains the
number of child <event>
nodes. This list will be empty (and count=0) if the criteria was properly
specified but no matching events were found.
<status> tag if there were errors. Contents can be
Value |
Description |
failed |
if the user could not be authenticated |
failed |
if incorrect parameters were specified |
failed |
if there was an internal Recognia error. Recognia is notified immediately in this instance |
If failed is returned, check the <errors> tag
in the <header>
block for the reason.
|