Spark API
The Spark API enables you to receive raw market data events in your own trading software through a Spark data feed.
It is faster, provides more data, and is easier to program against than Spark's DDE interface. It is a separate product from Spark and does not require Spark to be installed or running.
You receive every event on each exchange in practical bandwidth, and can access every event on a per stock basis for the full preceeding month.
Historical prices and announcements are included, and basic fundamental information.
The Windows version is available for both 32 bit and 64 bit Windows and contains an unmanaged windows DLL with a C header file and link libraries.
The MacOS X version is a framework for OSX 10.6 and later, 64 bit only.
The Linux version is for both 32 bit and 64 bit Linux and contains a dynamic link library with a C header file.
A .Net wrapper is also included for all platforms that enables you to call the Spark API from any .Net language. The wrapper provides a more conventional .Net naming scheme and uses iterators in place of the apply-to-all functions.
A C example is provided that illustrates all API calls. A smaller C# example is also provided.
Windows Download
SparkAPI_1.2.4.zip for Windows 7, Vista and XP, 32 bit and 64 bit,
Refer to README.txt in the zip.
MacOS X Download
SparkAPI_1.2.4.dmg for OSX 10.6 or later, 64 bit only.
Open the dmg and drag Spark.framework to your /Frameworks folder.
Include <Spark/spark.h> and link with -framework Spark.
Refer to README.txt in the Documentation folder of the framework.
Linux Download
SparkAPI_1.2.4.tar.gz for 32 bit and 64 bit Linux
Refer to README.txt in the .tar.gz.
Basic API Usage
Login and list all trades for a stock using CSharp:
static void Main(string[] args)
{
Spark.Stock stock = new Spark.Stock();
Spark.Init();
Spark.SetLogin("username", "password");
Spark.Connect();
foreach (Spark.Trade trade in Spark.Trades("BHP", "ASX"))
{
System.Console.WriteLine("{0:s} {1,7} {2,9}",
Spark.TimeToDateTime(trade.Time),
trade.Price,
trade.Volume);
}
Spark.Disconnect();
Spark.Exit();
}
Programming Notes
The API is thread safe, although you should wait until you are connected before launching threads otherwise their queries will return NOT_FOUND errors.
It maintains a market picture that may be queried for quotes and depth, but the basic data structures are intended to transfer information between Spark and your software as quickly and simply as possible. For this reason, the structures contain easilly marshalled data, rather than easilly queried data. e.g. strings are fixed length Ansi and times are 32 bit unix timestamps.
It is not intended that the API impose any design restrictions on your application. You could embed the structures in your own more complex structures and classes (or copy values to them) and then use the event functions to maintain your own market picture.
The network protocol runs in a separate thread and each API function locks that thread for a short time to copy out the data - on the order of microseconds.
Building depth queues is the longest operation - a request for all BHP depth levels with depth detail can take a millisecond. Any advanced applications should build their own depth queues from the stock's event stream to avoid having to copy the entire queue.
If you know the maximum levels of depth you require, then always supply it to the depth functions for speed. Copying only 10 levels of depth, say, is fast.
Money data is stored in fixed point integer or long types for accuracy. i.e. stock prices are stored in 100ths of a cent. To obtain the price in dollars, divide by 10000.
Documentation
This is preliminary documentation only.
Documention for the .Net API follows. Refer to spark.h for documentation of the C API and further explanation.
The Spark .Net API is encapsulated in a static class called Spark. i.e. you do not instantiate it, you just refer to the members as Spark.SPARK_EVENT_TRADE, Spark.GetStock(), and Spark.Stock, for example.
The following are the publicly defined structures, constants and methods:
Quick Links
Download
C API
spark.h.Net API
Initialization Stocks Indices Issuers Exchanges SupportFixed Point Multipliers
| const int | PRICE_MULTIPLIER | 10000 | comment |
| const long | VALUE_MULTIPLIER | 100 | comment |
| const int | INDEX_MULTIPLIER | 100 | comment |
| const int | EPS_MULTIPLIER | 100 | comment |
| const int | DPS_MULTIPLIER | 100 | comment |
| const int | NTA_MULTIPLIER | 1 | comment |
Stock Structures
Stock
struct Stock
| String | Code | comment |
| String | Exchange | comment |
| int | Bid | comment |
| int | Ask | comment |
| int | Open | comment |
| int | First | comment |
| int | High | comment |
| int | Low | comment |
| int | Last | comment |
| int | Change | comment |
| long | Volume | comment |
| long | Value | comment |
| int | AuctionPrice | comment |
| long | AuctionVolume | comment |
| int | Vwap | comment |
| long | VwapVolume | comment |
| long | VwapValue | comment |
| int | State | comment |
| ulong | QuoteBases | comment |
| int | ResumeTime | comment |
| int | OpenInterest | comment |
| IntPtr | Reserved | comment |
See GetStock, Updatestock, GetAllStocks, GetNextStock, Stocks
StockInfo
struct StockInfo
| String | Code | comment |
| String | Exchange | comment |
| String | ShortName | comment |
| String | FullName | comment |
| String | IssuerCode | comment |
| int | Flags | comment |
| long | SharesIssued | comment |
| int | Eps | comment |
| int | Dps | comment |
| int | Nta | comment |
| String | UnderlyingCode | comment |
| int | ExpiryDate | comment |
| int | StrikePrice | comment |
| int | ContractSize | comment |
See GetStockInfo, GetAllStockInfo, GetNextStockInfo, StockInfos
Stock Flags
| const int | STOCK_FLAG_CALL | 0x01 | comment |
| const int | STOCK_FLAG_PUT | 0x02 | comment |
| const int | STOCK_FLAG_WARRANT | 0x04 | comment |
| const int | STOCK_FLAG_OPTION | 0x08 | comment |
| const int | STOCK_FLAG_NO_DEPTH_DETAIL | 0x10 | comment |
Index Structure
Index
struct Index
| String | Code | comment |
| String | Exchange | comment |
| String | ShortName | comment |
| String | FullName | comment |
| int | Open | comment |
| int | First | comment |
| int | High | comment |
| int | Low | comment |
| int | Last | comment |
| int | Change | comment |
| IntPtr | Reserved | comment |
See GetIndex, UpdateIndex, GetAllIndices, GetNextIndices, Indices
Issuer Structure
Issuer
struct Issuer
| String | Code | comment |
| String | Exchange | comment |
| String | ShortName | comment |
| String | FullName | comment |
| IntPtr | Reserved | comment |
| int | Reserved2 | comment |
See GetIssuer, GetAllIssuers, GetNextIssuer, GetStockIssuer, GetAllIssuerStocks, GetNextIssuerStock, IssuerStocks
Exchange Structure
Exchange
struct Exchange
| String | Code | comment |
| String | ShortName | comment |
| String | FullName | comment |
| int | State | comment |
| int | Date | comment |
| int | Time | comment |
| int | TimeNsec | comment |
| int | LocalTimeOffset | comment |
| IntPtr | Reserved | comment |
See GetExchange, UpdateExchange, GetExchangeTime, GetAllSubscribedExchanges, GetNextSubscribedExchange, SubscribedExchanges
Depth Structures
Depth
struct Depth
| DepthLevel | bids | comment |
| DepthLevel | offers | comment |
DepthLevel
struct DepthLevel
| int | Flags | comment |
| int | Price | comment |
| long | Volume | comment |
| int | Count | comment |
| IntPtr | Reserved | comment |
DepthDetail
struct DepthDetail
| int | Flags | comment |
| int | Price | comment |
| long | Volume | comment |
| int | TimePlaced | comment |
| int | TimePlacedNsec | comment |
| IntPtr | Reserved | comment |
See GetStockDepth, GetStockBids, GetStockOffers , GetNextStockDepthLevel , GetNextStockDepthDetail , FreeStockDepth, FreeStockDepthLevel
Depth Flags
| const int | DEPTH_FLAG_BID | 0x01 | comment |
| const int | DEPTH_FLAG_ASK | 0x02 | comment |
| const int | DEPTH_FLAG_UNDISCLOSED | 0x04 | comment |
Event Structure
Event Types
| const int | EVENT_STATUS | 0 | comment |
| const int | EVENT_NEW_DEPTH | 1 | comment |
| const int | EVENT_AMEND_DEPTH | 2 | comment |
| const int | EVENT_DELETE_DEPTH | 3 | comment |
| const int | EVENT_CLEAR_DEPTH | 4 | comment |
| const int | EVENT_QUOTE | 5 | comment |
| const int | EVENT_TRADE | 6 | comment |
| const int | EVENT_CANCEL_TRADE | 7 | comment |
| const int | EVENT_STATE_CHANGE | 8 | comment |
| const int | EVENT_QUOTE_BASES | 9 | comment |
| const int | EVENT_AUCTION_PRICE | 10 | comment |
| const int | EVENT_OPEN_INTEREST | 11 | comment |
| const int | EVENT_INDEX | 12 | comment |
| const int | EVENT_NEWS | 13 | comment |
Event
struct Event
| String | Code | comment |
| String | Exchange | comment |
| int | Type | comment |
| int | Time | comment |
| int | TimeNsec | comment |
| int | Flags | comment |
| int | Price | comment |
| long | Volume | comment |
| int | Position | comment |
| int | Count | comment |
| int | State | comment |
| ulong | QuoteBases | comment |
| ulong | ConditionCodes | comment |
| int | Reference | comment |
| IntPtr | Reserved | comment |
See GetAllStockEvents, GetNewStockEvents, GetNextStockEvent, GetPastStockEvents, GetNextPastStockEvent, PastEvents
Status Types
| const int | STATUS_BEGIN_DAY | 0 | comment |
| const int | STATUS_END_DAY | 1 | comment |
| const int | STATUS_CONN_DOWN | 2 | comment |
| const int | STATUS_CONN_UP | 3 | comment |
| const int | STATUS_RESET | 4 | comment |
Trade Structure
Trade
struct Trade
| int | Time | comment |
| int | TimeNsec | comment |
| int | Price | comment |
| long | Volume | comment |
| ulong | ConditionCodes | comment |
| int | Flags | comment |
| IntPtr | Reserved | comment |
See GetAllStockTrades, GetNewStockTrades, GetNextStockTrade, Trades, GetPastStockTrades, GetNextPastStockTrade, PastTrades
Trade Flags
| const int | TRADE_FLAG_ADJUST_FIRST_LAST | 0x01 | comment |
| const int | TRADE_FLAG_ADJUST_HIGH_LOW | 0x02 | comment |
| const int | TRADE_FLAG_ADJUST_VOLUME_VALUE | 0x04 | comment |
| const int | TRADE_FLAG_ADJUST_VWAP | 0x08 | comment |
| const int | TRADE_FLAG_CANCELLED | 0x10 | comment |
Index Tick Structure
IndexTick
struct IndexTick
| int | Time | comment |
| int | TimeNsec | comment |
| int | Price | comment |
| IntPtr | Reserved | comment |
See GetAllIndexTicks, GetNewIndexTicks, GetNextIndexTick, IndexTicks, GetPastIndexTicks, GetNextPastIndexTick, PastIndexTicks
Stock / Index History Structure
History
struct History
| int | Date | comment |
| int | First | comment |
| int | High | comment |
| int | Low | comment |
| int | Last | comment |
| int | Change | comment |
| long | Volume | comment |
| double | CumAdjFactor | comment |
| int | Reserved | comment |
| IntPtr | Reserved2 | comment |
See GetStockHistory, GetNextStockHistoryDay, StockHistory, GetIndexHistory, GetNextIndexHistoryDay, IndexHistory
News Item Structure
NewsItem
struct NewsItem
| String | Code | comment |
| String | Exchange | comment |
| int | Time | comment |
| int | Reference | comment |
| int | Type | comment |
| int | Flags | comment |
| String | Summary | comment |
| IntPtr | Reserved | comment |
See GetAllIssuerNewsItems, GetNextIssuerNewsItem, NewsHistory, GetIssuerNewsItem, GetAllExchangeNewsItems, GetNextExchangeNewsItem, NewsToday, GetPastExchangeNewsOtems, GetNextPastExchangeNewsItem, PastNews
| const int | NEWS_FLAG_SENSITIVE | 0x01 | comment |
| const int | NEWS_FLAG_RELATED_ONLY | 0x02 | comment |
| const int | NEWS_FLAG_REMOVED | 0x04 | comment |
Stocks
GetStock
bool GetStock(ref Stock stock, string code, string exchange)
| Parameters | |
|---|---|
| stock | comment |
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
UpdateStock
bool UpdateStock(ref Stock stock)
| Parameters | |
|---|---|
| stock | comment |
| Returns | |
| comment | |
GetAllStocks
bool GetAllStocks(ref Stock stock, string exchange)
| Parameters | |
|---|---|
| stock | comment |
| exchange | comment |
| Returns | |
| comment | |
GetNextStock
bool GetNextStock(ref Stock stock)
| Parameters | |
|---|---|
| stock | comment |
| Returns | |
| comment | |
Stocks
IEnumerable<Stock> Stocks(string exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
Stock Info
GetStockInfo
bool GetStockInfo(ref Stock stock, ref StockInfo info)
| Parameters | |
|---|---|
| stock | comment |
| info | comment |
| Returns | |
| comment | |
GetAllStockInfo
bool GetAllStockInfo(ref Stock stock, ref StockInfo info, string exchange)
| Parameters | |
|---|---|
| stock | comment |
| info | comment |
| exchange | comment |
| Returns | |
| comment | |
GetNextStockInfo
bool GetNextStockInfo(ref Stock stock, ref StockInfo info)
| Parameters | |
|---|---|
| stock | comment |
| info | comment |
| Returns | |
| comment | |
StockInfos
IEnumerable<StockInfo> StockInfos(string exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
Derivatives
GetAllDerivStockInfo
bool GetAllDerivStockInfo(ref Stock stock, ref StockInfo info, string underlying_code, string exchange)
| Parameters | |
|---|---|
| stock | comment |
| info | comment |
| underlying_code | comment |
| exchange | comment |
| Returns | |
| comment | |
GetNextDerivStockInfo
bool GetNextDerivStockInfo(ref Stock stock, ref StockInfo info)
| Parameters | |
|---|---|
| stock | comment |
| info | comment |
| Returns | |
| comment | |
Derivs
IEnumerable<Stock> Derivs(string underlying_code, string exchange)
| Parameters | |
|---|---|
| underlying_code | comment |
| exchange | comment |
| Returns | |
| comment | |
DerivsInfo
IEnumerable<StockInfo> DerivsInfo(string underlying_code, string exchange)
| Parameters | |
|---|---|
| underlying_code | comment |
| exchange | comment |
| Returns | |
| comment | |
Events
GetAllStockEvents
bool GetAllStockEvents(ref Stock stock, ref Event evnt)
| Parameters | |
|---|---|
| stock | comment |
| evnt | comment |
| Returns | |
| comment | |
GetNewStockEvents
bool GetNewStockEvents(ref Stock stock, ref Event evnt)
| Parameters | |
|---|---|
| stock | comment |
| evnt | comment |
| Returns | |
| comment | |
GetNextStockEvent
bool GetNextStockEvent(ref Stock stock, ref Event evnt, int timeout_ms)
| Parameters | |
|---|---|
| stock | comment |
| evnt | comment |
| timeout_ms | comment |
| Returns | |
| comment | |
Events
IEnumerable<Event> Events(string code, string exchange)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
GetPastStockEvents
bool GetPastStockEvents(ref Stock stock, ref Event evnt, DateTime day)
| Parameters | |
|---|---|
| stock | comment |
| evnt | comment |
| day | comment |
| Returns | |
| comment | |
GetNextPastStockEvent
bool GetNextPastStockEvent(ref Stock stock, ref Event evnt)
| Parameters | |
|---|---|
| stock | comment |
| evnt | comment |
| Returns | |
| comment | |
PastEvents
IEnumerable<Event> PastEvents(string code, string exchange, DateTime date)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| date | comment |
| Returns | |
| comment | |
Trades
GetAllStockTrades
bool GetAllStockTrades(ref Stock stock, ref Trade trade)
| Parameters | |
|---|---|
| stock | comment |
| trade | comment |
| Returns | |
| comment | |
GetNewStockTrades
bool GetNewStockTrades(ref Stock stock, ref Trade trade)
| Parameters | |
|---|---|
| stock | comment |
| trade | comment |
| Returns | |
| comment | |
GetNextStockTrade
bool GetNextStockTrade(ref Stock stock, ref Trade trade, int timeout_ms)
| Parameters | |
|---|---|
| stock | comment |
| trade | comment |
| timeout_ms | comment |
| Returns | |
| comment | |
Trades
IEnumerable<Trade> Trades(string code, string exchange)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
GetPastStockTrades
bool GetPastStockTrades(ref Stock stock, ref Trade trade, DateTime day)
| Parameters | |
|---|---|
| stock | comment |
| trade | comment |
| day | comment |
| Returns | |
| comment | |
GetNextPastStockTrade
bool GetNextPastStockTrade(ref Stock stock, ref Trade trade)
| Parameters | |
|---|---|
| stock | comment |
| trade | comment |
| Returns | |
| comment | |
PastTrades
IEnumerable<Trade> PastTrades(string code, string exchange, DateTime date)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| date | comment |
| Returns | |
| comment | |
Stock History
GetAllStockHistory
bool GetAllStockHistory(ref Stock stock, ref History history)
| Parameters | |
|---|---|
| stock | comment |
| history | comment |
| Returns | |
| comment | |
GetNextStockHistoryDay
bool GetNextStockHistoryDay(ref Stock stock, ref History history)
| Parameters | |
|---|---|
| stock | comment |
| history | comment |
| Returns | |
| comment | |
StockHistory
IEnumerable<History> StockHistory(string code, string exchange)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
Depth
GetStockDepth
bool GetStockDepth(ref Stock stock, ref Depth depth, int level_count, bool include_detail)
| Parameters | |
|---|---|
| stock | comment |
| depth | comment |
| level_count | comment |
| include_detail | comment |
| Returns | |
| comment | |
GetStockDepthLevels
bool GetStockDepthLevels(ref Stock stock, ref DepthLevel bids, ref DepthLevel offers, int level_count, bool include_detail)
| Parameters | |
|---|---|
| stock | comment |
| bids | comment |
| offers | comment |
| level_count | comment |
| include_detail | comment |
| Returns | |
| comment | |
GetStockBids
bool GetStockBids(ref Stock stock, ref DepthLevel bids, int level_count, bool include_detail)
| Parameters | |
|---|---|
| stock | comment |
| bids | comment |
| level_count | comment |
| include_detail | comment |
| Returns | |
| comment | |
GetStockOffers
bool GetStockOffers(ref Stock stock, ref DepthLevel offers, int level_count, bool include_detail)
| Parameters | |
|---|---|
| stock | comment |
| offers | comment |
| level_count | comment |
| include_detail | comment |
| Returns | |
| comment | |
GetNextStockDepthLevel
bool GetNextStockDepthLevel(ref DepthLevel level)
| Parameters | |
|---|---|
| level | comment |
| Returns | |
| comment | |
GetNextStockDepthDetail
bool GetNextStockDepthDetail(ref DepthLevel level, ref DepthDetail detail)
| Parameters | |
|---|---|
| level | comment |
| detail | comment |
| Returns | |
| comment | |
FreeStockDepth
void FreeStockDepth(ref Depth depth)
| Parameters | |
|---|---|
| depth | comment |
FreeStockDepthLevel
void FreeStockDepthLevel(ref DepthLevel level)
| Parameters | |
|---|---|
| level | comment |
Bids
IEnumerable<DepthLevel> Bids(string code, string exchange, int nlevels)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| nlevels | comment |
| Returns | |
| comment | |
Offers
IEnumerable<DepthLevel> Offers(string code, string exchange, int nlevels)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| nlevels | comment |
| Returns | |
| comment | |
BidsDetail
IEnumerable<DepthDetail> BidsDetail(string code, string exchange, int nlevels)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| nlevels | comment |
| Returns | |
| comment | |
OffersDetail
IEnumerable<DepthDetail> OffersDetail(string code, string exchange, int nlevels)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| nlevels | comment |
| Returns | |
| comment | |
Levels
IEnumerable<DepthLevel> Levels(DepthLevel level)
| Parameters | |
|---|---|
| level | comment |
| Returns | |
| comment | |
Details
IEnumerable<DepthDetail> Details(DepthLevel level)
| Parameters | |
|---|---|
| level | comment |
| Returns | |
| comment | |
Orders
IEnumerable<DepthDetail> Orders(String code, String exchange, int nlevels)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| nlevels | comment |
| Returns | |
| comment | |
Indices
GetIndex
bool GetIndex(ref Index index, string code, string exchange)
| Parameters | |
|---|---|
| index | comment |
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
UpdateIndex
bool UpdateIndex(ref Index index)
| Parameters | |
|---|---|
| index | comment |
| Returns | |
| comment | |
GetAllIndices
bool GetAllIndices(ref Index index, string exchange)
| Parameters | |
|---|---|
| index | comment |
| exchange | comment |
| Returns | |
| comment | |
GetNextIndex
bool GetNextIndex(ref Index index)
| Parameters | |
|---|---|
| index | comment |
| Returns | |
| comment | |
Indices
IEnumerable<Index> Indices(string exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
Index Ticks
GetAllIndexTicks
bool GetAllIndexTicks(ref Index index, ref IndexTick tick)
| Parameters | |
|---|---|
| index | comment |
| tick | comment |
| Returns | |
| comment | |
GetNewIndexTicks
bool GetNewIndexTicks(ref Index index, ref IndexTick tick)
| Parameters | |
|---|---|
| index | comment |
| tick | comment |
| Returns | |
| comment | |
GetNextIndexTick
bool GetNextIndexTick(ref Index index, ref IndexTick tick, int timeout_ms)
| Parameters | |
|---|---|
| index | comment |
| tick | comment |
| timeout_ms | comment |
| Returns | |
| comment | |
IndexTicks
IEnumerable<IndexTick> IndexTicks(string code, string exchange)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
GetPastIndexTicks
bool GetPastIndexTicks(ref Index index, ref IndexTick tick, DateTime day)
| Parameters | |
|---|---|
| index | comment |
| tick | comment |
| day | comment |
| Returns | |
| comment | |
GetNextPastIndexTick
bool GetNextPastIndexTick(ref Index index, ref IndexTick tick)
| Parameters | |
|---|---|
| index | comment |
| tick | comment |
| Returns | |
| comment | |
PastIndexTicks
IEnumerable<IndexTick> PastIndexTicks(string code, string exchange, DateTime day)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| day | comment |
| Returns | |
| comment | |
Index History
GetAllIndexHistory
bool GetAllIndexHistory(ref Index index, ref History history)
| Parameters | |
|---|---|
| index | comment |
| history | comment |
| Returns | |
| comment | |
GetNextIndexHistoryDay
bool GetNextIndexHistoryDay(ref Index index, ref History history)
| Parameters | |
|---|---|
| index | comment |
| history | comment |
| Returns | |
| comment | |
IndexHistory
IEnumerable<History> IndexHistory(string code, string exchange)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
Issuers
GetIssuer
bool GetIssuer(ref Issuer issuer, string code, string exchange)
| Parameters | |
|---|---|
| issuer | comment |
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
GetAllIssuers
bool GetAllIssuers(ref Issuer issuer, string exchange)
| Parameters | |
|---|---|
| issuer | comment |
| exchange | comment |
| Returns | |
| comment | |
GetNextIssuer
bool GetNextIssuer(ref Issuer issuer)
| Parameters | |
|---|---|
| issuer | comment |
| Returns | |
| comment | |
Issuers
IEnumerable<Issuer> Issuers(string exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
GetStockIssuer
bool GetStockIssuer(ref Issuer issuer, ref Stock stock)
| Parameters | |
|---|---|
| issuer | comment |
| stock | comment |
| Returns | |
| comment | |
GetAllIssuerStocks
bool GetAllIssuerStocks(ref Issuer issuer, ref Stock stock)
| Parameters | |
|---|---|
| issuer | comment |
| stock | comment |
| Returns | |
| comment | |
GetNextIssuerStock
bool GetNextIssuerStock(ref Issuer issuer, ref Stock stock)
| Parameters | |
|---|---|
| issuer | comment |
| stock | comment |
| Returns | |
| comment | |
IssuerStocks
IEnumerable<Stock> IssuerStocks(string code, string exchange)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
Issuer News
GetAllIssuerNewsItems
bool GetAllIssuerNewsItems(ref Issuer issuer, ref NewsItem news)
| Parameters | |
|---|---|
| issuer | comment |
| news | comment |
| Returns | |
| comment | |
GetNextIssuerNewsItem
bool GetNextIssuerNewsItem(ref Issuer issuer, ref NewsItem news)
| Parameters | |
|---|---|
| issuer | comment |
| news | comment |
| Returns | |
| comment | |
NewsHistory
IEnumerable<NewsItem> NewsHistory(string code, string exchange)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| Returns | |
| comment | |
GetIssuerNewsItem
bool GetIssuerNewsItem(ref Issuer issuer, ref NewsItem news, int reference)
| Parameters | |
|---|---|
| issuer | comment |
| news | comment |
| reference | comment |
| Returns | |
| comment | |
GetIssuerNewsItemURL
string GetIssuerNewsItemURL(ref Issuer issuer, ref NewsItem news, int reference)
| Parameters | |
|---|---|
| issuer | comment |
| news | comment |
| reference | comment |
| Returns | |
| comment | |
GetNewsURL
string GetNewsURL(string code, string exchange, int reference)
| Parameters | |
|---|---|
| code | comment |
| exchange | comment |
| reference | comment |
| Returns | |
| comment | |
Exchanges
GetExchange
bool GetExchange(ref Exchange exchange, string code)
| Parameters | |
|---|---|
| exchange | comment |
| code | comment |
| Returns | |
| comment | |
UpdateExchange
bool UpdateExchange(ref Exchange exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
GetExchangeTime
DateTime GetExchangeTime(string code)
| Parameters | |
|---|---|
| code | comment |
| Returns | |
| comment | |
GetAllSubscribedExchanges
bool GetAllSubscribedExchanges(ref Exchange exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
GetNextSubscribedExchange
bool GetNextSubscribedExchange(ref Exchange exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
SubscribedExchanges
IEnumerable<Exchange> SubscribedExchanges()
| Returns | |
|---|---|
| comment |
Exchange Events
GetAllExchangeEvents
bool GetAllExchangeEvents(ref Exchange exchange, ref Event evnt)
| Parameters | |
|---|---|
| exchange | comment |
| evnt | comment |
| Returns | |
| comment | |
GetNewExchangeEvents
bool GetNewExchangeEvents(ref Exchange exchange, ref Event evnt)
| Parameters | |
|---|---|
| exchange | comment |
| evnt | comment |
| Returns | |
| comment | |
GetNextExchangeEvent
bool GetNextExchangeEvent(ref Exchange exchange, ref Event evnt, int timeout_ms)
| Parameters | |
|---|---|
| exchange | comment |
| evnt | comment |
| timeout_ms | comment |
| Returns | |
| comment | |
Events
IEnumerable<Event> Events(string exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
Exchange News
GetAllExchangeNewsItems
bool GetAllExchangeNewsItems(ref Exchange exchange, ref NewsItem news)
| Parameters | |
|---|---|
| exchange | comment |
| news | comment |
| Returns | |
| comment | |
GetNextExchangeNewsItem
bool GetNextExchangeNewsItem(ref Exchange exchange, ref NewsItem news)
| Parameters | |
|---|---|
| exchange | comment |
| news | comment |
| Returns | |
| comment | |
NewsToday
IEnumerable<NewsItem> NewsToday(string exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
GetPastExchangeNewsItems
bool GetPastExchangeNewsItems(ref Exchange exchange, ref NewsItem news, DateTime day)
| Parameters | |
|---|---|
| exchange | comment |
| news | comment |
| day | comment |
| Returns | |
| comment | |
GetNextPastExchangeNewsItem
bool GetNextPastExchangeNewsItem(ref Exchange exchange, ref NewsItem news)
| Parameters | |
|---|---|
| exchange | comment |
| news | comment |
| Returns | |
| comment | |
PastNews
IEnumerable<NewsItem> PastNews(string exchange, DateTime day)
| Parameters | |
|---|---|
| exchange | comment |
| day | comment |
| Returns | |
| comment | |
Releasing Memory
ReleaseCurrentEvents
bool ReleaseCurrentEvents()
| Returns | |
|---|---|
| comment |
ReleaseExchangeEventsTo
bool ReleaseExchangeEventsTo(ref Exchange exchange, ref Event evnt)
| Parameters | |
|---|---|
| exchange | comment |
| evnt | comment |
| Returns | |
| comment | |
ReleaseStockEvents
bool ReleaseStockEvents(ref Stock stock)
| Parameters | |
|---|---|
| stock | comment |
| Returns | |
| comment | |
ReleasePastStockEvents
bool ReleasePastStockEvents(ref Stock stock, DateTime day)
| Parameters | |
|---|---|
| stock | comment |
| day | comment |
| Returns | |
| comment | |
ReleaseAllPastStockEvents
bool ReleaseAllPastStockEvents(ref Stock stock)
| Parameters | |
|---|---|
| stock | comment |
| Returns | |
| comment | |
ReleaseStockHistory
bool ReleaseStockHistory(ref Stock stock)
| Parameters | |
|---|---|
| stock | comment |
| Returns | |
| comment | |
ReleaseIndexEvents
bool ReleaseIndexEvents(ref Index index)
| Parameters | |
|---|---|
| index | comment |
| Returns | |
| comment | |
ReleasePastIndexEvents
bool ReleasePastIndexEvents(ref Index index, DateTime day)
| Parameters | |
|---|---|
| index | comment |
| day | comment |
| Returns | |
| comment | |
ReleaseAllPastIndexEvents
bool ReleaseAllPastIndexEvents(ref Index index)
| Parameters | |
|---|---|
| index | comment |
| Returns | |
| comment | |
ReleaseIndexHistory
bool ReleaseIndexHistory(ref Index index)
| Parameters | |
|---|---|
| index | comment |
| Returns | |
| comment | |
ReleaseIssuerNewsItems
bool ReleaseIssuerNewsItems(ref Issuer issuer)
| Parameters | |
|---|---|
| issuer | comment |
| Returns | |
| comment | |
Special Codes
EventTypeToStr
string EventTypeToStr(int type)
| Parameters | |
|---|---|
| type | comment |
| Returns | |
| comment | |
StatusToStr
string StatusToStr(int status)
| Parameters | |
|---|---|
| status | comment |
| Returns | |
| comment | |
StateToStr
string StateToStr(int state)
| Parameters | |
|---|---|
| state | comment |
| Returns | |
| comment | |
QuoteBasisToStr
string QuoteBasisToStr(ulong quote_basis, string exchange)
| Parameters | |
|---|---|
| quote_basis | comment |
| exchange | comment |
| Returns | |
| comment | |
ConditionCodeToStr
string ConditionCodeToStr(ulong condition_code, string exchange)
| Parameters | |
|---|---|
| condition_code | comment |
| exchange | comment |
| Returns | |
| comment | |
QuoteBasesToStr
string QuoteBasesToStr(ulong quote_bases, string exchange)
| Parameters | |
|---|---|
| quote_bases | comment |
| exchange | comment |
| Returns | |
| comment | |
ConditionCodesToStr
string ConditionCodesToStr(ulong condition_codes, string exchange)
| Parameters | |
|---|---|
| condition_codes | comment |
| exchange | comment |
| Returns | |
| comment | |
QuoteBasisDesc
string QuoteBasisDesc(ulong quote_basis, string exchange)
| Parameters | |
|---|---|
| quote_basis | comment |
| exchange | comment |
| Returns | |
| comment | |
ConditionCodeDesc
string ConditionCodeDesc(ulong condition_code, string exchange)
| Parameters | |
|---|---|
| condition_code | comment |
| exchange | comment |
| Returns | |
| comment | |
NewsTypeToExchangeType
string NewsTypeToExchangeType(int news_type, string exchange)
| Parameters | |
|---|---|
| news_type | comment |
| exchange | comment |
| Returns | |
| comment | |
NewsTypeDesc
string NewsTypeDesc(int news_type)
| Parameters | |
|---|---|
| news_type | comment |
| Returns | |
| comment | |
Time Conversion
DateTimeToTime
int DateTimeToTime(DateTime time)
| Parameters | |
|---|---|
| time | comment |
| Returns | |
| comment | |
TimeToDateTime
DateTime TimeToDateTime(long time)
| Parameters | |
|---|---|
| time | comment |
| Returns | |
| comment | |
note that DateTime has a resolution of 100ns
TimeNsecToDateTime
DateTime TimeNsecToDateTime(int time, int time_nsec)
| Parameters | |
|---|---|
| time | comment |
| time_nsec | comment |
| Returns | |
| comment | |
Initialization
Init
bool Init()
| Returns | |
|---|---|
| comment |
Exit
void Exit()
API Version
| const int | API_VERSION_MAJOR | 1 | comment |
| const int | API_VERSION_MINOR | 2 | comment |
| const int | API_VERSION_PATCH | 4 | comment |
GetVersion
string GetVersion()
| Returns | |
|---|---|
| comment |
GetCopyright
string GetCopyright()
| Returns | |
|---|---|
| comment |
Connection Status
| const int | SPARK_CONNECTING | 0x01 | comment |
| const int | SPARK_CONNECTED | 0x02 | comment |
| const int | SPARK_LOGGED_IN | 0x04 | comment |
GetConnectionStatus
int GetConnectionStatus()
| Returns | |
|---|---|
| comment |
Optional Data
| const int | OPTION_ALL_EXCHANGE_EVENTS | 0x01 | comment |
| const int | OPTION_NEW_EXCHANGE_EVENTS | 0x02 | comment |
| const int | OPTION_EXCHANGE_NEWS | 0x04 | comment |
| const int | OPTION_PAST_EXCHANGE_NEWS | 0x08 | comment |
| const int | OPTION_INFO | 0x10 | comment |
SetOptions
void SetOptions(int options)
| Parameters | |
|---|---|
| options | comment |
SetLogin
void SetLogin(string username, string passwd)
| Parameters | |
|---|---|
| username | comment |
| passwd | comment |
SetLoginSite
void SetLoginSite(string site)
| Parameters | |
|---|---|
| site | comment |
SetServer
void SetServer(string hostname, int port)
| Parameters | |
|---|---|
| hostname | comment |
| port | comment |
Protocol
| const int | PROTO_NATIVE | 0 | comment |
| const int | PROTO_HTTP | 1 | comment |
SetProto
void SetProto(int proto)
| Parameters | |
|---|---|
| proto | comment |
SetProxy
void SetProxy(string hostname, int port, string username, string passwd)
| Parameters | |
|---|---|
| hostname | comment |
| port | comment |
| username | comment |
| passwd | comment |
SetDefaultExchange
bool SetDefaultExchange(string exchange)
| Parameters | |
|---|---|
| exchange | comment |
| Returns | |
| comment | |
GetDefaultExchange
String GetDefaultExchange()
| Returns | |
|---|---|
| comment |
SetDefaultDepthLevels
bool SetDefaultDepthLevels(int nlevels)
| Parameters | |
|---|---|
| nlevels | comment |
| Returns | |
| comment | |
SetQueryTimeout
bool SetQueryTimeout(int timeout_ms)
| Parameters | |
|---|---|
| timeout_ms | comment |
| Returns | |
| comment | |
SetCacheDir
bool SetCacheDir(string path, int max_size_mb)
| Parameters | |
|---|---|
| path | comment |
| max_size_mb | comment |
| Returns | |
| comment | |
Connect / Disconnect
Connect
bool Connect()
| Returns | |
|---|---|
| comment |
Disconnect
void Disconnect()
Logging
NOTE: The LogCallback delegate that you pass to SetLogCallback is stored in unmanaged code. You must make sure that it is never garbage collected.
LogCallback
delegate void LogCallback(int level, string msg)
| Parameters | |
|---|---|
| level | comment |
| msg | comment |
| Returns | |
| comment | |
SetLogCallback
void SetLogCallback(LogCallback cb)
| Parameters | |
|---|---|
| cb | comment |
| const int | LOG_INFO | 1 | comment |
| const int | LOG_WARN | 2 | comment |
| const int | LOG_ERROR | 3 | comment |
SetLogLevel
void SetLogLevel(int level)
| Parameters | |
|---|---|
| level | comment |
LogLevelStr
string LogLevelStr(int level)
| Parameters | |
|---|---|
| level | comment |
| Returns | |
| comment | |
Errors
| const int | ERROR_EXCHANGE_NOT_FOUND | -10 | comment |
| const int | ERROR_STOCK_NOT_FOUND | -11 | comment |
| const int | ERROR_INDEX_NOT_FOUND | -12 | comment |
| const int | ERROR_ISSUER_NOT_FOUND | -13 | comment |
| const int | ERROR_NEWS_NOT_FOUND | -14 | comment |
| const int | ERROR_NO_DEPTH_DETAIL | -15 | comment |
| const int | ERROR_TIMEOUT | -20 | comment |
| const int | ERROR_DISCONNECTED | -21 | comment |
| const int | ERROR_SET_OPTION | -22 | comment |
| const int | ERROR_INVALID_PARAM | -23 | comment |
| const int | ERROR_STRUCT_NOT_INIT | -24 | comment |
| const int | ERROR_BUF_TOO_SMALL | -25 | comment |
| const int | ERROR_CANT_CONNECT | -30 | comment |
| const int | ERROR_CANT_CONNECT_PROXY | -31 | comment |
| const int | ERROR_INVALID_PROXY_AUTH | -32 | comment |
| const int | ERROR_INVALID_LOGIN | -40 | comment |
| const int | ERROR_API_NOT_ALLOWED | -41 | comment |
| const int | ERROR_NO_LICENCES | -42 | comment |
| const int | ERROR_SIMULTANEOUS_LOGIN | -50 | comment |
| const int | ERROR_LOGIN_DROPPED | -51 | comment |
| const int | ERROR_CONN_DROPPED | -52 | comment |
| const int | ERROR_UPDATE_REQD | -53 | comment |
| const int | ERROR_CANT_OPEN_CACHE | -60 | comment |
| const int | ERROR_VERSION_MISMATCH | -70 | comment |
| const int | ERROR_INTERNAL | -71 | comment |
| const int | ERROR_OUT_OF_MEMORY | -72 | comment |
| const int | ERROR_CREATE_THREAD | -73 | comment |
| const int | ERROR_DATA_NOT_ALLOWED | -74 | comment |
| const int | ERROR_TRIAL_NOT_ALLOWED | -75 | comment |
GetLastError
int GetLastError()
| Returns | |
|---|---|
| comment |
DescribeError
string DescribeError(int err)
| Parameters | |
|---|---|
| err | comment |
| Returns | |
| comment | |
States
| const int | STATE_NONE | 0 | comment |
| const int | STATE_PREOPEN | 10 | comment |
| const int | STATE_OPEN | 20 | comment |
| const int | STATE_PRE_CSPA | 30 | comment |
| const int | STATE_CSPA | 40 | comment |
| const int | STATE_ADJUST | 50 | comment |
| const int | STATE_ADJUST_ON | 60 | comment |
| const int | STATE_ENQUIRE | 70 | comment |
| const int | STATE_PURGE_ORDERS | 80 | comment |
| const int | STATE_SYSTEM_MAINTENANCE | 90 | comment |
| const int | STATE_LATE_TRADING | 100 | comment |
| const int | STATE_PRE_NIGHT_TRADING | 110 | comment |
| const int | STATE_OPEN_NIGHT_TRADING | 120 | comment |
| const int | STATE_CLOSE | 130 | comment |
| const int | STATE_SUSPEND | 140 | comment |
| const int | STATE_PRE_NR | 141 | comment |
| const int | STATE_ABB_AUCTION | 142 | comment |
| const int | STATE_TRADING_HALT | 143 | comment |
| const int | STATE_OPEN_VMB | 144 | comment |
| const int | STATE_WAIT_VMB | 145 | comment |
| const int | STATE_REG_HALT | 146 | comment |
| const int | STATE_INTERNATIONAL_HALT | 147 | comment |
Condition Codes
| const ulong | CC_NONE | 0x0000000000000000L |
| const ulong | CC_CROSSED | 0x0000000000000001L |
| const ulong | CC_OFF_MARKET | 0x0000000000000002L |
| const ulong | CC_PORTFOLIO_SPECIAL_CROSSING | 0x0000000000000004L |
| const ulong | CC_EXERCISE_CALL | 0x0000000000000008L |
| const ulong | CC_FIXEDINT | 0x0000000000000010L |
| const ulong | CC_BLOCK_SPECIAL_CROSSING | 0x0000000000000020L |
| const ulong | CC_BUY_AND_WRITE | 0x0000000000000040L |
| const ulong | CC_LATE_REPORTED | 0x0000000000000080L |
| const ulong | CC_INTERNATIONAL | 0x0000000000000100L |
| const ulong | CC_OVERSEAS | 0x0000000000000200L |
| const ulong | CC_SMALL_MARKET_TRADE | 0x0000000000000400L |
| const ulong | CC_EXERCISE_PUT | 0x0000000000000800L |
| const ulong | CC_PORTFOLIO_MARRIAGE | 0x0000000000001000L |
| const ulong | CC_PRICE_STABILISATION | 0x0000000000002000L |
| const ulong | CC_BOOKING_PURPOSES | 0x0000000000004000L |
| const ulong | CC_DIRECT_REPORTING | 0x0000000000008000L |
| const ulong | CC_LESSER_SPECIAL_CROSSING | 0x0000000000010000L |
| const ulong | CC_FORWARD_DELIVERY | 0x0000000000020000L |
| const ulong | CC_PROMPT_SALE | 0x0000000000040000L |
| const ulong | CC_PROMPT_REBOOK | 0x0000000000080000L |
| const ulong | CC_INDEX_PORTFOLIO_REPLICATING_SPECIAL | 0x0000000000100000L |
| const ulong | CC_BUY_BACK | 0x0000000000200000L |
| const ulong | CC_LOAN | 0x0000000000400000L |
| const ulong | CC_OVERNIGHT | 0x0000000000800000L |
| const ulong | CC_VWAP_TRADE | 0x0000000001000000L |
| const ulong | CC_LOAN_RETURN | 0x0000000002000000L |
| const ulong | CC_SHORT_SALE | 0x0000000004000000L |
| const ulong | CC_OVERSEAS_RESIDENT | 0x0000000008000000L |
| const ulong | CC_BOOK_VALUE | 0x0000000010000000L |
| const ulong | CC_MARKET_INFO | 0x0000000020000000L |
| const ulong | CC_SPECIAL_CROSSING_TRADE | 0x0000000040000000L |
| const ulong | CC_EXTRA_ORDINARY | 0x0000000080000000L |
| const ulong | CC_BULLETIN_BOARD | 0x0000000100000000L |
| const ulong | CC_CM_COMBO | 0x0000000200000000L |
| const ulong | CC_CT_COMBO | 0x0000000400000000L |
| const ulong | CC_EQUITY_OPTION_COMBO | 0x0000000800000000L |
| const ulong | CC_NON_SCR_TRD_GOVT_INSTR | 0x0000001000000000L |
| const ulong | CC_PUT_THROUGH_SPECIAL_CROSSING | 0x0000002000000000L |
| const ulong | CC_TAILOR_MADE_COMBO | 0x0000004000000000L |
| const ulong | CC_NON_SCR_TRD_WHOLESALE_INSTR | 0x0000008000000000L |
| const ulong | CC_PERMITTED_POST_TRADING | 0x0000010000000000L |
| const ulong | CC_OTHER_SPECIAL_CROSSING_DEPRECATED | 0x0000010000000000L |
| const ulong | CC_PERMITTED_PRE_TRADING | 0x0000020000000000L |
| const ulong | CC_FOREIGN_MARKET_SALE_DEPRECATED | 0x0000020000000000L |
| const ulong | CC_LATE_BOOK_SQUARING | 0x0000040000000000L |
| const ulong | CC_LATE_HEDGING | 0x0000080000000000L |
| const ulong | CC_LATE_ORDER_COMPLETION | 0x0000100000000000L |
| const ulong | CC_LATE_ERROR_RECTIFICATION | 0x0000200000000000L |
| const ulong | CC_LATE_PUT_THROUGH | 0x0000400000000000L |
| const ulong | CC_CENTER_POINT | 0x0000800000000000L |
| const ulong | CC_QUOTE_BOARD | 0x0001000000000000L |
| const ulong | CC_VOLUME_MATCH | 0x0002000000000000L |
| const ulong | CC_ETF_SPECIAL_TRADE | 0x0004000000000000L |
| const ulong | CC_PUT_THROUGH_SPECIAL_CROSSING_T2_T1 | 0x0008000000000000L |
| const ulong | CC_PUT_THROUGH_SPECIAL_CROSSING_T3_T2 | 0x0010000000000000L |
| const ulong | CC_SPECIAL_CROSSING_T1 | 0x0020000000000000L |
| const ulong | CC_SPECIAL_CROSSING_T2_T1 | 0x0040000000000000L |
| const ulong | CC_SPECIAL_CROSSING_T3_T2 | 0x0080000000000000L |
| const ulong | CC_BLOCK_TRADE | 0x0100000000000000L |
| const ulong | CC_EXCHANGE_FOR_PHYSICAL | 0x0200000000000000L |
| const ulong | CC_EXCHANGE_FOR_SWAP | 0x0400000000000000L |
| const ulong | CC_NBBO_CROSSING | 0x0800000000000000L |
| const ulong | CC_OUT_OF_HOURS_TRADE | 0x1000000000000000L |
| const ulong | CC_LARGE_PORTFOLIO_TRADE | 0x2000000000000000L |
| const ulong | CC_LARGE_PRINCIPLE_TRANSACTION | 0x4000000000000000L |
| const ulong | CC_OTC_CONTINGENT | 0x8000000000000000L |
Quote Bases
| const ulong | QB_NONE | 0x0000000000000000L |
| const ulong | QB_EX_DIVIDEND | 0x0000000000000001L |
| const ulong | QB_NOTICE_RECEIVED | 0x0000000000000002L |
| const ulong | QB_INTEREST_ONLY | 0x0000000000000004L |
| const ulong | QB_SHORT_SELL_ALLOWED | 0x0000000000000008L |
| const ulong | QB_NOTICE_LATE | 0x0000000000000010L |
| const ulong | QB_UNDER_OFFER_OF_TAKEOVER | 0x0000000000000020L |
| const ulong | QB_RECONSTRUCTED | 0x0000000000000040L |
| const ulong | QB_ROLLOVER_PENDING | 0x0000000000000080L |
| const ulong | QB_ROLLOVER_COMPLETE | 0x0000000000000100L |
| const ulong | QB_EX_INTEREST | 0x0000000000000200L |
| const ulong | QB_CUM_DIVIDEND_STOCK | 0x0000000000000400L |
| const ulong | QB_EX_ENTITLEMENT | 0x0000000000000800L |
| const ulong | QB_EX_RIGHTS_ISSUE | 0x0000000000001000L |
| const ulong | QB_CONDITIONAL_TRADING | 0x0000000000002000L |
| const ulong | QB_CURRENTLY_UNDER_RECONSTRUCTION | 0x0000000000004000L |
| const ulong | QB_PROTECTION_UNAVAILABLE | 0x0000000000008000L |
| const ulong | QB_CUM_BONUS | 0x0000000000010000L |
| const ulong | QB_CUM_CAPITAL_RETURN | 0x0000000000020000L |
| const ulong | QB_CUM_ENTITLEMENT | 0x0000000000040000L |
| const ulong | QB_CUM_TAKEOVER_OFFER | 0x0000000000080000L |
| const ulong | QB_CUM_INTEREST | 0x0000000000100000L |
| const ulong | QB_CALL_DUE | 0x0000000000200000L |
| const ulong | QB_CALL_PAID | 0x0000000000400000L |
| const ulong | QB_CUM_PRIORITY | 0x0000000000800000L |
| const ulong | QB_CUM_PREMIUM_RETURN | 0x0000000001000000L |
| const ulong | QB_CUM_EQUAL_ACCESS_BUYBACK | 0x0000000002000000L |
| const ulong | QB_CUM_RIGHTS | 0x0000000004000000L |
| const ulong | QB_PROTECTION_AVAILABLE | 0x0000000008000000L |
| const ulong | QB_NEW_EX_INTEREST | 0x0000000010000000L |
| const ulong | QB_EX_BONUS_ISSUE | 0x0000000020000000L |
| const ulong | QB_EX_RETURN_OF_CAPITAL | 0x0000000040000000L |
| const ulong | QB_EX_TAKEOVER_OFFER | 0x0000000080000000L |
| const ulong | QB_EX_RETURN_OF_PREMIUM | 0x0000000100000000L |
| const ulong | QB_EX_EQUAL_ACCESS_BUYBACK | 0x0000000200000000L |
| const ulong | QB_EX_PRIORITY | 0x0000000400000000L |
| const ulong | QB_DELAY_DELIVERY | 0x0000000800000000L |
| const ulong | QB_PAR_VALUE_PENDING | 0x0000001000000000L |
| const ulong | QB_RECONSTRUCTION_PENDING | 0x0000002000000000L |
| const ulong | QB_EX_RIGHT_OF_CONVERSION | 0x0000004000000000L |
| const ulong | QB_SUBJECT_TO_ESCALATION | 0x0000008000000000L |
| const ulong | QB_RECEIVER_APPOINTED | 0x0000010000000000L |
| const ulong | QB_CUM_RIGHT_OF_CONVERSION | 0x0000020000000000L |
| const ulong | QB_TRADING_HALT | 0x0000040000000000L |
| const ulong | QB_1_TENTH_PRICE_STEP | 0x0000080000000000L |
| const ulong | QB_SPECIAL_DISTRIBUTION | 0x0000100000000000L |
| const ulong | QB_HIGH_DENOMINATION | 0x0000200000000000L |
| const ulong | QB_CUM_NON_PRO_RATA_BALANCE | 0x0000400000000000L |
| const ulong | QB_EX_NON_PRO_RATA_BALANCE | 0x0000800000000000L |
| const ulong | QB_NZAX_MARKET_INSTRUMENT | 0x0001000000000000L |
| const ulong | QB_NON_CLEARING_HOUSE_SETTLED | 0x0002000000000000L |
| const ulong | QB_NON_FSS_SETTLED | 0x0002000000000000L |
| const ulong | QB_UNDER_ADJUSTMENT | 0x0004000000000000L |
| const ulong | QB_NON_STANDARD_LISTING | 0x0008000000000000L |
| const ulong | QB_NOTICE_PENDING | 0x0010000000000000L |
| const ulong | QB_CUM_CAPITAL_CHANGE | 0x0020000000000000L |
| const ulong | QB_EX_CAPITAL_CHANGE | 0x0040000000000000L |
News Types
| const int | NEWS_TYPE_NONE | 0 |
| const int | NEWS_TYPE_TAKEOVER_ANNOUNCEMENT | 1 |
| const int | NEWS_TYPE_INTENTION_TO_MAKE_A_TAKEOVER_OFFER | 2 |
| const int | NEWS_TYPE_PART_A_TAKEOVER_STATEMENT | 3 |
| const int | NEWS_TYPE_PART_B_TAKEOVER_STATEMENT | 4 |
| const int | NEWS_TYPE_PART_C_TAKEOVER_STATEMENT | 5 |
| const int | NEWS_TYPE_PART_D_TAKEOVER_STATEMENT | 6 |
| const int | NEWS_TYPE_TAKEOVER_OFFER_DOCUMENT_TO_SHAREHOLDERS | 7 |
| const int | NEWS_TYPE_DIRECTORS_STATEMENT_RE_TAKEOVER | 8 |
| const int | NEWS_TYPE_VARIATION_OF_TAKEOVER_OFFER | 9 |
| const int | NEWS_TYPE_TAKEOVER_OTHER | 10 |
| const int | NEWS_TYPE_SHAREHOLDER_DETAILS | 11 |
| const int | NEWS_TYPE_BECOMING_A_SUBSTANTIAL_SHAREHOLDER | 12 |
| const int | NEWS_TYPE_CHANGE_IN_SUBSTANTIAL_SHAREHOLDING | 13 |
| const int | NEWS_TYPE_CEASING_TO_BE_A_SUBSTANTIAL_SHAREHOLDER | 14 |
| const int | NEWS_TYPE_BENEFICIAL_OWNERSHIP_PART_68 | 15 |
| const int | NEWS_TYPE_TAKEOVER_UPDATE_SECTION_689_NOTICE | 16 |
| const int | NEWS_TYPE_SHAREHOLDER_DETAILS_OTHER | 17 |
| const int | NEWS_TYPE_SECTION_235_NOTICE_DIRECTORS_INTERESTS | 18 |
| const int | NEWS_TYPE_PERIODIC_REPORTS | 19 |
| const int | NEWS_TYPE_ANNUAL_REPORT | 20 |
| const int | NEWS_TYPE_TOP_20_SHAREHOLDERS | 21 |
| const int | NEWS_TYPE_PRELIMINARY_FINAL_REPORT | 22 |
| const int | NEWS_TYPE_HALF_YEARLY_REPORT | 23 |
| const int | NEWS_TYPE_CONFIRM_ANNUAL_REPORT_SENT_TO_SECURITY_HOLDERS | 24 |
| const int | NEWS_TYPE_TRUST_6_MONTH_ACCOUNTS | 25 |
| const int | NEWS_TYPE_TRUST_12_MONTH_ACCOUNTS | 26 |
| const int | NEWS_TYPE_LOAN_SECURITIES_ON_ISSUE | 27 |
| const int | NEWS_TYPE_HALF_YEARLY_AUDIT_REVIEW | 28 |
| const int | NEWS_TYPE_HALF_YEARLY_DIRECTORS_STATEMENT | 29 |
| const int | NEWS_TYPE_ASC_ANNUAL_AUDITED_A_CS | 30 |
| const int | NEWS_TYPE_ASX_ANNUAL_AUDIT_REVIEW | 31 |
| const int | NEWS_TYPE_ASX_ANNUAL_DIRECTORS_STATEMENT | 32 |
| const int | NEWS_TYPE_PERIODIC_REPORTS_OTHER | 33 |
| const int | NEWS_TYPE_ASC_HALF_YEARLY_BACKING | 34 |
| const int | NEWS_TYPE_NET_TANGIBLE_ASSET_BACKING | 35 |
| const int | NEWS_TYPE_QUARTERLY_ACTIVITIES_STATEMENT | 36 |
| const int | NEWS_TYPE_FIRST_QUARTER_ACTIVITIES_REPORT | 37 |
| const int | NEWS_TYPE_SECOND_QUARTER_ACTIVITIES_REPORT | 38 |
| const int | NEWS_TYPE_THIRD_QUARTER_ACTIVITIES_REPORT | 39 |
| const int | NEWS_TYPE_FOURTH_QUARTER_ACTIVITIES_REPORT | 40 |
| const int | NEWS_TYPE_QUARTER_ACTIVITIES_REPORT_OTHER | 41 |
| const int | NEWS_TYPE_QUARTERLY_CASHFLOW_STATEMENT | 42 |
| const int | NEWS_TYPE_FIRST_QUARTER_CASHFLOW_REPORT | 43 |
| const int | NEWS_TYPE_SECOND_QUARTER_CASHFLOW_REPORT | 44 |
| const int | NEWS_TYPE_THIRD_QUARTER_CASHFLOW_REPORT | 45 |
| const int | NEWS_TYPE_FOURTH_QUARTER_CASHFLOW_REPORT | 46 |
| const int | NEWS_TYPE_QUARTER_CASHFLOW_REPORT_OTHER | 47 |
| const int | NEWS_TYPE_ISSUED_CAPITAL | 48 |
| const int | NEWS_TYPE_RENOUNCEABLE_ISSUE | 49 |
| const int | NEWS_TYPE_BONUS_ISSUE | 50 |
| const int | NEWS_TYPE_PLACEMENT | 51 |
| const int | NEWS_TYPE_ISSUES_TO_THE_PUBLIC | 52 |
| const int | NEWS_TYPE_NEW_ISSUE_LETTER_OF_OFFER_ACC_FORM | 53 |
| const int | NEWS_TYPE_ALTERATION_TO_ISSUED_CAPITAL | 54 |
| const int | NEWS_TYPE_NONRENOUNCEABLE_ISSUE | 55 |
| const int | NEWS_TYPE_ISSUED_CAPITAL_OTHER | 56 |
| const int | NEWS_TYPE_PROSPECTUS | 57 |
| const int | NEWS_TYPE_ONMARKET_BUYBACK_SCHEME | 58 |
| const int | NEWS_TYPE_DAILY_SHARE_BUYBACK_NOTICE | 59 |
| const int | NEWS_TYPE_ASSET_ACQUISITION_DISPOSAL | 60 |
| const int | NEWS_TYPE_ASSET_ACQUISITION | 61 |
| const int | NEWS_TYPE_ASSET_DISPOSAL | 62 |
| const int | NEWS_TYPE_ASSET_ACQUISITION_DISPOSAL_OTHER | 63 |
| const int | NEWS_TYPE_NOTICE_OF_MEETING | 64 |
| const int | NEWS_TYPE_NOTICE_OF_ANNUAL_GENERAL_MEETING | 65 |
| const int | NEWS_TYPE_NOTICE_OF_EXTRAORDINARY_GENERAL_MEETING | 66 |
| const int | NEWS_TYPE_RESULTS_OF_MEETING | 67 |
| const int | NEWS_TYPE_PROXY_FORM | 68 |
| const int | NEWS_TYPE_ALTERATION_TO_NOTICE_OF_MEETING | 69 |
| const int | NEWS_TYPE_NOTICE_OF_MEETING_OTHER | 70 |
| const int | NEWS_TYPE_NOTICE_OF_GENERAL_MEETING | 71 |
| const int | NEWS_TYPE_STOCK_EXCHANGE_ANNOUNCEMENT | 72 |
| const int | NEWS_TYPE_SUSPENSION_FROM_OFFICIAL_QUOTATION | 73 |
| const int | NEWS_TYPE_REINSTATEMENT_TO_OFFICIAL_QUOTATION | 74 |
| const int | NEWS_TYPE_REMOVAL_FROM_OFFICIAL_LIST | 75 |
| const int | NEWS_TYPE_STOCK_EXCHANGE_QUERY | 76 |
| const int | NEWS_TYPE_NOTICE_PENDING | 77 |
| const int | NEWS_TYPE_CHANGE_IN_BASIS_OF_QUOTATION | 78 |
| const int | NEWS_TYPE_TRADING_HALT | 79 |
| const int | NEWS_TYPE_ADMISSION_TO_OFFICIAL_LIST | 80 |
| const int | NEWS_TYPE_COMMENCEMENT_OF_OFFICIAL_QUOTATION | 81 |
| const int | NEWS_TYPE_STOCK_EXCHANGE_ANNOUNCEMENT_OTHER | 82 |
| const int | NEWS_TYPE_MAP_CANCELLATION | 83 |
| const int | NEWS_TYPE_CAP_CANCELLATION | 83 |
| const int | NEWS_TYPE_MAP_CORRECTION | 84 |
| const int | NEWS_TYPE_CAP_CORRECTION | 84 |
| const int | NEWS_TYPE_DIVIDEND_ANNOUNCEMENT | 85 |
| const int | NEWS_TYPE_DIVIDEND_RECORD_DATE | 86 |
| const int | NEWS_TYPE_DIVIDEND_BOOKS_CLOSING | 86 |
| const int | NEWS_TYPE_DIVIDEND_PAY_DATE | 87 |
| const int | NEWS_TYPE_DIVIDEND_RATE | 88 |
| const int | NEWS_TYPE_DIVIDEND_ALTERATION | 89 |
| const int | NEWS_TYPE_DIVIDEND_OTHER | 90 |
| const int | NEWS_TYPE_PROGRESS_REPORT | 91 |
| const int | NEWS_TYPE_PROGRESS_REPORT_MINOR | 92 |
| const int | NEWS_TYPE_PROGRESS_REPORT_OTHER | 93 |
| const int | NEWS_TYPE_COMPANY_ADMINISTRATION | 94 |
| const int | NEWS_TYPE_DIRECTOR_APPOINTMENT_RESIGNATION | 95 |
| const int | NEWS_TYPE_DETAILS_OF_COMPANY_ADDRESS | 96 |
| const int | NEWS_TYPE_DETAILS_OF_REGISTERED_OFFICE_ADDRESS | 97 |
| const int | NEWS_TYPE_DETAILS_OF_SHARE_REGISTRY_ADDRESS | 98 |
| const int | NEWS_TYPE_TRUSTEE_APPOINTMENT_RESIGNATION | 99 |
| const int | NEWS_TYPE_TRUST_MANAGER_APPOINTMENT_RESIGNATION | 100 |
| const int | NEWS_TYPE_COMPANY_SECRETARY_APPOINTMENT_RESIGNATION | 101 |
| const int | NEWS_TYPE_COMPANY_ADMINISTRATION_OTHER | 102 |
| const int | NEWS_TYPE_CHANGE_OF_BALANCE_DATE | 103 |
| const int | NEWS_TYPE_TRUST_DEED | 104 |
| const int | NEWS_TYPE_ARTICLES_OF_ASSOCIATION | 105 |
| const int | NEWS_TYPE_NOTICE_OF_CALL_CONTRIBUTING_SHARES | 106 |
| const int | NEWS_TYPE_ANNOUNCEMENT_OF_CALL | 107 |
| const int | NEWS_TYPE_NOTICE_OF_CALL_TO_SHAREHOLDERS | 108 |
| const int | NEWS_TYPE_NOTICE_OF_CALL_OTHER | 109 |
| const int | NEWS_TYPE_OTHER | 110 |
| const int | NEWS_TYPE_OTHER_MINOR | 111 |
| const int | NEWS_TYPE_INTERNAL | 112 |
| const int | NEWS_TYPE_APPENDIX_16A | 113 |
| const int | NEWS_TYPE_YEAR_2000_ADVICE | 114 |
| const int | NEWS_TYPE_MAP_TEST | 115 |
| const int | NEWS_TYPE_CAP_TEST | 115 |
| const int | NEWS_TYPE_CHAIRMANS_ADDRESS | 116 |
| const int | NEWS_TYPE_CHAIRMANS_ADDRESS_OTHER | 117 |
| const int | NEWS_TYPE_CHAIRMANS_ADDRESS_TO_SHAREHOLDERS | 118 |
| const int | NEWS_TYPE_LETTER_TO_SHAREHOLDERS | 119 |
| const int | NEWS_TYPE_LETTER_TO_SHAREHOLDERS_OTHER | 120 |
| const int | NEWS_TYPE_LETTER_TO_SHAREHOLDERS_MINOR | 121 |
| const int | NEWS_TYPE_ASX_QUERY | 122 |
| const int | NEWS_TYPE_ASX_QUERY_OTHER | 123 |
| const int | NEWS_TYPE_ASX_QUERY_MINOR | 124 |
| const int | NEWS_TYPE_RESPONSE_TO_ASX_QUERY | 125 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS | 126 |
| const int | NEWS_TYPE_WARRANTS | 126 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS_OTHER | 127 |
| const int | NEWS_TYPE_WARRANTS_OTHER | 127 |
| const int | NEWS_TYPE_WARRANT_REPORT | 128 |
| const int | NEWS_TYPE_CHANGE_IN_ACCOUNTING_POLICY | 129 |
| const int | NEWS_TYPE_ALLOTMENT_OF_SHARES | 130 |
| const int | NEWS_TYPE_CONVERTIBLE_NOTES | 131 |
| const int | NEWS_TYPE_DONT_SELL_NOTICE | 132 |
| const int | NEWS_TYPE_ENTITLEMENT | 133 |
| const int | NEWS_TYPE_EXERCISE_OF_OPTIONS | 134 |
| const int | NEWS_TYPE_INTEREST_PAYMENT | 135 |
| const int | NEWS_TYPE_KEY_TRANSACTION_DETAILS | 136 |
| const int | NEWS_TYPE_MERGER | 137 |
| const int | NEWS_TYPE_MINING_REPORT | 138 |
| const int | NEWS_TYPE_MARKET_SURVEILLANCE_PANEL | 139 |
| const int | NEWS_TYPE_NAME_CHANGE | 140 |
| const int | NEWS_TYPE_NOTICE_OF_RESTRICTED_TRANSFER | 141 |
| const int | NEWS_TYPE_DELISTING | 142 |
| const int | NEWS_TYPE_RESTRUCTURING | 143 |
| const int | NEWS_TYPE_RIGHTS_ISSUE | 144 |
| const int | NEWS_TYPE_STAND_IN_THE_MARKET | 145 |
| const int | NEWS_TYPE_STRIKE_PRICE | 146 |
| const int | NEWS_TYPE_SEATS_IMPORTANT_CA | 147 |
| const int | NEWS_TYPE_SEATS_BROKER | 148 |
| const int | NEWS_TYPE_SEATS_MKT_CONTROL_IMPORTANT_NOTICE | 149 |
| const int | NEWS_TYPE_SEATS_MKT_CONTROL_CA | 150 |
| const int | NEWS_TYPE_SEATS_PURGED_ORDERS | 151 |
| const int | NEWS_TYPE_SEATS_MKT_CONTROL_PRIVATE | 152 |
| const int | NEWS_TYPE_SUPPLEMENTARY_BIDDERS_SIGNATURE | 153 |
| const int | NEWS_TYPE_SUPPLEMENTARY_TARGETS_SIGNATURE | 154 |
| const int | NEWS_TYPE_CONCISE_FINANCIAL_REPORT | 155 |
| const int | NEWS_TYPE_END_OF_DAY | 156 |
| const int | NEWS_TYPE_CONSTITUTION | 157 |
| const int | NEWS_TYPE_RESPONSIBLE_ENTITY_APPOINTMENT_RESIGNATION | 158 |
| const int | NEWS_TYPE_OPEN_BRIEFING | 159 |
| const int | NEWS_TYPE_OVERSEAS_LISTING | 160 |
| const int | NEWS_TYPE_INDEX_WARRANT_INVITATION_TO_SUBSCRIBE | 161 |
| const int | NEWS_TYPE_INDEX_WARRANT_ACCEPTANCE | 162 |
| const int | NEWS_TYPE_COMMITMENTS_TEST_ENTITY_QUARTERLY_REPORTS | 163 |
| const int | NEWS_TYPE_COMMITMENTS_TEST_ENTITY_FIRST_QUARTER_REPORT | 164 |
| const int | NEWS_TYPE_COMMITMENTS_TEST_ENTITY_SECOND_QUARTER_REPORT | 165 |
| const int | NEWS_TYPE_COMMITMENTS_TEST_ENTITY_THIRD_QUARTER_REPORT | 166 |
| const int | NEWS_TYPE_COMMITMENTS_TEST_ENTITY_FOURTH_QUARTER_REPORT | 167 |
| const int | NEWS_TYPE_COMMITMENTS_TEST_ENTITY_QUARTLERY_REPORTS_OTHER | 168 |
| const int | NEWS_TYPE_COMMITMENTS_TEST_ENTITY_OTHER | 168 |
| const int | NEWS_TYPE_INITIAL_DIRECTORS_INTEREST_NOTICE | 169 |
| const int | NEWS_TYPE_CHANGE_OF_DIRECTORS_INTEREST_NOTICE | 170 |
| const int | NEWS_TYPE_FINAL_DIRECTORS_INTEREST_NOTICE | 171 |
| const int | NEWS_TYPE_DAILY_FUND_UPDATE | 172 |
| const int | NEWS_TYPE_APPENDIX_3B | 173 |
| const int | NEWS_TYPE_STANDARD_AND_POORS_ANNOUNCEMENT | 174 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS_ISSUER_REPORT | 175 |
| const int | NEWS_TYPE_WARRANT_ISSUER_REPORT | 175 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS_DISCLOSURE_DOCUMENT | 176 |
| const int | NEWS_TYPE_WARRANT_DISCLOSURE_DOCUMENT | 176 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS_ACCEPTANCE | 177 |
| const int | NEWS_TYPE_WARRANT_ACCEPTANCE | 177 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS_TRUST_DEED | 178 |
| const int | NEWS_TYPE_WARRANT_TRUST_DEED | 178 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS_DISTRIBUTION | 179 |
| const int | NEWS_TYPE_WARRANT_DISTRIBUTION | 179 |
| const int | NEWS_TYPE_STRUCTURED_PRODUCTS_ADJUSTMENT | 180 |
| const int | NEWS_TYPE_WARRANT_ADJUSTMENT | 180 |
| const int | NEWS_TYPE_HALF_YEAR_DIRECTORS_REPORT | 181 |
| const int | NEWS_TYPE_FULL_YEAR_DIRECTORS_REPORT | 182 |
| const int | NEWS_TYPE_AGREEMENT_BETWEEN_ISSUER_AND_DIRECTOR | 183 |
| const int | NEWS_TYPE_AUDIT | 184 |
| const int | NEWS_TYPE_CHANGE_IN_GENERAL_CHARACTER | 185 |
| const int | NEWS_TYPE_COMMERCE_COMMISSION | 186 |
| const int | NEWS_TYPE_CREDIT_RATING_CHANGE | 187 |
| const int | NEWS_TYPE_CHANGE_OF_DIRECTOR | 188 |
| const int | NEWS_TYPE_DISPATCH_NOTICE | 189 |
| const int | NEWS_TYPE_DOMINANT_OFFER | 190 |
| const int | NEWS_TYPE_DUE_DILIGENCE | 191 |
| const int | NEWS_TYPE_FORECAST | 192 |
| const int | NEWS_TYPE_PRELIMINARY_HALF_YEARLY_REPORT | 193 |
| const int | NEWS_TYPE_TRADING_HALT_REQUEST | 194 |
| const int | NEWS_TYPE_ASSET_ACQUISITION_DISPOSAL_ISSUER | 195 |
| const int | NEWS_TYPE_JOINT_VENTURE | 196 |
| const int | NEWS_TYPE_MONTHLY_REPORT | 197 |
| const int | NEWS_TYPE_APPOINTMENT_OF_RECEIVERS | 198 |
| const int | NEWS_TYPE_LODGEMENT_OF_DOCUMENTS_OVERSEAS | 199 |
| const int | NEWS_TYPE_SCHEME_OF_ARRANGEMENT | 200 |
| const int | NEWS_TYPE_SECURITIES_COMMISSION | 201 |
| const int | NEWS_TYPE_SUBSTANTIAL_SHAREHOLDER_NOTICE | 202 |
| const int | NEWS_TYPE_OVERSEAS_SUBSTANTIAL_SHAREHOLDER_NOTICE | 203 |
| const int | NEWS_TYPE_UNDER_OR_OVER_SUBSCRIPTIONS | 204 |
| const int | NEWS_TYPE_TAKEOVER_PANEL | 205 |
| const int | NEWS_TYPE_TRADING_HALT_LIFTED | 206 |
| const int | NEWS_TYPE_PRELISTING | 207 |
| const int | NEWS_TYPE_DISCIPLINARY | 208 |
| const int | NEWS_TYPE_WAIVER_RULING | 209 |
| const int | NEWS_TYPE_WARRANT_SUPPLEMENTARY_DISCLOSURE_DOCUMENT | 210 |
| const int | NEWS_TYPE_CAPITAL_RECONSTRUCTION | 211 |
| const int | NEWS_TYPE_TRADING_POLICY | 212 |
| const int | NEWS_TYPE_DAIRY | 213 |
| const int | NEWS_TYPE_APPENDIX_7 | 214 |