3 - mForex

mForex API
dokumentacja protokołu
binarnego
wersja 0.9.6
WSTĘP
3
OGÓLNE
SERWERY
GODZINY HANDLU
3
3
3
FORMAT DANYCH
4
DATA I CZAS
OGÓLNE ZASADY OBSŁUGI KOMUNIKATÓW
4
4
PROTOKÓŁ
5
STRUKTURA PAKIETU
INFORMACJE OGÓLNE
MODEL „ZAPYTANIE-ODPOWIEDŹ”
MODEL „STRUMIENIOWY”
KOMUNIKATY
KOMUNIKATY PROTOKOŁU „ZAPYTANIE-ODPOWIEDŹ”
KOMUNIKATY PROTOKOŁU STRUMIENIOWEGO
TYPY WYLICZENIOWE
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
5
5
5
5
6
6
12
13
2
WSTĘP
Ogólne
Niniejszy dokument zawiera opis protokołu binarnego używanego podczas komunikacji między
użytkownikiem a serwerem transakcyjnym.
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 IP:


REAL: real.api.mforex.pl:5615
DEMO: demo.api.mforex.pl:5615
Komunikacja z serwerem realnym prowadzona jest przy pomocy szyfrowanego połączenia (SSLv3).
Wersje SSL starsze niż v3 nie są obsługiwane.
Nazwa certyfikatu, jest taka sama jak nazwa serwera API do którego loguje się użytkownik.
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.
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
3
FORMAT DANYCH
Data i czas
Data zdefiniowana jest jako liczba 100-nanosekundowych interwałów liczonych od północy
pierwszego stycznia 1 roku n.e. wg kalendarza gregoriańskiego. Czas również zdefiniowany jest jako
liczba 100-nanosekundowych interwałów liczonych od północy dnia poprzedniego.
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.
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
4
PROTOKÓŁ
Struktura Pakietu
Każdy pakiet składa się z 8 bajtowego nagłówka1 kodowanego w konwencji Little endian i pakietu
właściwego.
…
Długość pakietu w bajtach
Identyfikator Pakietu
Pakiet właściwy
Tabela 1: Struktura pakietu
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 typ wyliczeniowy
APIErrorCode przechowujący 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 powinna2 być unikatowa dla każdej pary.
UWAGA:
Wyjątkiem od powyższej reguły jest wiadomość LoginResponsePacket, która rezultat zapytania
przechowuje jako typ logiczny w polu LoggedIn.
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.
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
Pierwsze 4 bajty kodują informację o długości pakietu, następne 4 przechowują identyfikator
powinna – tj. niespełnienie tego warunku nie jest błędem, jednak powoduje, że poprawne przypisanie
odpowiedzi do zapytania może być niemożliwe.
2
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
5
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.
Nazwa
RequestId
Login
Password
Typ
Int32
Int32
String
Opis
Unikalny identyfikator komunikatu
Login użytkownika
Hasło użytkownika
2. LoginResponsePacket
Pakiet zwracający informacje o rezultacie logowania użytkownika.
Nazwa
Typ
RequestId
Int32
Login
LoggedIn
Int32
Bool
Opis
Identyfikator zawarty w pakiecie
LoginRequestPacket
Login użytkownika
Informacja o powodzeniu procesu logowania
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.
Nazwa
Typ
Opis
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.
Nazwa
RequestId
Typ
Int32
Opis
Unikalny identyfikator komunikatu
5. HeartBeatRsponsePacket
Pakiet potwierdzający otrzymanie komunikatu HeartBeatRequestPacket.
Nazwa
Typ
RequestId
Int32
Opis
Identyfikator zawarty w pakiecie
HeartBeatRequestPacket
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
6
6. CandleRequestPacket
Pakiet umożliwiający pobranie historycznych danych rynkowych w postaci świec japońskich.
Nazwa
RequestId
Typ
FromTime
Int64
ToTime
Int64
Symbol
String
Period
CandlePeriod
Int32
Opis
Unikalny identyfikator komunikatu
Data początkowa okresu, dla którego pobierane są
dane rynkowe
Data końcowa okresu, dla którego pobierane są
dane rynkowe
Symbol instrumentu, dla którego pobierane są dane
rynkowe
Identyfikator interwału, dla którego pobierane są
dane rynkowe
7. CandleResponsePacket
Pakiet zwracający informacje na zapytanie zawarte w komunikacie CandleRequestPacket.
Nazwa
Typ
RequestId
Int32
Status
ErrorCode
Bool
APIErrorCode
FromTime
Date
ToTime
Date
Symbol
String
Candles
Candle[]
Period
CandlePeriod
Opis
Identyfikator zawarty w pakiecie
CandleRequestPacket
Informacja o sukcesie realizacji zapytania
Kod błędu
Data początkowa okresu, dla którego pobierane są
dane rynkowe
Data końcowa okresu, dla którego pobierane są
dane rynkowe
Symbol instrumentu, dla którego pobierane są dane
rynkowe
Tablica struktur typu Candle
Identyfikator interwału, dla którego pobierane są
dane rynkowe
Candle
Struktura zawierająca dane o pojedynczej świecy japońskiej.
Nazwa
Open
Close
Low
High
Volume
Time
Typ
Double
Double
Double
Double
Int32
Int64
Opis
Cena otwarcia
Cena zamknięcia
Najniższa wartość w danym okresie
Najwyższa wartość w danym okresie
Wysokość wolumenu
Czas od którego konstruowana jest świeca japońska
8. InstrumentSettingsRequestPacket
Pakiet reprezentujący zapytanie o ustawienia wszystkich instrumentów.
Nazwa
RequestId
Typ
Int32
Opis
Unikalny identyfikator komunikatu
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
7
9. InstrumentSettingsResponsePacket
Pakiet zwracający informację o ustawieniach wszystkich instrumentów.
Nazwa
Typ
RequestId
Int32
Status
ErrorCode
InstrumentSettings
Bool
APIErrorCode
InstrumentSettings[]
Opis
Identyfikator zawarty w pakiecie
InstrumentSettingsRequestPacket
Informacja o sukcesie realizacji zapytania
Kod błędu
Tablica struktur typu InstrumentSettings
InstrumentSettings
Obiekt zawierający dane o ustawieniach pojedynczego instrumentu.
Nazwa
Name
Digits
ContractSize
Typ
ProfitCalcMode
ProfitCalcMode
MarginCalcMode
MarginCalcMode
MarginHedged
Double
MarginDivider
Double
SwapType
SwapType
SwapLong
Double
SwapShort
Double
TradeMode
TradeMode
Currency
Bid
Ask
String
Double
Double
Low
Double
High
Double
Time
Int64
String
Int32
Double
Opis
Nazwa instrumentu
Liczba cyfr w rozwinięciu dziesiętnym ceny
Liczba jednostek instrumentu dla 1 lota
Kod sposobu w jaki serwer oblicza wynik
z transakcji na danym instrumencie
Kod sposobu w jaki serwer oblicza Wymagany
Depozyt Zabezpieczający dla transakcji na
danym instrumencie
Procent wartości nominalnej każdej z
przeciwstawnych transakcji, który zablokowany
zostanie na depozyt zabezpieczający. Zawsze
równy 0.5
Współczynnik ilorazowy Wymaganego
Depozytu Zabezpieczającego
Kod sposobu w jaki serwer nalicza koszt
codziennego finansowania pozycji
Punkty swap dla pozycji długiej na danym
instrumencie dla 1 lota
Punkty swap dla pozycji krótkiej na danym
instrumencie dla 1 lota
Kod zakresu handlu jaki jest możliwy dla
danego instrumentu
Waluta bazowa danego instrumentu
Aktualna cena bid
Aktualna cena ask
Najniższa cena z dania ostatniej aktualizacji
ustawień
Najwyższa cena z dania ostatniej aktualizacji
ustawień
Ostatnia aktualizacja ustawień
10. MarginLevelRequestPacket
Pakiet reprezentujący zapytanie o najnowsze szczegóły salda rachunku zalogowanego użytkownika.
Nazwa
RequestId
Typ
Int32
Opis
Unikalny identyfikator komunikatu
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
8
11. MarginLevelResponsePacket
Pakiet zwracający najnowsze szczegóły salda rachunku użytkownika.
Nazwa
Typ
RequestId
Int32
Status
ErrorCode
MarginLevel
Bool
APIErrorCode
MarginLevel
Opis
Identyfikator zawarty w pakiecie
MarginLevelRequestPacket
Informacja o sukcesie realizacji zapytania
Kod błędu
Struktura zawierająca szczegóły salda rachunku
MarginLevel
Struktura zawierająca bieżące podsumowanie rachunku zalogowanego użytkownika.
Nazwa
Login
Balance
Equity
FreeMargin
LevelType
Margin
Level
Typ
Opis
Int32
Login użytkownika
Double
Saldo Rachunku
Double
Saldo Rejestru Operacyjnego
Double
Wolne Środki Pieniężne
Dodatkowe informacje o Wymaganym
Meta4MarginLevelType
Depozycie Zabezpieczającym
Double
Wymagany Depozyt Zabezpieczający
Double
Poziom Zabezpieczenia
12. TradeTransRequestPacket
Pakiet reprezentujący żądanie zawarcia transakcji.
Nazwa
RequestId
TradeCommand
TransactionType
Price
StopLoss
TakeProfit
Symbol
Volume
Order
Comment
Expiration
Typ
Int32
TradeCommand
TransactionType
Double
Double
Double
String
Double
Int32
string
Int64
Opis
Unikalny identyfikator komunikatu
Informacja o typie zlecenia
Akcja dokonanej na zadanym zleceniu/transakcji.
Cena zlecenia/transakcji
Poziom zlecenia obronnego Stop Loss
Poziom zlecenia obronnego Take Profit
Symbol instrumentu
Wolumen transakcji w lotach
Identyfikator transakcji
Komentarz
Data wygasania zlecania (tylko oczekujące)
13. TradeTransResponsePacket
Pakiet zwracający informację o rezultacie zawarcia transakcji.
Nazwa
Typ
RequestId
Int32
Status
ErrorCode
Order
TradeEc
Bool
APIErrorCode
Int32
TradeErrorCode
Opis
Identyfikator zawarty w pakiecie
TradeTransRequestPacket
Informacja o sukcesie realizacji zapytania
Kod błędu
Identyfikator transakcji
Kod błędu zawarcia transakcji
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
9
14. ClosedTradesRequestPacket
Pakiet reprezentujący żądanie o kolekcję zamkniętych transakcji.
Nazwa
RequestId
Typ
DateFrom
Int64
DateTo
Int64
Int32
Opis
Unikalny identyfikator komunikatu
Data początkowa okresu, dla którego pobierane są
zamknięte transakcje
Data końcowa okresu, dla którego pobierane są
transakcje
15. ClosedTradesResponsePacket
Pakiet zwracający kolekcję zamkniętych transakcji.
Nazwa
Typ
RequestId
Int32
Opis
Identyfikator zawarty w pakiecie
Status
ErrorCode
Bool
APIErrorCode
Informacja o sukcesie realizacji zapytania
Kod błędu
Trades
ClosedTradesRequestPacket
Tablica zamkniętych transakcji
TradeRecord[]
DateFrom
Int64
DateTo
Int64
Data początkowa okresu, dla którego pobierane są
zamknięte transakcje
Data końcowa okresu, dla którego pobierane są
transakcje
16. TradesInfoRequestPacket
Pakiet reprezentujący żądanie o kolekcję otwartych transakcji oraz zleceń oczekujących.
Nazwa
RequestId
Typ
Int32
Opis
Unikalny identyfikator komunikatu
17. TradesInfoResponsePacket
Pakiet zwracający kolekcję otwartych transakcji oraz zleceń oczekujących.
Nazwa
Typ
RequestId
Int32
Status
ErrorCode
Bool
APIErrorCode
Trades
Opis
Identyfikator zawarty w pakiecie
ClosedTradesRequestPacket
Informacja o sukcesie realizacji zapytania
Kod błędu
Tablica otwartych transakcji oraz zleceń oczekujących
TradeRecord[]
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
10
TradeRecord
Obiekt zawierający dane o transakcji.
Nazwa
Login
Order
TradeCommand
Symbol
Volume
Profit
Swaps
Comission
StopLoss
TakeProfit
OpenPrice
OpenTime
ClosePrice
CloseTime
Closed
Digits
Comment
Expiration
Typ
Opis
Login użytkownika
Identyfikator transakcji
Informacja o typie zlecenia
Symbol instrumentu
Wolumen transakcji w lotach
Wynik na transakcji
Wynik finansowania pozycji
Wartość zapłaconej prowizji
Poziom zlecenia obronnego Stop Loss
Poziom zlecenia obronnego Take Profit
Cena otwarcia
Czas otwarcia transakcji
Cena zamknięcia
Czas zamknięcia
Czy transakcja została zamknięta
Liczba cyfr w rozwinięciu dziesiętnym ceny
Komentarz do transakcji
Data wygasania zlecania (tylko oczekujące)
Int32
Int32
TradeCommand
String
Double
Double
Double
Double
Double
Double
Double
Int64
Double
Int64
Bool
Int32
String
Int64
18. SessionScheduleRequestPacket
Pakiet reprezentujący zapytanie o godziny handlu na żądanym instrumencie.
Nazwa
RequestId
Symbol
Typ
Int32
String
Opis
Unikalny identyfikator komunikatu
Symbol instrumentu
19. SessionScheduleResponsePacket
Pakiet zawierający informację o godzinach handlu na żądanym instrumencie.
Nazwa
Typ
RequestId
Int32
Status
ErrorCode
Bool
APIErrorCode
DailySessions
DailySession[]
Opis
Identyfikator zawarty w pakiecie
SessionScheduleRequestPacket
Informacja o sukcesie realizacji zapytania
Kod błędu
Tablica z obiektami opisującymi sesje w danym
dniu
DailySession
Obiekt zawierający informację o sesjach notowań w trybie ciągłym w danym dniu3.
Nazwa
DayOfWeek
Typ
DayOfWeek
TradingSessions
Opis
Typ wyliczeniowy kodujący dany dzień tygodnia
Tablica obiektów opisujących sesję notowań
TradingSession[]
3
Należy pamiętać o tym, iż dla różnych instrumentów obiekt DailySession może zawierać inne sesje.
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
11
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).
Nazwa
OpenTime
CloseTime
Typ
Int64
Int64
Opis
Godzina rozpoczęcia handlu w sesji
Godzina zakończenia handlu w sesji
Komunikaty protokołu strumieniowego
1. TickPacket
Pakiet zawierający dane o notowaniach instrumentów.
Nazwa
Ticks
Tick
Nazwa
Symbol
Bid
Ask
Time
Rate
ConversionRate
Nazwa
Symbol
DepositCurrency
Bid
Ask
Typ
Tick[]
Opis
Tablica z notowaniami instrumentów
Typ
Opis
String
Symbol instrumentu
Double
Cena bid
Double
Cena ask
Int64
Data notowania
Obiekt zawierający dane o kursie konwersji na walutę
ConversionRate
depozytową
Typ
String
String
Double
Double
Opis
Symbol instrumentu
Waluta depozytowa
Cena sprzedaży
Cena kupna
2. MarginLevelPacket
Pakiet zawierający informację z podsumowaniem rachunku użytkownika.
Nazwa
Typ
MarginLevel
MarginLevel
Opis
Struktura zawierająca bieżące podsumowanie rachunku
zalogowane użytkownika
3. TradeUpdatePacket
Pakiet zawierający informację o dokonanej operacji na transakcji.
Nazwa
Trade
Action
Typ
TradeRecord
TradeAction
Opis
Obiekt zawierający informację o aktualizowanej
transakcji
Typ operacji wykonanej na aktualizowanej transakcji
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
12
Typy wyliczeniowe
1. CandlePeriod
Kod interwału z którego brane są dane tickowe używane do konstrukcji świecy japońskiej.
Występowanie: CandleRequestPacket, CandleResponsePacket
Wartość
1
5
15
30
60
240
1440
10080
43200
Opis
1 minuta
5 minut
15 minut
30 minut
60 minut (1 godzina)
240 minut (4 godziny)
1440 minut (1 dzień)
10080 minut (1 tydzień)
43200 minut (30 dni)
2. APIErrorCode
Kod rezultatu zwracanego przez serwer w odpowiedzi na pakiet typu “request”.
Występowanie: CandleRequestPacket,
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
13
InstrumentSettingsResponsePacket, MarginLevelResponsePacket,
TradeTransResponsePacket
Wartość
0
1
2
3
Opis
OK
Błąd serwera
Niezidentyfikowany błąd
Błąd transakcji
3. ProfitCalcMode
Kod sposobu w jaki serwer oblicza wynik na transakcji.
Występowanie: InstrumentSettings
Wartość
0
1
2
Opis
Forex
CDF
Futures
(close_price – open_price) * contract_size * lots
(close_price – open_price) * contract_size * lots
(close_price – open_price) * tick_price/tick_size * lots
4. MarginCalcMode
Kod sposobu w jaki serwer wylicza Wymagany Depozyt Zabezpieczający (Margin) dla danego
instrumentu.
Występowanie: InstrumentSettings
Wartość
0
1
2
3
4
Opis
Forex
CFD
Futures
CFD-index
CFD-leverage
lots*contract_size*leverage*margin_divider
lots*contract_size*market_price*margin_divider
lots/margin_divider
lots*contract_size*market_price/margin_divider*(tick_price-tick_size)
lots*contract_size*market_price/leverage*percentage/100
5. SwapType
Kod sposobu w jaki serwer nalicza koszt codziennego finansowania pozycji
Występowanie: InstrumentSettings
Wartość
0
1
Opis
Points
Dollars
2
Interest
3
Margin
Currency
Koszt finansowania wyrażony jest w punktach
Koszt finansowania wyrażony jest w dolarach
Koszt finansowania wyrażony jest za pomocą rocznej stopy procentowej
naliczanej dziennie
Koszt finansowania wyrażony jest w walucie, w której obliczany jest
Wymagany Depozyt Zabezpieczający (Margin)
6. TradeMode
Kod zakresu handlu jaki jest możliwy dla danego instrumentu.
Występowanie: InstrumentSettings
Wartość
0
1
Opis
No
Close
Brak możliwości handlu
Tylko zamykanie otwartych transakcji
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
14
2
Full
Brak ograniczeń handlu
7. Meta4MarginLevelType
Kod dodatkowej informacji o Poziomie Zabezpieczenia (Margin Level).
Występowanie: MarginLevel
Wartość
0
1
2
Opis
OK
MarginCall
StopOut
Poziom Zabezpieczenia powyżej 100%
Poziom Zabezpieczenia znajduje się między 80% a 100%
Nastąpiło automatyczne zamknięcie najbardziej stratnej pozycji
8. TradeCommand
Kod informujący o typie zlecenia, które zostało złożone.
Występowanie: TradeTransRequestPacket,
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
15
TradeRecord
Wartość
0
1
2
3
4
5
6
7
Opis
Buy
Sell
Buy limit
Sell limit
Buy stop
Sell stop
Balance
Credit
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
16
9. TransactionType
Kod informujący o akcji dokonanej na zadanym zleceniu/transakcji.
Występowanie: TradeTransRequestPacket
Wartość
0
2
3
4
Opis
Złóż zlecenie
Zamknij otwartą transakcję
Zmodyfikuj zlecenie/transakcję
Usuń zlecenie oczekujące
10. TradeErrorCode
Kod rezultatu zwracanego przez serwer w odpowiedzi na próbę złożenie zlecenia.
Występowanie:
TradeTransResponsePacket
Wartość
0
1
2
3
4
5
6
7
8
9
10
64
65
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
Opis
OK
OK – brak operacji
Ogólny błąd
Nieprawidłowe dane
Techniczny problem serwera
Stara wersja terminala klienckiego
Brak połączenia
Brak wymaganych uprawnień
Zbyt częsty dostęp do serwera
Nieprawidłowa operacja
Zabezpieczenie początku sesji
Konto zablokowane
Nieprawidłowe informacje o koncie
Upłynął limit czasu zawarcia transakcji
Zlecenie posiada błędne ceny
Nieprawidłowe poziomy StopLoss, Take Profit
Nieprawidłowy wolumen zlecenia
Rynek zamknięty
Zawieranie transakcji jest obecnie wyłączone
Niewystarczająca ilość pieniędzy do zrealizowania transakcji
Cena uległa zmianie
Brak notowań
Broker jest zajęty
Dozwolone tylko zlecenie kupna
Za dużo żądań od jednego klienta
Transakcja zaakceptowana przez serwer i umieszczona w kolejce
Transakcja anulowana przez klienta
Odmowa modyfikacji zlecenia
Odmowa użycia daty ważności
Zbyt wiele zleceń
Hedge jest zabroniony
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
17
11. TradeAction
Kod akcji, jaka została dokonana na transakcji
Występowanie: TradeUpdatePacket
Wartość
0
1
2
Opis
Otwarcie
Modyfikacja
Zamknięcie
12. DayOfWeek
Kod dni tygodnia
Występowanie: DailySession
Wartość
0
1
2
3
4
5
6
Opis
Niedziela
Poniedziałek
Wtorek
Środa
Czwartek
Piątek
Sobota
Dom Maklerski mBanku S.A., 00-950 Warszawa, skr. poczt. 21, ul. Wspólna 47/49, tel. +48 22 697 49 00, fax +48
22 697 49 44, Sąd Rejonowy dla m.st. Warszawy, XII Wydział Gospodarczy Krajowego Rejestru Sądowego, nr rejestru
przedsiębiorców KRS 0000003135, NIP 526-22-54-566, REGON 013105594. Kapitał zakładowy (w całości wpłacony)
wynosi 26.719.000 złotych.
18