Auto Trade API Guide A S S E T M A N A G E M E N T P R O J E C T. Verze 1.9 Česky

Transkript

1 Auto Trade API Guide A S S E T M A N A G E M E N T P R O J E C T Verze 1.9 Česky

2 II Copyright 2011 Faunus Analytics LLC. Všechna práva vyhrazena. Daný dokument je majetkem společnosti Faunus Analytics. Kopírování, reprodukce a publikace v jakékoliv podobě (včetně za účelem získání komerční výhody) dokumentu jako celku nebo jeho části je bez písemného souhlasu držitele práv zakázáno. Všechny otázky, tykající se tohoto dokumentu a v něm uvedených informací můžete konzultovat prostřednictvím využití elektronické pošty info@faunusanalytics.com nebo telefonních čísel (Moskva) nebo (Praha). Microsoft Windows, Windows Installer registrované obchodní značky Microsoft Corporation. MetaTrader registrovaná obchodní značka MetaQuotes Sowtware Corporation. Jiné obchodní značky a pojmenování produktů jsou majetkem jejích příslušných vlastníků.

3 III Obsah 1. OBECNÉ INFORMACE OMEZENÍ Podmínky poskytování služeb Podporované operační systémy Požadavky vůči obchodní platformě Architektura Faunus Auto Trade API INSTALACE KLIENTSKÝCH KOMPONENT Standardní proces instalace ZAPOJENÍ DISTRIBUČNÍHO KANÁLU API NASTAVENÍ AUTO TRADE API Autorizační data Konfigurační data FORMÁT DAT MONITORING STAVU A VYŘEŠENÍ PROBLÉMŮ Obecné informace ohledně monitoringu Možné problémy a jejích řešení... 11

4 IV 1. OBECNÉ INFORMACE Produkt Faunus Auto Trade API je určen pro integraci obchodních platforem a služeb Obchodní signály. Produkt se skládá z klientské a serverové části. Výměna dat se provádí prostřednictvím protokolu https. Celková síťový trafik mezi klientskou a serverovou úrovni je spolehlivě zajištěn proti přístupům externích osob prostřednictvím technologie SSL (Secure Sockets Layer). 2. OMEZENÍ 2.1 Podmínky poskytování služeb Pro zahájení používání služeb je pro uživatele potřeba: 1. Zaregistrovat se na webových stránkách projektu 2. Přihlásit se ke službě «Obchodní signály» anebo Indikátory 3. V seznamu kanálů označit «Auto Trade API» 4. Nainstalovat klientské komponenty Faunus Auto Trade API 2.2 Podporované operační systémy V současné verzi fungují klientské komponenty jenom na platformě Microsoft Windows. Byly testovány verze Win 2000, Win 2003 Server, XP, Vista, Win 7. S jinými operačními platformami je možná síťová výměna(viz Nastavení Konfigurační data). 2.3 Požadavky vůči obchodní platformě Obchodní platforma musí podporovat možnost rozšíření uživatelskými a vnějšími komponenty. Například, MetaTrader podporuje rozšíření modulů typu poradce (jiný název expert ), program, který může být popsán výchozím programovacím jazykem MQL. Prostředky programování obchodní platformy musí umožňovat přístup ke čtení a zpracování vnějších datových souborů.

5 2.4 Architektura Faunus Auto Trade API

6 Produkt se skládá ze serverové a z klientské části. Klientská část se skládá ze sady komponent. Komponent WEB-terminal Data Loader zajišťuje přenos dat o obchodních signálech a indikátorech ze serverů Faunusu (prostřednictvím servisu WEB-terminal) a uložení dat do speciálního souboru. Soubory obchodních signálů a indikátorů jsou mezerovou schránkou přenosu dat mezi komponenty Faunus Auto Trade API a obchodní platformou. Umístění a pojmenování souborů obchodních signálů a indikátorů se zadává uživatelem. Struktura souborů je popsána v sekci Formát dat. Komponent SysTray zabezpečuje součinnost s uživatelem. Vytváří interaktivní ikonu v oblastní systémového trea, odráží menu a parametry změn nastavení. Moderní obchodní platformy umožňují vytvoření uživatelských obchodních robotů programů automatického obchodování nebo analytického zpracování tržních dat. Kromě zpracování dat se mohou roboti vytvářet pro import dat ze vnějších systémů. Předpokládá se, že právě pomocí programových rozšíření obchodních platforem bude organizován přenos dat z bufferových (schránkových) souborů a jejich transformace do příkazů k obchodnímu serveru brokera. Pro některé populární obchodní platformy existuje již hotová řešení (viz MT4 Integration Guide, MT5 Integration Guide). 3. INSTALACE KLIENTSKÝCH KOMPONENT 3.1 Standardní proces instalace Instalační soubor je projektem instalace pro Windows Installer. Instalační soubor poslední verze můžete vždy najít zde. Jakékoliv změny v rámci kanálu Auto Trade API se zveřejňují v sekci zpráv. Stahujeme a spouštíme instalační soubor Faunus Auto Trade API.msi.

7 Instalace se musí provádět uživatelem, který má práva lokálního administrátora. I Souhlasíme s výchozí složkou instalace nebo měníme je a zmáčkněme «Next».

8 II Zmáčkněme «Install».

9 III Uvádíme nastavení (viz sekci «Nastavení Konfigurační data» a Nastavení Autorizační data). V budoucnu lze tato nastavení měnit. Uvádíme autorizační data (viz sekci Nastavení nastavení měnit. Autorizační data). V budoucnu lze tato Po ukončení instalace v menu «Start Programy» se vytváří složka «Faunus Analytics \ Faunus Auto Trade API», obsahující dokumentaci, symbol spuštění SysTray a uninstall master nainstalovaných komponent.

10 IV Před instalaci nové verze API, odinstalujte předchozí verzi s použitím systémového průvodce. 4. ZAPOJENÍ DISTRIBUČNÍHO KANÁLU API Pro získávání obchodních signálů přes distribuční kanál Auto Trade API, je potřeba tento kanál aktivovat. To lze provést v Osobním profilu Osobní profil Nastavení rozesílání. 5. NASTAVENÍ AUTO TRADE API Nastavení určují autorizační data a nastavení přenosu dat Faunus.. Nastavení lze zadávat na etapu instalace (viz sekci Nastavení klientských komponent ) nebo po instalaci. Pro změnu nastavení po instalaci je potřeba najít symbol Faunus v systémovém treu. Kliknout na symbolu pravým tlačítkem myši, objeví se kontextové menu

11 V V nově zobrazeném kontextovém menu zvolit «Settings». 5.1 Autorizační data Autorizační data se určují jménem uživatele a heslem. Jméno uživatele a heslo musí být v souladu s uvedenými při registraci na webových stránkách projektu hodnotami. Autorizační data jsou uložena na počítači uživatele v zašifrované podobě. Nicméně doporučujeme nainstalovat a včas obnovovat prostředky počítačové bezpečnosti.

12 VI 5.2 Konfigurační data V daném nastavení musí uživatel ve standardním režimu pouze měnit cestu ke cachesouboru. Do cache-souborů se ukládají všechny aktuální obchodní signály a indikátory ze serveru Faunus. Právě tyto soubory musí být přečteny v prostředí obchodní platformy pro převod obchodních signálů a indikátorů do operací s obchodními ordery \ pozicemi. Tyto soubory mohou být rozmístěny v jakémkoliv místě souborového systému umožňujícího aktualizaci souborů. To může být složka lokálního souborového systému, síťová složka, ftp-katalog. Na obrázku níže je uveden příklad standardní složky pro obchodní platformu Meta Trader 5 v operačním systému Windows XP. Pozor! Cesta k souboru se musí odkazovat na existující strukturu složek souborového systému. Systém se nebude pokoušet o vytvoření neexistujících složek!

13 VII Můžete nastavit cesty souborového systému samostatně. Také můžete využit funkcí automatické konfigurace pro obchodní platformu MetaTrader. Podle možností se doporučuje využívat prostředků automatického nastavení. V případě úspěšného splnění automatického nastavení, budou všechny potřebné komponenty integrace s obchodní platformou také nainstalovány. Bez automatického nastavení bude potřeba komponenty integrace s obchodní platformou nainstalovat zvlášť. (viz Faunus AutoTrade for MT4, Faunus AutoTrade for MT5). Pozor! Funkce automatické konfigurace automatizuje nastavení API a jeho integraci s vybranou obchodní platformou. Funkce automatické konfigurace může trvat podstatně dlouho v závislosti na výkonu vašeho počítače a souborového systému. Pří normálním fungování systému budou soubory vytvořeny v uvedené složce souborového systému automaticky, za nějaký čas po ukončení instalace (normálně v průběhu 5 až 10 minut při existenci stabilního připojení), při první zádosti obchodních signálů a indikátorů. Za název souboru lze používat jakékoliv podporované operačním systémem a očekávané obchodní platformou názvy (viz sekci Integrace s obchodními platformami na příkladě MetaTrader 5 ). Formát souboru je popsán v sekci Formát dat. Výchozí jméno souboru odpovídá jménu očekávanému podle výchozího nastavení hotovými integračními řešeními. (viz Faunus AutoTrade for MT4, Faunus AutoTrade for MT5).

14 VIII 6. FORMÁT DAT Pro uchování dat o obchodních signálech se používá textový soubor CSV-formátu a kódováním ANSI. Číselné údaje se poskytují v podobě desetinného zlomku, kde se jako oddělovač celé a zlomkové části používá tečka. OBCHODNÍ SIGNÁLY Záhlaví sloupce Popis Možný význam ORDER_NUMBER SYMBOL ORDER_TYPE EVENT_TYPE LOCAL_EVENT_ TIME UTC_EVENT_TIME SL TP Unikátní číslo obchodního orderu v systému Faunus Pojmenování obchodního nástroje orderu Typ orderu. Systém podporuje ordery na nákup a prodej podle současné tržní ceny. Typ operací s orderem Čas vytvoření obchodního signálu v časovém pásmu uživatele Čas vytvoření obchodního signálu UTC Stop loss úroveň orderu Take profit úroveň orderu Celé číslo Pro nástroje Forex se používá XXXYYY. XXX a YYY to jsou třípísmenové kódy (standard ISO-4217) základní měny/kovu a kotované měny patřičně. Pro jiné trhy se uvádí standardní textový kód obchodního nástroje. BUY, SELL OPEN otevřít MODIFY změnit parametry TP uzavřít podle take profit SL uzavřít podle stop loss CLOSE uzavřít order YYYY-MM-DD hh:mm:ss YYYY-MM-DD hh:mm:ss Číslo v podobě desetinného zlomku. Nebo «-» pokud není zadáno. Číslo v podobě desetinného zlomku. Nebo «-» pokud není zadáno.

15 VOLUME LOT_SIZE TRADE_ACCOUNT_CUR RENCY TRADE_ACCOUNT_STA RT_BALANCE TRADE_ACCOUNT_SET TINGS_TYPE LIFETIME REMAINING_ LIFETIME ORDER_ EXPIRATION Objem orderu v podobě počtu lotů. Očekávaná výše jednoho lotu (obchodního kontraktu). Jednotka měření se určuje podle následujících pravidel. Pro měnové páry počet jednotek základní měny obchodního páru. Například, pro EUR\USD počet euro. Pro kovy množství trojských uncí. Pozor! Příklad integrace s obchodním terminálem může fungovat chybně, pokud broker využívá jako vyměřovací jednotky derivované peněžní jednotky (například centy místo dolarů). Očekávaná měna obchodního účtu uživatele. Očekávaná bilance obchodního účtu uživatele. V případě, že reálná bilance je menší/větší očekávané, je potřeba zvyšovat / snižovat parametr VOLUME. Způsob určování očekávaných obchodních podmínek uživatele. Přípustné zpoždění mezi vytvořením a použitím obchodního signálu na vytvoření nebo změnu orderu v minutách Zbývající čas přípustný čas zpoždění mezi vytvořením a použitím obchodního signálu na otevření nebo změnu orderu, v minutách Maximálně přípustný čas udržení orderu v otevřeném stavu od okamžiku otevření IX Číslo v podobě desetinného zlomku. Nebo «-» pokud není zadáno. Číslo v podobě desetinného zlomku. Třípísmenný kód standardu ISO Celé číslo. Může být zadáno uživatelem v Osobním profilu DEFAULT určeno systémem MANUAL zadáno uživatelem v Osobním profilu Celé číslo. Hodnota se zadává uživatelem v osobním profilu. Celé číslo. Znamená, že čas vypršel Celé číslo

16 X posledních modifikací orderu, v minutách INDIKÁTORY Záhlaví sloupce Popis Možný význam SYMBOL DIRECT LEVEL LOCAL_TIME Pojmenování obchodního nástroje, pro který je indikátor vytvořen Indikátorem prognózovaný směr změny ceny Úroveň spolehlivosti prognózy dle 10 bodové gradace Čas vytvoření indikátoru v časovém pásmu uživatele Pro nástroje Forex se používá XXXYYY. XXX a YYY to jsou třípísmenové kódy (standard ISO-4217) základní měny a kotované měny patřičně. Pro jiné trhy se uvádí standardní textový kód obchodního nástroje. INCREASE, DECREASE Celé číslo od 1 do 10 YYYY-MM-DD hh:mm:ss UTC_TIME Čas vytvoření indikátoru UTC YYYY-MM-DD hh:mm:ss 7. MONITORING STAVU A VYŘEŠENÍ PROBLÉMŮ 7.1 Obecné informace ohledně monitoringu Při normálním fungování komponent se v systémovém treu odráží symbol normálního fungování zelené barvy. V případě vzniku chyb nebo absence spojení se serverem, se symbol stává červeným. Krátký popis problému lze získat navedením myši na symbol a počkáním na zobrazení kontextové nápovědy.

17 XI Detailnější data o chybách v komponentech Faunus lze získat v systémovém záznamu aplikace OS MS Windows. V případě vzniku problému se doporučuje přiložit kopii systémového záznamu k dopisu do služby technické podpory. 7.2 Možné problémy a jejích řešení Níže je seznam nejčastějších problémů, vznikajících při používání Auto Trade API. Před tím, než se obrátit na službu technické podpory, doporučujeme si pokusit o samostatné vyhledání řešení (další informace lze najít v sekci FAQ). Popis chyby nastavení Není zapojen distribuční kanál Auto Trade API Není přihlášení ke službě Obchodní signály Není přihlášení ke službě Indikátory Standardní řešení V Osobním Profilu v sekci Nastavení rozesílání označit distribuční kanál Auto Trade API a uložit nastavení. V Osobním Profilu na webových stránkách projektu otevřít sekci moje služby. Ve vložce Obchodní signály označit potřebné pozice a uložit nastavení. V Osobním Profilu na webových stránkách projektu otevřít sekci moje služby. Ve vložce Indikátory označit potřebné pozice a uložit nastavení.

18 XII Je nutné ve formě nastavení opravit autorizační údaje (viz sekci NASTAVENÍ AUTO TRADE API v tomto dokumentu) Jsou uvedeny chybné autorizační údaje (login, heslo). Je uvedeno chybné rozmístění cashsouboru. Při nastavení produktu byla uvedená neexistující cesta k nalezení souboru, nepřípustné operačním systémem jméno souboru anebo obchodní platforma očekává nové rozmístění cashsouboru. Přesvědčit se, že se používají správná autorizační data. Pokud podle uvedených údaje nelze se přihlásit do Osobního Profilu na webových stránkách projektu, to znamená, že autorizační data jsou chybná. V tomto případě je nutné využit služby obnovení hesla. Je nutné se ve formě nastavení přesvědčit o tom, zda je uvedeno korektní rozmístění cash-souboru. Při nutnosti je potřeba to opravit a uložit. (viz sekci NASTAVENÍ AUTO TRADE API v tomto dokumentu) Ohledně ostatních problémů je nutné kontaktovat službu technické podpory. Pro urychlení procesu řešení problému je doporučeno přiložit k u obsah seznamu událostí operačního systému v podobě souboru. Zde lze najít popis seznamu událostí (Event Log) a způsobů uložení.