API Binance

Binance

Binance to międzynarodowa, wielojęzyczna giełda kryptowalut. Oferuje kilka API do uzyskiwania dostępu do danych Binance. Obsługiwane są następujące API:

1. Strumienie WebSocket: pozwalają subskrybować określone metody i otrzymywać dane w czasie rzeczywistym. Zdarzenia są wypychane do klientów przez serwer do subskrybentów. Używa protokołu WebSocket.
2. UserData stream: subskrybujący klienci otrzymują szczegóły konta. Wymaga klucza API do uwierzytelnienia i używa WebSocket jako protokołu.
3. REST API: Wymaga klucza API i sekretu do uwierzytelniania i używa HTTPS jako protokołu.
   1. Dane rynkowe
   2. Dane konta i handlu
   3. Portfel
4. Futures: strumieniowe transmisje danych rynkowych WebSocket Futures są obsługiwane przez interfejs API klienta Binance Futures.

Klient obsługuje również Binance.us; obsługiwane są następujące API:

1. Strumienie WebSocket: pozwalają subskrybować określone metody i otrzymywać dane w czasie rzeczywistym. Zdarzenia są wypychane do klientów przez serwer do subskrybentów. Używa protokołu WebSocket.
2. UserData stream: subskrybujący klienci otrzymują szczegóły konta. Wymaga klucza API do uwierzytelnienia i używa WebSocket jako protokołu.
3. REST API: klienci mogą żądać danych rynkowych i konta od serwera. Wymaga klucza API i sekretu do uwierzytelniania; protokołem jest HTTPs.

Właściwości

API Binance ma 2 typy metod: publiczne i prywatne. Do metod publicznych można uzyskać dostęp bez uwierzytelniania, na przykład: pobieranie cen tickerów. Niektóre są prywatne i dotyczą danych użytkownika; te metody wymagają użycia kluczy API Binance.

• ApiKey: nowy klucz API można wygenerować na koncie Binance — wystarczy skopiować wartość do tej właściwości.
• ApiSecret: ApiSecret jest wymagany tylko dla REST_API; websocket API wymaga ApiKey jedynie dla niektórych metod.
• TestNet: jeśli włączone, połączy się z kontem demonstracyjnym Binance (domyślnie false).
  • HTTPLogOptions: przechowuje dziennik żądań HTTP w pliku tekstowym
    • Enabled: jeśli włączone, zapisuje wszystkie żądania HTTP interfejsu WebSocket API.
    • FileName: pełna ścieżka do pliku, w którym będą przechowywane dzienniki
    • REST: przechowuje dziennik żądań REST API w pliku tekstowym
      • Enabled: jeśli włączone, zapisuje wszystkie żądania HTTP interfejsu REST API.
      • FileName: pełna ścieżka do pliku, w którym będą przechowywane dzienniki.

• UserStream: jeśli włączone, klient będzie otrzymywać powiadomienia o aktualizacjach konta, zleceń lub salda (domyślnie true).
• BinanceUS: jeśli jest włączone, połączenie zostanie nawiązane z serwerami Binance.us (zamiast domyślnych serwerów Binance.com).
• ListenKeyOnDisconnect: ta właściwość określa, co należy zrobić po rozłączeniu klienta z serwerami Binance przy aktywnym kluczu ListenKey.
  • blkodDeleteListenKey: Usuwa aktywny klucz ListenKey, wysyłając żądanie HTTP do serwerów Binance (opcja domyślna).
  • blkodClearListenKey: Nie usuwa klucza ListenKey z serwerów Binance i jedynie czyści wartość pola.
  • blkodDoNothing: Nie wykonuje żadnej akcji, więc przy następnym połączeniu z Binance zostanie podjęta próba użycia tego samego klucza ListenKey.
• UseCombinedStreams: jeśli włączone, strumienie będą łączone w następujący sposób: {"stream":"<streamName>","data":<rawPayload>} (domyślnie wyłączone)

Najczęstsze zastosowania

• WebSockets API
  • Jak połączyć się z WebSocket API
  • Jak subskrybować kanał WebSocket

• REST API

  • Jak pobierać dane rynkowe
  • Jak korzystać z prywatnego REST API
  • Jak handlować na rynku spot
  • Czas prywatnych żądań
  • Wypłata

WebSocket Stream API

Bazowy endpoint to wss://stream.binance.com:9443; klient może subskrybować zdarzenia i anulować subskrypcje po nawiązaniu pomyślnego połączenia.

Obsługiwane są następujące metody subskrypcji i anulowania subskrypcji.

Po pomyślnej subskrypcji / anulowaniu subskrypcji klient otrzymuje wiadomość o tym fakcie, gdzie id jest wynikiem metody Subscribed / Unsubscribed.

{
  "result": null,
  "id": 1
}

User Data Stream API

Wymaga prawidłowego ApiKey uzyskanego z konta Binance; ApiKey musi być ustawiony we właściwości Binance.ApiKey komponentu.

Następujące dane są wypychane do klienta za każdym razem, gdy nastąpi zmiana. Nie jest konieczna subskrypcja żadnej metody — odbywa się ona automatycznie po ustawieniu prawidłowego ApiKey.

REST API

Bazowy punkt końcowy to: https://api.binance.com. Wszystkie punkty końcowe zwracają obiekt lub tablicę JSON. Dane są zwracane w porządku rosnącym: od najstarszych do najnowszych.

Dostęp do opcji REST API przy użyciu właściwości REST_API.BinanceOptions.

Publiczne punkty końcowe API

Te punkty końcowe są dostępne bez żadnej autoryzacji.

Ogólne punkty końcowe

Punkty końcowe danych rynkowych

Prywatne punkty końcowe API

Wymaga podania APIKey i APISecret w celu autoryzacji przez serwer.

Punkty końcowe danych konta

Convert EndPoints

Wallet EndPoints

(*endpointy portfela działają wyłącznie z serwerem produkcyjnym, nie z wersją demonstracyjną)

Zdarzenia

Wiadomości Binance są odbierane w komponencie TsgcWebSocketClient; można używać następujących zdarzeń:

OnConnect

Po pomyślnym połączeniu z serwerem Binance.

OnDisconnect

Po rozłączeniu z serwerem Binance

OnMessage

Wiadomości wysyłane przez serwer do klienta są obsługiwane w tym zdarzeniu.

OnError

W przypadku wystąpienia błędu protokołu wywoływane jest to zdarzenie.

OnException

Jeżeli wystąpi nieobsługiwany wyjątek, zostanie wywołane to zdarzenie.

Dodatkowo w komponencie Binance API istnieje specyficzne zdarzenie o nazwie OnBinanceHTTPException, wywoływane za każdym razem, gdy wystąpi błąd podczas wywołania żądania HTTP (REST API lub strumień użytkownika WebSocket).

(*) Ze względu na zmiany na serwerach Binance, wersje Indy starsze niż Rad Studio 10.1 nie będą mogły łączyć się z serwerami testowymi. Problem ten nie dotyczy wersji Enterprise ani przypadku, gdy wersja Indy została zaktualizowana do najnowszej.