API MEXC

MEXC to globalna giełda kryptowalut udostępniająca dane rynkowe i konta w trybie strumieniowym za pośrednictwem bezpiecznych połączeń WebSocket.

WebSocket Spot API jest zgodne ze specyfikacjami opublikowanymi w dokumentacji Market Streams oraz User Data Streams. Kanały rynkowe są dostarczane jako ramki Protocol Buffers, podczas gdy prywatne strumienie używają formatu JSON. Komponent TsgcWSAPI_MEXC zarządza cyklem życia połączenia, uwierzytelnianiem oraz utrzymaniem klucza nasłuchu, dzięki czemu aplikacje mogą skupić się na przetwarzaniu przychodzących danych.

Oprócz strumieniowania przez WebSockets, zestaw narzędzi udostępnia również kompletne Spot HTTP API. Komponent TsgcHTTP_API_MEXC_Spot (jednostka sgcHTTP_API_MEXC) opakowuje każdy oficjalny punkt końcowy REST, umożliwiając aplikacjom pobieranie danych rynkowych lub handel z użyciem podpisanych żądań.

Konfiguracja komponentu

Podstawowy punkt końcowy WebSocket to wss://wbs-api.mexc.com/ws. Gdy MEXCUserDataStreams.UserStream jest włączony i podano prawidłowy klucz API, komponent automatycznie żąda klucza nasłuchiwania i dołącza go do URL połączenia.

Należy umieścić komponenty TsgcWebSocketClient i TsgcWSAPI_MEXC na formularzu (lub utworzyć je w kodzie), przypisać instancję klienta do komponentu API i aktywować klienta, aby rozpocząć sesję.

var
  WSClient: TsgcWebSocketClient;
  MEXC: TsgcWSAPI_MEXC;
begin
  WSClient := TsgcWebSocketClient.Create(nil);
  MEXC := TsgcWSAPI_MEXC.Create(nil);
  MEXC.Client := WSClient;
  MEXC.MEXCAPI.ApiKey := 'YOUR_KEY';
  MEXC.MEXCAPI.ApiSecret := 'YOUR_SECRET';
  MEXC.MEXCUserDataStreams.UserStream := True;
  if WSClient.Connect then
    MEXC.SubscribeTrade('BTCUSDT');
end;

Właściwości

• Klient: odwołanie do transportu TsgcWebSocketClient. Komponent włącza bicie serca klienta (15 sekund) w celu utrzymania sesji przy życiu.
• MEXCAPI.ApiKey / ApiSecret: Dane uwierzytelniające Spot API. Klucz jest wymagany dla prywatnych kanałów; sekret jest potrzebny do podpisywania żądań klucza nasłuchiwania.
• MEXCUserDataStreams.UserStream: gdy wartość wynosi True (domyślnie), komponent pobiera klucz nasłuchu przed połączeniem i odświeża go co 10 minut. Wyłączenie tej opcji umożliwia pracę wyłącznie z publicznymi kanałami danych.
• MEXCUserDataStreams.ListenKeyOnDisconnect: akcja wykonywana po rozłączeniu WebSocket, gdy klucz nasłuchiwania jest aktywny:
  • blkmxodDeleteListenKey: unieważnia klucz nasłuchiwania przez REST (domyślnie).
  • blkmxodClearListenKey: zachowuje klucz nasłuchiwania po stronie serwera i czyści wartość z pamięci podręcznej.
  • blkmxodDoNothing: ponownie używa tego samego klucza nasłuchiwania przy następnym połączeniu.
• ListenKey: właściwość tylko do odczytu udostępniająca aktywny klucz nasłuchu zwrócony przez API REST.
• RawMessages: jeśli włączone, przychodzące ramki tekstowe nie są analizowane i są przekazywane jako zwykły JSON przez dziedziczone zdarzenia WebSocket.

Zdarzenia

• OnConnect / OnDisconnect: wywoływane, gdy bazowa sesja WebSocket zostaje nawiązana lub zakończona.
• OnMEXCMarketStream: wywoływane dla każdej ramki rynkowej Protobuf. Procedura obsługi otrzymuje obiekt TsgcMEXCSpotProtoMessage, którego właściwość MessageType identyfikuje ładunek (Trade, KLine, DiffDepth, LimitDepth, BookTicker, BookTickerBatch, MiniTicker lub MiniTickers). Do sprawdzania zdekodowanej struktury należy używać klas pomocniczych z modułu sgcWebSocket_API_MEXC_Proto.
• OnMEXCResponse: odbiera potwierdzenia subskrypcji i odpowiedzi ping/pong w formacie JSON (Id, Code, Message).
• OnMEXCUserDataStream: wywoływane po nadejściu prywatnych wiadomości dotyczących konta (zlecenia, transakcje, aktualizacje salda). Dostarczana jest nazwa kanału i surowy ładunek JSON.
• OnMEXCException: przechwytuje wyjątki REST lub WebSocket (błędy klucza nasłuchiwania, awarie HTTP, problemy z parsowaniem itp.).

Poniższy przykład pokazuje, jak zdekodować ramkę transakcji:

procedure TMainForm.MEXCMarketStream(Sender: TObject;
  const aMessage: TsgcMEXCSpotProtoMessage; const aStream: TMemoryStream);
var
  Deal: TsgcMEXCDealItem;
begin
  if aMessage.MessageType = sgcmxspmtTrade then
  begin
    Deal := TsgcMEXCTradeStream(aMessage.Trade).PublicDeals.DealsList[0];
    Memo1.Lines.Add(Format('Trade %s x %s', [Deal.Quantity, Deal.Price]));
  end;
end;

Metody subskrypcji WebSocket

Komponent udostępnia funkcje pomocnicze dla każdego publicznego kanału Spot. Należy wywołać metodę Subscribe*, aby rozpocząć strumieniowanie danych, oraz odpowiednią metodę UnSubscribe*, aby je zatrzymać.

Kanały publiczne

Kanały prywatne

Tematy prywatne wymagają ważnego klucza API. Komponent subskrybuje przy użyciu aktywnego klucza nasłuchiwania i odnawia go cyklicznie.

Należy używać odpowiednich metod UnSubscribe* w celu zakończenia strumienia. Składnik automatycznie wysyła polecenia PING i sprawdza poprawność zwróconych odpowiedzi PONG w celu monitorowania łączności.

Publiczne endpointy REST

Publicznie dostępne metody REST.

Prywatne punkty końcowe REST

Prywatne endpointy wymagają prawidłowych kluczy API i podpisanego ciągu zapytania. Komponent automatycznie dołącza znacznik czasu, recvWindow oraz podpis HMAC.