mforex API dokumentacja protokołu WebSockets wersja 0.9.7

Transkrypt

1 mforex API dokumentacja protokołu WebSockets wersja 0.9.7

2 WSTĘP 3 OGÓLNE 3 SERWERY 3 GODZINY HANDLU 3 FORMAT DANYCH 4 DEFINICJE 4 DATA I CZAS 4 OGÓLNE ZASADY OBSŁUGI KOMUNIKATÓW 4 PROTOKÓŁ 5 STRUKTURA PAKIETU 5 INFORMACJE OGÓLNE 5 MODEL ZAPYTANIE-ODPOWIEDŹ 5 MODEL STRUMIENIOWY 5 KOMUNIKATY 6 KOMUNIKATY PROTOKOŁU ZAPYTANIE-ODPOWIEDŹ 6 KOMUNIKATY PROTOKOŁU STRUMIENIOWEGO 22 TYPY WYLICZENIOWE 25 2

3 WSTĘP Ogólne Niniejszy dokument zawiera opis protokołu używanego podczas komunikacji użytkownika z serwerem transakcyjnym. Komunikaty wysyłane są przy użyciu formatu JSON. Dzięki mforex API użytkownicy zyskują programistyczny dostęp do danych rynkowych (zarówno bieżących, jak i historycznych) aktualnego stanu rachunku oraz systemu transakcyjnego mforex. Serwery Serwery API są dostępne pod poniższymi adresami: REAL: wss://real.api.mforex.pl:443/ DEMO: wss://demo.api.mforex.pl:443/ Komunikacja z serwerem realnym prowadzona jest przy pomocy szyfrowanego połączenia (SSLv3). Wersje SSL starsze niż v3 nie są obsługiwane. Godziny handlu Handel walutami rozpoczyna się w niedzielę o godzinę 23:00 i trwa nieprzerwanie przez cały tydzień, aż do godziny 22:00 w piątek. Pozostałe instrumenty handlowane są w różnych godzinach, zależnie od czasu trwania sesji instrumentu bazowego i zmian czasu w poszczególnych krajach. Godziny handlu dla wszystkich instrumentów podane są w specyfikacji instrumentów. Serwer API przyjmuje połączenia niezależnie od godzin handlu przez 24 godziny na dobę, 7 dni w tygodniu. W szczególności, poza sesją możliwe jest logowanie oraz np. pobranie historycznych danych rynkowych. 3

4 FORMAT DANYCH Definicje JavaScript Object Notation (JSON) jest lekkim, niezależnym od konkretnego języka, tekstowym formatem wymiany danych. JSON może reprezentować cztery typy pierwotne (łańcuchy znaków, liczby, wartości logiczne i literał pusty) oraz dwa typy złożone (obiekty i tablice). Format ten jest szczegółowo opisany w dokumencie RFC Data i czas Czas przechowywany jest jako liczba milisekund, które upłynęły od pierwszego stycznia 1970 roku. Ogólne zasady obsługi komunikatów W celu zapewnienia najwyższej jakości świadczonych usług na użytkowników nałożony został szereg ograniczeń: Z API mogą korzystać tylko uprawnieni użytkownicy dalej zwani jako UU. Jeżeli użytkownik nie zostanie zidentyfikowany jako UU, otrzyma on pakiet z błędem przy próbie logowania. Jeżeli po ustanowieniu połączenia UU nie zaloguje się w przeciągu 5 sekund, połączenie zostanie przerwane. Jeżeli UU wyśle wiadomość, która nie będzie rozpoznana przez serwer, połączenie zostanie przerwane Każdy UU posiada ograniczą liczbę wiadomości, które może wysłać w przeciągu minuty. Po przekroczeniu limitu wiadomości użytkownik zostanie rozłączony. Każdy wysłany przez UU pakiet nie powinien przekraczać 4096 B. 4

5 PROTOKÓŁ Struktura Pakietu Każdy pakiet jest pojedynczym, nienazwanym obiektem JSON, którego pierwszym polem jest łańcuch znaków o nazwie type identyfikujący typ wiadomości. Aby uniknąć błędów podczas serializacji/deserializacji pakietów protokół jest wersjonowany. Więcej informacji o wersjonowaniu znajduje się opisie komunikatu LoginRequestPacket. Jeżeli klient wysyłać będzie nieobsługiwane komunikaty zostanie automatycznie rozłączony. Informacje ogólne Komunikacja z serwerem przeprowadzana jest w dwóch modelach: zapytanie odpowiedź komunikacji strumieniowej Model zapytanie-odpowiedź W rzeczonym modelu komunikacja inicjowana jest przez użytkownika. Każdemu zapytaniu z sufiksem request przypisana jest odpowiedź z sufiksem response zawierająca liczbę z przedziału zdefiniowanego w typie wyliczeniowym APIErrorCode przechowującą kod rezultatu zapytania oraz pole typu logicznego Status informujące czy zapytanie zakończyło się sukcesem. Zarówno pakiet typu request jak i response zawiera pole RequestId które pozwala na dobranie je w pary. Wartość przechowywana w polu RequestId powinna 1 być unikatowa dla każdej pary. UWAGA: Wyjątkiem od powyższej reguły jest wiadomość LoginRequestPacket, która rezultat zapytania przechowuje jako typ wyliczeniowy LoginStatusw polu o tej samej nazwie. Model strumieniowy W tym modelu komunikacja jest inicjowana przez serwer. Komunikaty TickPacket, MarginLevelPacket oraz TradeUpdatePacket wysyłane są do wszystkich połączonych użytkowników, bez konieczności rejestracji. Wyjątkiem jest komunikat TickPacket, który wymaga wcześniejszej rejestracji przy użyciu komunikatu TickRegistrationRequestPacket. UWAGA: Komunikat MarginLevelPacket wysyłany jest jedynie przy zmianie Poziomu Zabezpieczenia tj. wyniku ilorazu Salda Rejestru Operacyjnego (Equity) i Wymaganego Depozytu Zabezpieczającego (Margin). W szczególności MarginLevelPacket nie będzie wysłany, jeżeli użytkownik nie posiada otwartych pozycji. W takim przypadku w celu otrzymania aktualnego Poziomu Zabezpieczenia należy skorzystać z protokołu zapytanie-odpowiedź i komunikatu MarginLevelRequestPacket. 1 powinna tj. niespełnienie tego warunku nie jest błędem, jednak powoduje, że poprawne przypisanie odpowiedzi do zapytania może być niemożliwe. 5

6 Komunikaty Komunikaty protokołu zapytanie-odpowiedź 1. LoginRequestPacket Pakiet umożliwiający zalogowanie się użytkownikowi do serwera. Pakiet ten jest jedynym dopuszczalnym komunikatem, jaki może wysłać klient po nawiązaniu połączenia. RequestId Unikalny identyfikator komunikatu Login Login użytkownika Password String Hasło użytkownika MajorProtocolVersion Znaczący numer wersji protokołu MinorProtocolVersion Nieznaczący numer wersji protokołu "type : "login", "requestid" : 0, "login" : , "password" : "pass" "majorprotocolversion" : 0, "minorprotocolversion" : 97, 2. LoginResponsePacket Pakiet zwracający informacje o rezultacie logowania użytkownika. RequestId Identyfikator zawarty w pakiecie LoginRequestPacket Login Login użytkownika LoginStatus LoginStatus Kod rezultatu procesu logowania (LoginStatus) "type" : "login", "requestid" : 0, "login" : , "loginstatus" : 0 3. LogoutRequestPacket Pakiet zawierający żądanie wylogowania użytkownika. Pakiet ten powinien być wysłany przed rozłączeniem się sesji użytkownika. Serwer po otrzymaniu pakietu w odpowiedzi zrywa połączenie bez odesłania potwierdzenia do użytkownika. 6

7 "type" : "logout" 4. HeartBeatRequestPacket Pakiet utrzymujący połączenie z serwerem. Wymagane wysyłanie pakietu co 30 sekund. Jeżeli użytkownik nie wyśle komunikatu w przeciągu 60 sekund od ostatniego, połączenie zostanie zerwane natychmiast. RequestId Unikalny identyfikator komunikatu "type" : "heartbeat", "requestid" : 1 5. HeartBeatRsponsePacket Pakiet potwierdzający otrzymanie komunikatu HeartBeatRequestPacket. RequestId Identyfikator zawarty w pakiecie HeartBeatRequestPacket "type" : "heartbeat", "requestid" : 1 6. CandleRequestPacket Pakiet umożliwiający pobranie historycznych danych rynkowych w postaci świec japońskich. RequestId Unikalny identyfikator komunikatu FromTime Data początkowa okresu, dla którego pobierane są dane rynkowe ToTime Data końcowa okresu, dla którego pobierane są dane rynkowe Symbol String Symbol instrumentu, dla którego pobierane są dane rynkowe Period CandlePeriod Identyfikator interwału, dla którego pobierane są dane rynkowe (CandlePeriod) "type" : "candles", "requestid" : 0, "fromtime" : " T08:00:00", "totime" : " T12:00:00", "symbol" : "EURUSD", "period" : 240 7

8 7. CandleResponsePacket Pakiet zwracający informacje na zapytanie zawarte w komunikacie CandleRequestPacket. RequestId Identyfikator zawarty w pakiecie CandleRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu (APIErrorCode) FromTime Date Data początkowa okresu, dla którego pobierane są dane rynkowe ToTime Date Data końcowa okresu, dla którego pobierane są dane rynkowe Symbol String Symbol instrumentu, dla którego pobierane są dane rynkowe Candles Candle[] Tablica struktur typu Candle Period Identyfikator interwału, dla którego pobierane są dane rynkowe (CandlePeriod) Przykład "type" : "candles", "requestid" : 0, "status" : true, "ec" : 0, "fromtime" : " T08:00:00", "totime" : " T12:00:00", "symbol" : "EURUSD", "candles" : [ "o" : , "h" : , "l" : , "c" : , "vol" : 23, "time" : " T08:00:00", "o" : , "h" : , "l" : , "c" : , "vol" : 45, "time" : " T12:00:00" ], "period" : 240 8

9 Candle Struktura zawierająca dane o pojedynczej świecy japońskiej. Open Cena otwarcia Close Cena zamknięcia Low Najniższa wartość w danym okresie High Najwyższa wartość w danym okresie Volume Wysokość wolumenu Time Czas od którego konstruowana jest świeca japońska "o" : , "h" : , "l" : , "c" : , "vol" : 23, "time" : ":" T11:24:00" 8. AccountSettingsRequestPacket Pakiet reprezentujący zapytanie o ustawienia konta użytkowania. RequestId Unikalny identyfikator komunikatu "type" : "accountsettings", "requestid" : 0 9

10 9. AccountSettingsResponsePacket Pakiet zwracający informację o ustawieniach kona użytkownika. RequestId Identyfikator zawarty w pakiecie AccountSettingsRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode APIErrorCode AccountSettings AccountSettings Struktura typu AccountSettings "type" : "accountsettings", "requestid" : 0, "status" : true, "ec" : 0, "accountsettings" : "name" : "Jan Kowalski", "leverage" : 100, "interestrate" : 0, "MarginCall" : 0, "MarginStopOut" : 0, "MarginMode" : 3, AccountSettings Obiekt zawierający dane o ustawieniach rachunku użytkownika. Name String Nazwa użytkownika Leverage Int32 Domyślna dźwignia na rachunku InterestRate Stopa procentowa od której naliczają się odsetki MarginCall Poziom aktywacji wezwania do dopłaty MarginStopOut Poziom aktywacji zlecenia stop-out MarginMode Kod sposobu obliczania Free Margin (MarginMode) MarginType Kod zdarzenia aktywującego Margin Call (MarginType) AccountType Kod typu konta (AccountType) "name" : "Jan Kowalski", "leverage" : 100, "interestrate" : 0, "margincall" : 1, "marginstopout" : 0.8, "marginmode" : 3, "margintype" : 3, "accounttype" : 1 10

11 10. InstrumentSettingsRequestPacket Pakiet reprezentujący zapytanie o ustawienia wszystkich instrumentów. RequestId Unikalny identyfikator komunikatu "type" : "instrsettings", "requestid" : InstrumentSettingsResponsePacket Pakiet zwracający informację o ustawieniach wszystkich instrumentów. RequestId Identyfikator zawarty w pakiecie InstrumentSettingsRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu (APIErrorCode) InstrumentSettings InstrumentSettings[] "type" : "instrsettings", "requestid" : 0, "status" : true, "ec" : 0, "settings" : [ "name" : "EURUSD", "digits" : 5, "csize" : , "profitcalcmode" : 0, "margincalcmode" : 0, "marginhedged" : 50000, "margindivider" : 1, "swaptype" : 0, "swaplong" : , "swapshort" : , "trademode" : 2, "currency" : "EUR", "bid" : , "ask" : , "low" : , "high" : , "time" : " T11:24:41", "lomin" : 0.1, "lotmax": 100, "Commission": , "CommissionType": 0, "CommissionLots": 1 ] Tablica struktur typu InstrumentSettings 11

12 InstrumentSettings Obiekt zawierający dane o ustawieniach pojedynczego instrumentu. Name String Nazwa instrumentu Digits Liczba cyfr w rozwinięciu dziesiętnym ceny ContractSize Liczba jednostek instrumentu dla 1 lota ProfitCalcMode Kod sposobu w jaki serwer oblicza wynik z transakcji na danym instrumencie (ProfitCalcMode) MarginCalcMode Kod sposobu w jaki serwer oblicza Wymagany Depozyt Zabezpieczający dla transakcji na danym instrumencie (MarginCalcMode) MarginHedged Procent wartości nominalnej każdej z przeciwstawnych transakcji zablokowany na depozyt zabezpieczający. MarginDivider Współczynnik ilorazowy Wymaganego Depozytu Zabezpieczającego SwapType Kod sposobu w jaki serwer nalicza koszt codziennego finansowania pozycji (SwapType) SwapLong Punkty swap dla pozycji długiej na danym instrumencie dla 1 lota SwapShort Punkty swap dla pozycji krótkiej na danym instrumencie dla 1 lota TradeMode Kod zakresu handlu jaki jest możliwy dla danego instrumentu (TradeMode) Currency String Waluta bazowa danego instrumentu Bid Aktualna cena bid Ask Aktualna cena ask Low Najniższa cena z dania ostatniej aktualizacji ustawień High Najwyższa cena z dania ostatniej aktualizacji ustawień Time Ostatnia aktualizacja ustawień LotMin Najmniejszy wolumen zlecenia LotMax Największy wolumen zlecenia LotStep Krok zmiany wielkości wolumenu zlecenia Commission Prowizja od transakcji walutowych CommissionType Kod sposobu pobierania prowizji (CommissionType) CommisstionLots Kod bazy do naliczania prowizji (CommissionLots) 12

13 "name" : "EURUSD", "digits" : 5, "csize" : , "profitcalcmode" : 0, "margincalcmode" : 0, "marginhedged" : 50000, "margindivider" : 1, "swaptype" : 0, "swaplong" : , "swapshort" : , "trademode" : 2, "currency" : "EUR", "bid" : , "ask" : , "low" : , "high" : , "time" : " T11:24:41", "lomin" : 0.1, "lotmax": 100, "Commission": , "CommissionType": 0, "CommissionLots": MarginLevelRequestPacket Pakiet reprezentujący zapytanie o najnowsze szczegóły salda rachunku zalogowanego użytkownika. RequestId Unikalny identyfikator komunikatu "type" : "marginlevel", "requestid" : MarginLevelResponsePacket Pakiet zwracający najnowsze szczegóły salda rachunku użytkownika. RequestId Identyfikator zawarty w pakiecie MarginLevelRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu (APIErrorCode) MarginLevel MarginLevel Struktura zawierająca szczegóły salda rachunku 13

14 "type" : "marginlevel", "requestid" : 0, "status" : true, "ec" : 0, "marginlevel" : "login" : , "balance" : , "equity" : , "freemargin" : , "leveltype" : 0, "margin" : 421.6, "level" : MarginLevel Struktura zawierająca bieżące podsumowanie rachunku zalogowanego użytkownika. Login Login użytkownika Balance Saldo Rachunku Equity Saldo Rejestru Operacyjnego FreeMargin Wolne Środki Pieniężne LevelType Informacje o Wymaganym Depozycie Zabezpieczającym (MarginLevelType) Margin Wymagany Depozyt Zabezpieczający Level Poziom Zabezpieczenia "login" : , "balance" : , "equity" : , "freemargin" : , "leveltype" : 0, "margin" : 421.6, "level" : TickRegistrationRequestPacket Pakiet reprezentujący żądanie rejestracji/derejestracji na strumień kwotowań dla danego instrumentu. Pakiet rejestrujący można wysłać dowolną liczbę razy, jednak dla danego symbolu zostanie utworzony tylko jeden strumień danych. W dowolnym momencie można wyrejestrować się wysyłając pakiet z odpowiednią wartością pola RegistrationAction RequestId Unikalny identyfikator komunikatu Symbol String Nazwa interesującego nas instrumentu RegistrationAction Kod rezultatu procesu rejestracji/derejestracji 14

15 "type" : "tickregistration", "requestid" : 0, "registrationaction" : TickRegistrationResponsePacket Pakiet zwracający informację o rezultacie próby rejestracji na dane tickowe. RequestId Identyfikator zawarty w pakiecie TickRegistrationRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu "type" : " tickregistration ", "requestid" : 0, "status" : true, "ec" : TradeTransRequestPacket Pakiet reprezentujący żądanie zawarcia transakcji. RequestId Unikalny identyfikator komunikatu TradeCommand Informacja o typie zlecenia (TradeCommand) TransactionType Akcja dokonanej na zadanym zleceniu/transakcji. (TransactionType) Price Cena zlecenia/transakcji StopLoss Poziom zlecenia obronnego Stop Loss TakeProfit Poziom zlecenia obronnego Take Profit Symbol String Symbol instrumentu Volume Wolumen transakcji w lotach Order Identyfikator transakcji Comment string Komentarz Expiration Data wygasania zlecania (tylko oczekujące) "type" : "tradetransaction", "requestid" : 0, "tradecommand" : 1, "transactiontype" : 2, "price" : 0, "takeprofit" : 0, "stoploss" : 0, "symbol" : "EURUSD", "volume" : 0.2, "order" : 500, "comment" : "", "expiration" : " T00:00:00" 15

16 17. TradeTransResponsePacket Pakiet zwracający informację o rezultacie zawarcia transakcji. RequestId Identyfikator zawarty w pakiecie TradeTransRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu (APIErrorCode) Order Identyfikator transakcji TradeEc Kod błędu zawarcia transakcji (TradeErrorCode) "type" : "tradetransaction", "requestid" : 0, "status" : true, "ec" : 0, "order" : 500, "tradeec" : ClosedTradesRequestPacket Pakiet reprezentujący żądanie o kolekcję zamkniętych transakcji. RequestId Unikalny identyfikator komunikatu DateFrom Data początkowa okresu, dla którego pobierane są zamknięte transakcje DateTo Data końcowa okresu, dla którego pobierane są transakcje "type" : "closedtrades", "requestid" : 0, "datefrom" : T00:00:00, "dateto" : T20:00: ClosedTradesResponsePacket Pakiet zwracający kolekcję zamkniętych transakcji. RequestId Identyfikator zawarty w pakiecie ClosedTradesRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu (APIErrorCode) Trades TradeRecord[] Tablica zamkniętych transakcji DateFrom Data początkowa okresu, dla którego pobierane są zamknięte transakcje DateTo Data końcowa okresu, dla którego pobierane są transakcje 16

17 "type" : "closedtrades", "requestid" : 0, "status" : true, "ec" : 0, "trades" : [ "login" : , "order" : 81210, "tradecommand" : 1, "symbol" : "AUDCAD", "volume" : 0.001, "profit" : 5.02, "swaps" : 0, "commission" : 5.02, "stoploss" : 0, "takeprofit" : 0, "openprice" : , "opentime" : " T16:04:32", "closeprice" : , "closetime" : " T11:25:43", "closed" : false, "digits" : 5, "comment" : "", "expiration" : " T00:00:00", "commissionagent" : 0, "login" : , "order" : 81211, "tradecommand" : 0, "symbol" : "EURUSD", "volume" : 0.001, "profit" : 5.54, "swaps" : 0, "commission" : 5.54, "stoploss" : 0, "takeprofit" : 0, "openprice" : , "opentime" : " T16:04:42", "closeprice" : , "closetime" : T14:34:49", "closed" : false, "digits" : 5, "comment" : "", "expiration" : " T00:00:00", "commissionagent" : 0 ], "datefrom" : T00:00:00, "dateto" : T20:00: TradesInfoRequestPacket Pakiet reprezentujący żądanie o kolekcję otwartych transakcji oraz zleceń oczekujących. 17

18 RequestId Unikalny identyfikator komunikatu "type" : "tradesinfo", "requestid" : TradesInfoResponsePacket Pakiet zwracający kolekcję otwartych transakcji oraz zleceń oczekujących. RequestId Identyfikator zawarty w pakiecie ClosedTradesRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu (APIErrorCode) Trades TradeRecord[] Tablica otwartych transakcji oraz zleceń oczekujących "type" : " tradesinfo ", "requestid" : 0, "status" : true, "ec" : 0, "trades" : [ "login" : , "order" : 81210, "tradecommand" : 1, "symbol" : "AUDCAD", "volume" : 0.001, "profit" : 5.02, "swaps" : 0, "commission" : 5.02, "stoploss" : 0, "takeprofit" : 0, "openprice" : , "opentime" : " T16:04:32", "closeprice" : , "closetime" : " T00:00:00", "closed" : false, "digits" : 5, "comment" : "", "expiration" : " T00:00:00", "commissionagent" : 0, 18

19 ] "login" : , "order" : 81211, "tradecommand" : 0, "symbol" : "EURUSD", "volume" : 0.001, "profit" : 5.54, "swaps" : 0, "commission" : 5.54, "stoploss" : 0, "takeprofit" : 0, "openprice" : , "opentime" : " T16:04:42", "closeprice" : , "closetime" : " T00:00:00", "closed" : false, "digits" : 5, "comment" : "", "expiration" : " T00:00:00", "commissionagent" : 0 TradeRecord Obiekt zawierający dane o transakcji. Login Login użytkownika Order Identyfikator transakcji TradeCommand Informacja o typie zlecenia (TradeCommand) Symbol String Symbol instrumentu Volume Wolumen transakcji w lotach Profit Wynik na transakcji Swaps Wynik finansowania pozycji Comission Wartość zapłaconej prowizji StopLoss Poziom zlecenia obronnego Stop Loss TakeProfit Poziom zlecenia obronnego Take Profit OpenPrice Cena otwarcia OpenTime Czas otwarcia transakcji ClosePrice Cena zamknięcia CloseTime Czas zamknięcia Closed Bool Czy transakcja została zamknięta Digits Liczba cyfr w rozwinięciu dziesiętnym ceny Comment String Komentarz do transakcji Expiration Data wygasania zlecania (tylko oczekujące) 19

20 "login" : , "order" : 81211, "tradecommand" : 0, "symbol" : "EURUSD", "volume" : 0.001, "profit" : 5.54, "swaps" : 0, "commission" : 5.54, "stoploss" : 0, "takeprofit" : 0, "openprice" : , "opentime" : " T16:04:42", "closeprice" : , "closetime" : " T00:00:00", "closed" : false, "digits" : 5, "comment" : "", "expiration" : " T00:00:00", "commissionagent" : SessionScheduleRequestPacket Pakiet reprezentujący zapytanie o godziny handlu na żądanym instrumencie. RequestId Unikalny identyfikator komunikatu Symbol String Symbol instrumentu "type" : "sessionschedule", "requestid" : 0 "symbol" : "EURUSD" 23. SessionScheduleResponsePacket Pakiet zawierający informację o godzinach handlu na żądanym instrumencie. RequestId Identyfikator zawarty w pakiecie SessionScheduleRequestPacket Status Bool Informacja o sukcesie realizacji zapytania ErrorCode Kod błędu (APIErrorCode) DailySessions DailySession[] Tablica z obiektami opisującymi sesje w danym dniu 20

21 "type" : "sessionschedule", "requestid" : 0, "status" : true, "errorcode" : 0, "symbol" : "EURUSD", "dailysessions":[ "dayofweek":0, "tradingsessions" : [ "opentime" : "00:00:00", "closetime" : "1.00:00:00" ] "dayofweek":6, "tradingsessions" : [] ] DailySession Obiekt zawierający informację o sesjach notowań w trybie ciągłym w danym dniu 2. DayOfWeek Numer Typ wyliczeniowy kodujący dany dzień tygodnia. TradingSessions TradingSession[] Tablica obiektów opisujących sesję notowań "dayofweek":0, "tradingsessions" : [ "opentime" : "00:00:00", "closetime" : "22:00:00", "opentime" : "23:00:00", "closetime" : "1.00:00:00" ] TradingSession Obiekt reprezentujący pojedynczą sesje notowań w trybie ciągłym, składający się z godziny rozpoczęcia sesji i godziny zakończenia sesji. Wszystkie godziny podane są w czasie środkowoeuropejskim (UTC+01:00 zima/utc+2 - lato). OpenTime Godzina rozpoczęcia handlu w sesji CloseTime Godzina zakończenia handlu w sesji 2 Należy pamiętać o tym, iż dla różnych instrumentów obiekt DailySession może zawierać inne sesje. 21

22 "opentime" : "00:00:00" "closetime" : "23:00:00" Komunikaty protokołu strumieniowego 1. TickPacket Pakiet zawierający dane o notowaniach instrumentów. Ticks Tick[] Tablica z kwotowaniami instrumentów "type": "ticks", "ticks" : [ "symbol":"eurusd", "bid": , "ask": , "time":" t14:35:05", "rate": "symbol":"eurusd", "depositccy":"pln", "bid":306511, "ask":306677, "symbol":"usdsek", "bid": , "ask":6.4491,"time":" t14:35:05", "rate": "symbol":"usdsek", "depositccy":"pln", "bid": , "ask": ] Tick Symbol String Symbol instrumentu Bid Cena bid Ask Cena ask Time Data notowania Rate Obiekt zawierający dane o kursie konwersji na walutę ConversionRate depozytową 22

23 "symbol":"eurusd", "bid": , "ask": , "time":" t14:35:05", "rate": "symbol":"eurusd", "depositccy":"pln", "bid":306511, "ask": ConversionRate Symbol String Symbol instrumentu DepositCurrency String Waluta depozytowa Bid Cena sprzedaży Ask Cena kupna "symbol":"eurusd", "depositccy":"pln", "bid":306511, "ask": MarginLevelPacket Pakiet zawierający informację z podsumowaniem rachunku użytkownika. MarginLevel MarginLevel Struktura zawierająca bieżące podsumowanie rachunku zalogowane użytkownika "type": "marginlevelnotify", "marginlevel" : "login": , "balance": , "equity": , "freemargin": , "leveltype": 0, "margin": 421.6, "level":

24 3. TradeUpdatePacket Pakiet zawierający informację o dokonanej operacji na transakcji. Trade TradeRecord Obiekt zawierający informację o aktualizowanej transakcji Action "type" : "tradeupdate", "trade" : "login" : , "order" : 81210, "tradecommand" : 1, "symbol" : "AUDCAD", "volume" : 0, "profit" : , "swaps" : -2.46, "commission" : 2.42," stoploss" : , "takeprofit" : 0, "openprice" : , "opentime" : " T16:04:32", "closeprice" : , "closetime" : " T00:00:00", "closed" : false, "digits" : 5, "comment" : "", "expiration" : " T00:00:00", "commissionagent" : 0, "action" : 2 Typ operacji wykonanej na aktualizowanej transakcji (TradeAction) 24

25 Typy wyliczeniowe 1. AccountType Kod rodzaju rachunku, który posiada inwestor. Występowanie: AccountSettings 0 Mini 1 Standard 2 VIP 2. APIErrorCode Kod rezultatu zwracanego przez serwer w odpowiedzi na pakiet typu request. Występowanie: pakiety typu response 0 OK 1 Błąd serwera 2 Niezidentyfikowany błąd 3 Błąd transakcji 3. CandlePeriod Kod interwału z którego brane są dane tickowe używane do konstrukcji świecy japońskiej. Występowanie: Candle, CandleRequestPacket 1 1 minuta 5 5 minut minut minut minut (1 godzina) minut (4 godziny) minut (1 dzień) minut (1 tydzień) minut (30 dni) 4. CommissionLots Kod bazy służącej do naliczania prowizji. Występowanie: 25

26 InstrumentSettings 0 Od każdego lota 1 Od każdej transakcji 26

27 5. CommissionType Kod sposobu w jaki naliczana jest prowizja. Występowanie: 27

28 InstrumentSettings 0 Kwotowo 1 Jako pipsy 2 Procentowo 6. DayOfWeek Kod dni tygodnia Występowanie: DailySession 0 Niedziela 1 Poniedziałek 2 Wtorek 3 Środa 4 Czwartek 5 Piątek 6 Sobota 7. LoginStatus Kod rezultat rezultatu logowania. Nieudana autoryzacja może być spowodowana nieprawidłowym hasłem, brakiem praw dostępu do API bądź korzystaniem z nieaktualnej wersji protokołu. 0 OK 1 Nieprawidłowe hasło 2 Brak dostępu do API 3 Zła wersja protokołu 8. MarginCalcMode Kod sposobu w jaki serwer wylicza Wymagany Depozyt Zabezpieczający (Margin) dla danego instrumentu. Występowanie: 28

29 InstrumentSettings 0 Forex lots*contract_size*leverage*margin_divider 1 CFD lots*contract_size*market_price*margin_divider 2 Futures lots/margin_divider 3 CFD-index lots*contract_size*market_price/margin_divider*(tick_price-tick_size) 4 CFD-leverage lots*contract_size*market_price/leverage*percentage/100 29

30 9. MarginMode Kod sposobu w jaki serwer wylicza Wolne Środki Pieniężne (Free Margin) dla zalogowanego użytkownika. Domyślnie do wyliczania Free Maregin są tylko stratne transakcje Występowanie: AccountSettings 0 DontUse Nie uwzględniaj otwartych pozycji w obliczeniach 1 UseAll Uwzględniaj zarówno zysk jak i stratę 2 UseProfit Uwzględniaj tylko zyskowne transakcje 3 UseLoss Uwzględniaj tylko stratne transakcje 10. MarginType Kod typu zdarzenia aktywującego Margin Call. Występowanie: AccountSettings 0 Percent Wyrażenie Equity / Margin * 100 spadnie poniżej pewnego poziomu 1 Currency Euity spadnie kwotowo poniżej pewnego poziomu 11. MarginLevelType Kod dodatkowej informacji o Poziomie Zabezpieczenia (Margin Level). Występowanie: MarginLevel 0 OK Poziom Zabezpieczenia powyżej 100% 1 MarginCall Poziom Zabezpieczenia znajduje się między 80% a 100% 2 StopOut Nastąpiło automatyczne zamknięcie najbardziej stratnej pozycji 12. ProfitCalcMode Kod sposobu w jaki serwer oblicza wynik na transakcji. Występowanie: 30

31 InstrumentSettings 0 Forex (close_price open_price) * contract_size * lots 1 CDF (close_price open_price) * contract_size * lots 2 Futures (close_price open_price) * tick_price/tick_size * lots 13. RegistrationAction Kod stosowany do rejestrowania/wyrejestrowywania się z strumienia danych tickowych dla danego instrumentu. Występowanie: TickRegistrationRequestPacket 0 Unregister Wyrejestruj się z strumienia danych 1 Register Zarejestruj się na strumień danych 14. SwapType Kod sposobu w jaki serwer nalicza koszt codziennego finansowania pozycji Występowanie: 31

32 InstrumentSettings 0 Points Koszt finansowania wyrażony jest w punktach 1 Dollars Koszt finansowania wyrażony jest w dolarach 2 Interest Koszt finansowania wyrażony jest za pomocą rocznej stopy procentowej naliczanej dziennie 3 Margin Koszt finansowania wyrażony jest w walucie, w której obliczany jest Currency Wymagany Depozyt Zabezpieczający (Margin) 15. TradeAction Kod akcji, jaka została dokonana na transakcji Występowanie: TradeUpdatePacket 0 Otwarcie 1 Modyfikacja 2 Zamknięcie 16. TradeCommand Kod informujący o typie zlecenia, które zostało złożone. Występowanie: TradeRecord 0 Buy 1 Sell 2 Buy limit 3 Sell limit 4 Buy stop 5 Sell stop 6 Balance 7 Credit 32

33 17. TradeErrorCode Kod rezultatu zwracanego przez serwer w odpowiedzi na próbę złożenie zlecenia. Występowanie: TradeTransResponsePacket 0 OK 1 OK brak operacji 2 Ogólny błąd 3 Nieprawidłowe dane 4 Techniczny problem serwera 5 Stara wersja terminala klienckiego 6 Brak połączenia 7 Brak wymaganych uprawnień 8 Zbyt częsty dostęp do serwera 9 Nieprawidłowa operacja 10 Zabezpieczenie początku sesji 64 Konto zablokowane 65 Nieprawidłowe informacje o koncie 128 Upłynął limit czasu zawarcia transakcji 129 Zlecenie posiada błędne ceny 130 Nieprawidłowe poziomy StopLoss, Take Profit 131 Nieprawidłowy wolumen zlecenia 132 Rynek zamknięty 133 Zawieranie transakcji jest obecnie wyłączone 134 Niewystarczająca ilość pieniędzy do zrealizowania transakcji 135 Cena uległa zmianie 136 Brak notowań 137 Broker jest zajęty 138 Dozwolone tylko zlecenie kupna 139 Za dużo żądań od jednego klienta 140 Transakcja zaakceptowana przez serwer i umieszczona w kolejce 141 Transakcja anulowana przez klienta 142 Odmowa modyfikacji zlecenia 143 Odmowa użycia daty ważności 144 Zbyt wiele zleceń 145 Hedge jest zabroniony 18. TradeMode Kod zakresu handlu jaki jest możliwy dla danego instrumentu. Występowanie: 33

34 InstrumentSettings 0 No Brak możliwości handlu 1 Close Tylko zamykanie otwartych transakcji 2 Full Brak ograniczeń handlu 34

35 19. TransactionType Kod informujący o akcji dokonanej na zadanym zleceniu/transakcji. Występowanie: TradeTransRequestPacket 0 Złóż zlecenie 2 Zamknij otwartą transakcję 3 Zmodyfikuj zlecenie/transakcję 4 Usuń zlecenie oczekujące 35