CHANGELOG.md

unicorn-binance-websocket-api Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

1.9.0.dev (development stage/unreleased)

Added

• python version in print_stream_info() and print_summary()

1.9.0

Added

• Endpoints for www.binance.com margin UserData listenkey issue #35

Changed

• Endpoints for www.binance.com spot UserData listenkey issue #35
• Endpoints for www.binance.com futures UserData listenkey issue #35

1.8.2

Fixed

• Errors when creating private DEX streams: issue #34

1.8.1

Changed

• moved docs to github pages

1.8.0

Added

• binance.com Futures websocket support and example_binance_futures.py and example_bookticker.py (issue#32)

1.7.0

Added

• binance.us websocket support and example_binance_us.py (issue#22)

1.6.6

Fixed

• Trailing / is no longer accepted by the endpoints: LUCIT-Systems-and-Development#31

1.6.5

Fixed

• 'websockets>=7.0' to 'websockets==7.0': Websockets 8 is released and it seems to be not compatible

1.6.4

Added

• amount of active streams to icinga status msg

Fix

• RuntimeError in _frequent_checks

1.6.3

Fix

• 'except websockets.exceptions.InvalidStatusCode as error_msg:' moved to right place

1.6.2

Fix

• 'except websockets.exceptions.InvalidStatusCode as error_msg:' in connnection line 97 with restart
• 'except KeyError:' in connection line 162

1.6.1

Fix

• get_monitoring_status_plain(): exception for outdated UnicornFy

1.6.0

Added

• is_update_availabe_check_command()
• get_latest_version_check_command()
• get_latest_release_info_check_command()

Changed

• get_monitoring_status_plain()
• get_monitoring_status_icinga()
• _start_monitoring_api()

Removed!

• https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/blob/master/tools/icinga/ (to https://github.com/oliver-zehentleitner/check_unicorn_monitoring_api)

1.5.0

Added

• support for binance.org and testnet.binance.org websockets
• exchange name to icinga status msg
• binance_manager init: throw exception for unknown exchanges
• get_current_receiving_speed()
• exchange name and lib version to print_stream_info()
• current_receiving_speed to print_summary() and print_stream_info()
• get_exchange()
• set_private_dex_config() (not in use for now)
• subscribe_to_stream() - (dont use in productive! Its not clean and will get rewritten and maybe change behaviour)
• unsubscribe_from_stream() - (dont use in productive! Its not clean and will get rewritten and maybe change change behaviour)
• _create_payload()

Changed

• rewrite create_websocket_url():
  1. a multiplex socket now returns false if it includes a single stream type like !userData, !Ticker or !miniTicker
  2. added support for binance.org Binance Chain DEX
• is_websocket_uri_length_valid() now always returns True for DEX websockets

1.4.0

Added

• support for binance.je (Binance Jersey) websockets
• logging on failure in create_stream()
• add_string in print_summary() and print_stream_info()
• warn_on_update in get_monitoring_status_icinga(), get_monitoring_status_plain() and start_monitoring_api()
• support for binance jersey LUCIT-Systems-and-Development#21
• show the used exchange in print_summary() and print_stream_info()

Fixed

• removed space from total_received_length in get_monitoring_status_icinga() to avoid 'no data' error in ICINGA

1.3.10

Added

• exception for asyncio.base_futures.InvalidStateError by DaWe35 LUCIT-Systems-and-Development#18

Changed

• create_stream() returns False if websocket URL is to long

Fixed

• is_websocket_uri_length_valid() to work with !userData on the pre test in create_stream() without api secrets

1.3.9

Changed

• Docstrings for markets and channels to support: str, tuple, list, set
• Fine tuning of perfdata output in get_monitoring_status_plain() and get_monitoring_status_icinga()

1.3.8

Added

• get_stream_buffer_length() by DaWe35 LUCIT-Systems-and-Development#12

Fixed

• the stream_buffer FIFO stack was a LIFO stack (Thanks to DaWe35 for recognizing and fixing this issue LUCIT-Systems-and-Development#12)
• get_stream_buffer_byte_size returns now the real size of the stream_buffer

1.3.7

Changed

• added round received items to 2 decimals instead of 0

1.3.6

• wrong version in manager class ...

1.3.5

Added

• is_manager_stopping()

Fixed

• is_update_available returns False if github API is not available.

1.3.4

Changed

• get_monitoring_status_icinga(): update check

1.3.3

Added

• get_monitoring_status_icinga(): reconnects and update check
• get_monitoring_status_plain()
• start_monitoring_api()
• 1 hour cache for release checks on github
• stop_monitoring_api()

Rewrite

• ./tools/icinga/check_binance_websocket_api_manager (check_command for ICINGA)

Changed

• example_monitoring.py

1.3.2

Added

• example_monitoring.py and tools/check_binance_websocket_api_manager
• get_monitoring_status_icinga tests for available updates and changes the return_code to WARNING if an update is available. but i recognized an API ban from github in cause of too many requests. i have to extend it ...

Changed

• get_monitoring_status_icinga: changed status dict node to return_code

1.3.1

Changed

• changing output of get_monitoring_status_icinga

1.3.0

Added

• get_monitoring_status_icinga() in manager class

1.2.8

Added

• lib version to print_summary()

Fixed

• Typo in text in print_summary()
• KeyError in manager class row 148

1.2.7

Fixed

• Bug in class UnicornFy: kline_close_time had the value kline_start_time

Changed

• Moved UnicornFy from UNICORN Binance WebSocket API to its own repository
• connection handling (improved)

1.2.6

Fixed

• markets in keepalive listen_key can come as str or as list and the routine only handled it as list, now str gets converted to list to keep the function working

1.2.5

Added

• "UTC" text to printed times

Fixed

• listen_key 30 min cache

1.2.4

Added

• method to delete a listen_key
• binance_api_status added to print_stream_info()

Changed

• README.md

1.2.3

Changed

• rewrite coloring for status_code in print_summary
• ping_interval from None to 20 seconds

Fixed

• listen_key keepalive didnt work propper

1.2.2

Fixed

• TypeError in print_summary()

1.2.1

Added

• handling for status_code and used_weight from the binance REST Api (used for listen_key) - see get_binance_api_status()

Fixed

• reconnect issues

Changed

• log levels

1.2.0

Changed

• if no method is provided to BinanceWebSocketApiManager when creating the instance, then all data will be written to the stream_buffer.
• comments and code in examples

1.1.20

Changed

• show stream_buffer content if items len > 50

Removed

• removed stream_buffer log

1.1.19

Change

• renamed get_stream_data_from_stream_buffer to pop_stream_data_from_stream_buffer

Fixed

• IndexError in pop_stream_data_from_stream_buffer

1.1.18

Removed

• _forward_stream_buffer_data: system change - no pushing anymore, its better to buffer everything and run a import class in a separate thread, that is able to reconnect to the database

1.1.17

Changed

• rewrite of keepalive and frequentchecks restarts

1.1.16

Changed

• stream_buffer logging: log amount of items in buffer

1.1.15

Changed

• stream_buffer logging: log amount of items in buffer

Fixed

• added two mac os specific exceptions to connection class for better reconnect management

1.1.14

Fixed

• updated the "update" methods in manager class (error handling while no internet connection)
• trying other behaviour on `400 - bad request' error
• added handling for -2015 error from get_listen_key_from_restclient in create_websocket_uri

1.1.13

Changed

• changed the waiting time before setting a restart request on 400 error to 5 seconds in connection class

Fixed

• replaced tabs in print_summary() with blanks

1.1.12

Fixed

• KeyError in unicorn_binance_websocket_api_connection.py error exception 414
• UnicornFy was very buggy with ticker and miniTicker handling

1.1.11

Fixed

• KeyError in unicorn_binance_websocket_api_manager.py

1.1.10

Added

• restarting streams row to print_summary()
• show active restarting and stopped streams only if not 0
• error message handling for userData streams
• reconnect depends from disconnect reason now (network or api-settings)

Fixed

• del restart request in stop_stream()

1.1.9

Fixed

• !miniTicker and !userData didnt work in cause of lower case all currencies. added an exception for them.

1.1.8

Added

• pypi_install_packaging_tools.sh

Changed

• README.md
• Removed 2nd argument from binance_websocket_api_manager.stream_is_stopping()

Fixed

• Tabs in print_summary() for windows platform
• Fixing format errors from auto reformat in unicorn_binance_websocket_api_connection

1.1.7 failed build

1.1.6

Fixed

• Catching "ssl.SSLError" BinanceWebSocketApiConnection.receive()
• Improvment of reconnect on invalid URI caused by no network issue and a missing listen_key from Binance

1.1.5

Added

• 30 min cache for Binance "listenKey" from rest api to avoid weight costs and hammering the Binance API on a flapping network connection

Fixed

• Reconnect issue on userData stream
• Reset "has_stopped" attr from "stream_list" after a conncection restart
• Modyfied docstrings descriptions
• Tabs in print_summary() on windows