Entwickler-Example

TPRAccess Schnittstelle – Entwicklerdokumentation

Quick Start

Download

Laden Sie zunächst die benötigte DLL herunter:

TPRAccess.dll herunterladen

Entpacken Sie anschließend die Datei TPRAccess.zip.

Einbindung der DLL-Schnittstelle

Projekt-Konfiguration (.NET Core)

Verwendung

Nach erfolgreicher Einbindung können Sie die Schnittstelle wie folgt verwenden:

using TPRAccess;
                                                

Verbindung & Login

TPRClientLanguages

connection.ClientLanguage = TPRClientLanguages.German;

TPRServerConnection

Das Objekt TPRServerConnection initialisiert die Verbindung zur API und stellt sämtliche Kernfunktionen der Schnittstelle bereit.

Ohne gültige Developer-ID kann keine Verbindung aufgebaut werden.

Login

Die Methode Login meldet den Benutzer am Tai-Pan-Server an und initialisiert die Sitzung für weitere API-Aufrufe.

bool ok = connection.Login(string "CustomerID", string">"Password");
                                                                        

bool Login(string customerId, string password)

Parameter Rückgabe Fehlerursachen

Client-Information

Mit GetConnectionClientInfo können Informationen zur verwendeten Client- bzw. DLL-Version ausgelesen werden.

Parameter Rückgabe Eigenschaften

Benutzerdaten

GetUserInfo

var userInfo = connection.GetUserInfo();

Signatur

TPRUserInfo GetUserInfo()

Rückgabe

TPRUserInfo

Das Objekt TPRUserInfo stellt benutzerspezifische Informationen, Benachrichtigungseinstellungen sowie verfügbare Sammlungen wie Watchlists, Börsen und Abonnements bereit.

Daten Sammlungen

Katalogstruktur

Mit GetCatalogStructure kann die vollständige Katalogstruktur mit Ordnern und Einträgen geladen werden. Kataloge bilden dabei eine Ordnerstruktur von Wertpapieren nach Börsen, Märkten oder Themenbereichen ab. Die Methode liefert sowohl die hierarchische Struktur als auch direkten Zugriff auf alle enthaltenen Ordner- und Katalogobjekte.

var entries = new List();
                var folders = new Dictionary();
                var items = new Dictionary();
                                                                        
                connection.GetCatalogStructure(ref entries, ref folders, ref items);
                

GetCatalogStructure Signatur

bool GetCatalogStructure(
                        		  ref List entries,
                        		  ref Dictionary folders,
                        		  ref Dictionary items
                                    )

Parameter Rückgabe

Suche

Die Search-Funktion ermöglicht die Suche nach Wertpapieren über unterschiedliche Suchtypen wie Symbol, ISIN, Name oder interne Kennungen. Zusätzlich kann die Suche auf bestimmte Wertpapierarten und Börsen eingeschränkt werden.

TPRSearchTypes

Search

var result = connection.Search(
                        			TPRSearchTypes.Name,
                        			string "Daimler",
                        			TPRSecurityType.All.Id,0
                                	     );
                        

Signatur

TPRSymbolList Search(
                                  TPRSearchTypes searchType,
                        	      string searchText,
                        	      int securityTypeId,
                        	      int exchangeId
                                )

Parameter Rückgabe

TPRSecurityType

Watchlists

Mit den Watchlist-Funktionen können persönliche Beobachtungslisten erstellt, verwaltet und geladen werden. Wertpapiere lassen sich dabei einzeln, gesammelt oder direkt aus Suchergebnissen zu einer Watchlist hinzufügen.

---

AddWatchList

Erstellt eine neue Watchlist.

Signatur

TPRWatchList AddWatchList(string name)

Parameter Rückgabe Beispiel

var watchlist = userInfo.WatchLists.AddWatchList(string "Meine Watchlist");

---

Add (Einzelnes Instrument)

Fügt ein einzelnes Instrument zur Watchlist hinzu.

Beispiel

watchlist.Add(169286);

Signatur

void Add(int symbolNo)

Parameter

---

Add (Mehrere Instrumente)

Fügt mehrere Instrumente gleichzeitig zur Watchlist hinzu.

Beispiel

watchlist.Add(new List<int> {169286, 79514});

Signatur

void Add(List<int> symbolNumbers)

Parameter

---

Add (Aus Suchergebnis)

Übernimmt alle Instrumente aus einer Trefferliste in die Watchlist.

Beispiel

watchlist.Add(result);

Signatur

void Add(TPRSymbolList symbols)

Parameter

---

GetWatchListContent

Lädt den Inhalt einer Watchlist.

Beispiel

var entries = connection.GetWatchListContent(watchlist.Id);

Signatur

TPRSymbolList GetWatchListContent(int watchListId)

Parameter Rückgabe

---

DeleteWatchList

Löscht eine bestehende Watchlist.

Beispiel

userInfo.WatchLists.DeleteWatchList(watchlist.Id);

Signatur

bool DeleteWatchList(int watchListId)

Parameter Rückgabe

Realtime Push-Feed

Der Realtime Push-Feed ermöglicht den Empfang von Echtzeitdaten und Push-Nachrichten für abonnierte Wertpapiere. Instrumente können dynamisch abonniert oder entfernt werden, während neue Feed-Nachrichten fortlaufend ausgelesen werden können.

Verarbeitung von Feed-Nachrichten - Codebeispiel

TPRPushFeedMessage pfm = m_PushFeed.GetNextPushFeedMessage();
            if (pfm != null)
            {
                do
                {
                    switch (pfm.MessageType)
                    {
                        case TPRPushFeedMessageTypes.Quote:
                            var TickMessage = pfm as TPRQuoteTickMessage;
                            
                            switch (TickMessage.QuoteType)
                            {
                                case TPRQuoteTypes.Ask:
                                    // TickMessage.QuoteTick.Quote
                                    // TickMessage.QuoteTick.Volume
                                    // TickMessage.QuoteTick.Time
                                    break;
                                case TPRQuoteTypes.Last:
                                    // TickMessage.QuoteTick.Quote
                                    // TickMessage.QuoteTick.Volume
                                    // TickMessage.QuoteTick.Time
                                    break;
                                case TPRQuoteTypes.Bid:
                                    // TickMessage.QuoteTick.Quote
                                    // TickMessage.QuoteTick.Volume
                                    // TickMessage.QuoteTick.Time
                                    break;
                                case TPRQuoteTypes.OFF_MARKET:
                                    // TickMessage.QuoteTick.Quote
                                    // TickMessage.QuoteTick.Volume
                                    // TickMessage.QuoteTick.Time
                                    break;
                                case TPRQuoteTypes.Auction:
                                    // TickMessage.QuoteTick.Quote
                                    // TickMessage.QuoteTick.Volume
                                    // TickMessage.QuoteTick.Time
                                    break;
                                case TPRQuoteTypes.OpenInterest:
                                    // TickMessage.QuoteTick.Quote
                                    // TickMessage.QuoteTick.Volume
                                    // TickMessage.QuoteTick.Time
                                    break;
                            }
                            break;
                        case TPRPushFeedMessageTypes.MarketDepth:
                            var MarketDepthMessage = pfm as TPRMarketDepthMessage;
                            
                            // MarketDepthMessage.QuoteTick.Quote
                            // MarketDepthMessage.QuoteTick.Time
                            // MarketDepthMessage.QuoteTick.Volume
                            // MarketDepthMessage.QuoteType
                            // MarketDepthMessage.Position
                            break;
                    }
                    m_PushFeed.ReturnFeedMessage(pfm);   // Speicher freigeben
                    pfm = m_PushFeed.GetNextPushFeedMessage();  
                } while (pfm != null);
            }
            

GetPushFeed

Erzeugt ein TPRPushFeed-Objekt für den Empfang von Realtime-Nachrichten.

Signatur

TPRPushFeed GetPushFeed()

Rückgabe Initialisierung

var feed = connection.GetPushFeed();
            feed.ConnectFeed();

---

SubscribeSymbol

Abonniert Realtime-Daten für ein einzelnes Instrument.

Beispiel

feed.SubscribeSymbol(169286);

Signatur

bool SubscribeSymbol(int symbolNo)

Parameter Rückgabe

---

SubscribeSymbol (Mehrere Instrumente)

Abonniert Realtime-Daten für mehrere Instrumente gleichzeitig.

Beispiel

feed.SubscribeSymbol(new List<int> {169286, 79514});

Signatur

bool SubscribeSymbol(List<int> symbolNumbers)

Parameter Rückgabe

---

UnsubscribeSymbol

Entfernt ein bestehendes Realtime-Abonnement.

Beispiel

feed.UnsubscribeSymbol(169286);

Signatur

bool UnsubscribeSymbol(int symbolNo)

Parameter Rückgabe

---

GetNextPushFeedMessage

Liest die nächste verfügbare Feed-Nachricht aus.

Beispiel

var msg = feed.GetNextPushFeedMessage();

Signatur

TPRPushFeedMessage GetNextPushFeedMessage()

Rückgabe TPRQuoteTypes (Kursarten)

TPRPushFeedMessageTypes

Beenden

feed.DisconnectFeed();

Candle Charts

Mit GetCandleChart können historische Candle- bzw. Kursdaten für ein Wertpapier geladen werden. Dabei lassen sich Tagesdaten oder komprimierte Zeitintervalle wie Minutenkerzen abrufen.

GetCandleChart

Verfügbare Overloads

TPRCandleList GetCandleChart(int symbolNo, DateTime from)
                TPRCandleList GetCandleChart(int symbolNo, int compression, int count)
                TPRCandleList GetCandleChart(int symbolNo, int compression, DateTime from)
                

Parameter Rückgabe Tagesdaten

var candles = connection.GetCandleChart(169286, DateTime.Now.AddDays(-10));

Minuten

var candles = connection.GetCandleChart(169286, 15, DateTime.Now.AddDays(-10));

Anzahl

var candles = connection.GetCandleChart(169286, 12, 42);

Intraday Charts

Mit GetIntradayChart können Intraday-Kursdaten und Tickdaten für Wertpapiere geladen werden. Dabei können verschiedene Kursarten wie Last-, Bid- oder Ask-Kurse sowie unterschiedliche Zeiträume und Detailstufen abgefragt werden.

Overloads

TPRQuoteTickList GetIntradayChart(int symbolNo, DateTime from) 
        TPRQuoteTickList GetIntradayChart(int symbolNo, DateTime from, int dayCount)
        bool GetIntradayChart(int symbolNo, DateTime from, out TPRQuoteTickList last, out TPRQuoteTickList ask, out TPRQuoteTickList bid, int dayCount)
        TPRQuoteTickList GetIntradayChart(SymbolNo startDate, DateTime endDateThisLoad, TPRQuoteTypes quoteType)
                

Parameter TPRQuoteTypes (Kursarten) Rückgabe Einfach

var ticks = connection.GetIntradayChart(169286, DateTime.Now.AddDays(-1));

Mit Bid/Ask

TPRQuoteTickList last, ask, bid;
                connection.GetIntradayChart(169286, DateTime.Now.AddDays(-3), out last, out ask, out bid, 1);

Mit QuoteType

var ticks = connection.GetIntradayChart(169286, DateTime.Now.AddDays(-1), DateTime.Now, TPRQuoteTypes.last);

Markttiefe

Mit GetMarketDepth kann die aktuelle Markttiefe ( Level 2 ) eines Instruments abgerufen werden. Dabei stehen die Kauf- und Verkaufsseite des Orderbuchs inklusive Preis- und Volumeninformationen zur Verfügung.

var depth = connection.GetMarketDepth(169286);

Signatur

TPRMarketDepth GetMarketDepth(int symbolNo)

Parameter Rückgabe Ask

foreach (var a in depth.Ask)
                {
                          var price = a.Quote;
                }
                

Bid

foreach (var b in depth.Bid)
                {
                          var price = b.Quote;
                }
                

Options Matrix

Mit GetOptionsMatrix kann die strukturierte Optionsmatrix eines Basiswerts geladen werden. Die Matrix enthält verfügbare Optionen und Optionsscheine inklusive Laufzeiten, Basispreisen und weiterer Marktdaten.

var matrix = connection.GetOptionsMatrix(169286);

Signatur

TPROptionsMatrix GetOptionsMatrix(int symbolNo)

Parameter Rückgabe

Objekte

TPRSymbol

TPRCandle

TPRQuoteTick

Hinweise