|
Overview of Recognia API
"Programmer’s Corner" provides an introduction to
Recognia's Application Programming Interface (API). Recognia clients
are provided with detailed documentation on how to use the API.
Using the Recognia API, clients can access Recognia chart patterns
and information. The API allows for customization of the query options
and the format for presenting chart patterns to end users, to meet
their unique requirements.
Recognia's database of chart patterns can be accessed using a sophisticated
web-based API. Recognia's content is delivered from a web server,.
Using the API consists of forming HTTP "GET"s or "POST"s
to retrieve information. The API returns information in XML format.
Alternatively an XSLT style-sheet can be specified in the API call
to transform the XML into another data format. This way the data
can be returned to the caller in whatever format is most convenient,
such as HTML, text, etc.
The formation of a Recognia API call is the construction of a URL.
Recognia API calls have the form:
[server]/[command]?[parameters][authentication]
The following example is one which executes the fictional "query"
command.
https://api.recognia.com/query?crt=exc:any:NYSE:NASDAQ,tty:eq:L,cls:le:40
&srt=vol:desc&uid=bob&cid=10&pwd=1234
This example can be broken up as follows:
[server] = https://api.recognia.com/
[command] = query
[parameters] = crt=exc:any:NYSE:NASDAQ,tty:eq:L,cls:le:40&srt=vol:desc
[authentication] = uid=example&cid=10&pwd=1234
The server is the address
of the Recognia API. The command
is the Recognia API command that you wish to use. The API commands
are discussed in more detail in the following sections. The parameters
are specific to the API call. Parameters are separated by an ampersand
(&). The authentication
can be one of two types: Client ID, User ID, User Password triplet
as used in this example, or a Transaction ID. Both consist of authentication
parameters separated from the command parameters using the ampersand
(&).
The authentication and parameters can appear in any order and can
be intermingled, however the Recognia convention is to group the
authentication information together as the last element of the API
call URL.
Following is a more detailed look at this fictional API call.
https://api.recognia.com/
is the fictional URL for the server.query is the
fictional command to be executed in order to retrieve a list of
chart patterns that match the specified criteria.- The parameters being passed for the query command are:
crt=exc:any:NYSE:NASDAQ,tty:eq:L,cls:le:40&srt=vol:desc
where
crt
is the abbreviation that signifies that a criteria string
for the query is being passed. - The criteria requested are: Any chart pattern that indicates
a Long (rising price) trading opportunity for an instrument
on either the NYSE or NASDAQ exchange which has a closing
price below $40.00.
srt=vol:desc
where
srt
is the abbreviation that signifies that sort criteria
for the query is being passed.- The sort string indicates that the records should be
sorted by trading volume in descending order, with the
most highly traded stocks listed first.
|
