Technical Analysis Library - Category Guideline

Home

Documentation
Download
Developers
Other Links

API
Function Index
TADOC

Forum
SourceForge

Category Guideline

1.0 Introduction

2.0 Securities Type

3.0 Categories lookup by examples

4.0 List of Suggested Category

5.0 Country abbreviation

horizontal rule

1.0 Introduction

Most of the data sources are using their own scheme to classify the securities. To make your application code unaffected by the particularities of one data source or another, the TA-LIB organization is attempting to define an easy classification method.

If the guideline are well followed, someone may change from one data source to another without having to make changes to their software for accessing the same data.

It would be interesting to switch to an unambiguous centralized classification, like the CUSIP numbers. Sadly, this kind of database are copyrighted and fee based.

For TA-LIB, the classification of the securities is done by two strings: the Category and the Symbol.

The Symbol string is the "friendly" ticker symbol largely used in newspaper and web sites. Like MSFT for Microsoft etc... as you may already know, using only the Symbol is not sufficient, so an additional Category string attempts to unambiguously identify a group of securities where it is sure that the Symbol is unique. There is up to 3 components forming a Category: The country of the exchange, the exchange and the type of securities.

Examples: US.NASDAQ.FUND, CA.TSE.STOCK

For the purpose of lookup and simplicity, it is not always necessary to specify the 3 components of the Category. Any component can be replaced by a wildcards "*" or being left unspecified. Their order is always the same though.

Example: "US.*.STOCK" can be used if you do not know to which exchange the symbol IBM belongs to. Of course, you are open to ambiguous results if the symbol IBM is listed in many exchanges. These wildcards are mainly useful for lookup functions, allowing you afterward to narrow down to the specific security you wish to access. Using wildcards with functions expecting a specific security (like TA_HistoryAlloc to get the historical data), will return some data, but may be not of the right expected country, exchange or security type.

Side Note: Some people may be surprise to learn that some symbols are not listed only in one country! Example: Nortel Networks is listed both in the TSE (Toronto Stock Exchange) and the NYSE (New York Stock Exchange). So beware of vague category like "*.*.STOCK"

You may want to follow as well the Symbol Guideline.

Anyone can freely re-use this guideline without any obligation towards TA-LIB.ORG

horizontal rule

2.0 Securities Type

The third component of the category allows to classify the security by type.

Identifier

Comments

STOCK

Stock, Company Equities

FUTURE

Commodities / Derivative Contracts

FUND

Mutual Funds

OPTION

Options on stocks, futures and indices.

BOND

Government, Municipal and Corporation bonds.

INDEX

Exchange and composite indices.

OTHER

Unknown type or user defined data.

Like the rest of the category, this identifier is case insensitive.

horizontal rule

3.0 Categories lookup by examples

Here is a list of examples of category:

"US.NYSE"

All securities/index provided by the New York Stock Exchange. Equivalent to "US.NYSE.*"

"*.NYSE"

Since NYSE is currently unique in the world, this is the equivalent of US.NYSE. Not recommended. Note: "NYSE" alone would not be valid since the first portion of the category designate the country.

"*.NYSE.STOCK"

Only among the stock of the NYSE.

"US.NYSE.STOCK"

Unambiguous category.

"US"

All securities in the United States. Equivalent to "US.*" or "US.*.*"
Not recommended.

"DE.*.INDEX"

All indices from Germany exchanges.

"*.*.INDEX"

All indices in the database.

"CA.*.FUND"

All Canadian mutual funds.

 

horizontal rule

4.0 List of Suggested Category

TA-Lib.org is maintaining a list of suggested category. This data is maintained in HTML and Excel format. Hyperlinks to the exchange's web sites are also included.

Feel free to integrate this information into your own software even if you are not using TA-Lib.

Contact support@ta-lib.org for addition or modification to the list.


 

horizontal rule

5.0 Country abbreviation

Countries are uniquely identified using two alphabetic letter. Example:

    US  ==>    United States
    CA  ==>    Canada
    FR  ==>    France
    DE  ==>    Germany
    UK  ==>   
United Kingdom

TA-Lib.org has obtain permission by ISO to base its guideline part on the ISO3166-1 alpha-2 standard. TA-Lib.org does not determine which country should or should not be on that list.

For more info see the ISO 3166 Maintenance Agency

Within TA-Lib, a particular exception to the standard is that "UK" is used instead of "GB" to designate United Kingdom.
 

Google  SourceForge Logo
  Web TA-Lib.org
 
 

Copyright© 2005 TicTacTec LLC. All Rights Reserved. Last Update: 06/22/05, Unique Visitor: