Bug: binance-sdk-spot returns "UserDataStreamSubscribeSignatureResponse' object has no attribute 'get'"

[nikita-doronin]

Packeges:

binance-sdk-spot==8.2.0
binance-common==3.8.0
Python: 3.14

Bug description:

At binance-sdk-spot the both methods user_data_stream_subscribe_signature() and user_data_stream_subscribe() in websocket_api.py crash with AttributeError because they call .get() on a Pydantic BaseModel object, which does not have a .get() method:

# binance_sdk_spot/websocket_api/websocket_api.py
response = await self._userDataStreamApi.user_data_stream_subscribe_signature(
    id, recv_window
)
data = response.data()
if data.get("result") is None or data.get("error") is not None:  # <-- BUG
    raise ValueError(data)

response.data() returns a UserDataStreamSubscribeSignatureResponse instance, which is a Pydantic BaseModel (defined in websocket_api/models/user_data_stream_subscribe_signature_response.py). Pydantic models do not have a .get() method - that is a dict method. The same bug exists for the non-signature variant user_data_stream_subscribe().

Suggested fix:

# if data.get("result") is None or data.get("error") is not None: # <-- delete this 

if data.result is None or getattr(data, "error", None) is not None: # <-- add this

The identical fix applies to both line 3036 user_data_stream_subscribe() and line 3075 user_data_stream_subscribe_signature().

[nikita-doronin]

Temporary working solution I made with call the low-level API directly:

# Tempporary imports for WebSocket API user data stream subscription (SDK bug workaround):
from binance_common.websocket import RequestStream
from binance_common.models import WebsocketApiUserDataStreamResponse
from binance_sdk_spot.websocket_api.models import UserDataStreamEventsResponse

    async def subscribe_websocket_api_user_data(self):

        self._stop_event.clear()

        while not self._stop_event.is_set():
            try:
                self.connection_ws_api = await self.client_ws_api.websocket_api.create_connection()

                # Bypass the buggy high-level wrapper (SDK bug: calls .get() on a Pydantic model).
                # Call the low-level API directly and replicate the wrapper logic with correct attribute access.
                response = await self.connection_ws_api._userDataStreamApi.user_data_stream_subscribe_signature()
                data = response.data()

                if data.result is None:
                    raise ValueError(f'user_data_stream_subscribe_signature failed: {data}')

                stream = await RequestStream(
                    self.connection_ws_api,
                    data.result.subscription_id,
                    response_model=UserDataStreamEventsResponse,
                )
                res = WebsocketApiUserDataStreamResponse(response=response, stream=stream)

                print(f'res: {res}')
                print(f'response: {response}')
                print(f'rate_limits: {response.rate_limits}')
                print(f'data: {data}')

                res.stream.on("message", lambda data: print(f"{data}"))
   
                # Wait until stop is signaled:
                await self._stop_event.wait()

                # await res.stream.unsubscribe()

            except asyncio.CancelledError:
                break
            except Exception as e:
                print(e)
                await asyncio.sleep(1)
                del e
                pass
            finally:
                if self.connection_ws_api:
                    await self.connection_ws_api.close_connection(close_session=True)

[alplabin]

Hi @nikita-doronin,
Thanks for bringing this up. This has been updated in binance-sdk-spot v8.2.1.