Send headers in Websockets connection request from Python client

Question

What is the correct method / syntax for adding headers to a websocket connection request using Python Websockets ?

The server I'm trying to connect to requires headers in the connection request for authentication

async def connect():
    async with websockets.connect("wss://site.com/ws") as websocket:
        response = await websocket.recv()
        print(response)

    # eg. does not work:
    async with websockets.connect(f"wss://site.com/ws, header={headers}") as websocket:
    async with websockets.connect(f"wss://site.com/ws, extra_headers:{headers}") as websocket:

Similar question was asked here but did not answer the core of the question: How to send 'Headers' in websocket python

Vedprakash Upraity · Accepted Answer · 2025-04-21 20:50:18Z

12

According to documentation, you can pass headers in additional_headers param of connect() function. Details here.

So code should look something like this:

async def connect():
    async with websockets.connect("wss://site.com/ws", additional_headers=headers) as websocket:
        response = await websocket.recv()
        print(response)

edited Apr 21 at 20:50

Vedprakash Upraity

5994 silver badges9 bronze badges

answered Oct 13, 2021 at 12:23

impenetrabl1

1361 silver badge4 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Christina Unger Over a year ago

Note that in recent versions the argument is called additional_headers.

André Duarte · Accepted Answer · 2024-11-24 01:40:35Z

3

In more recent versions the library's api changed and now they use the argument additional_headers to add new headers:

async def connect():
    async with websockets.connect("wss://site.com/ws", additional_headers=headers) as websocket:
        response = await websocket.recv()
        print(response)

Reference: https://websockets.readthedocs.io/en/stable/reference/asyncio/client.html#opening-a-connection

answered Nov 24, 2024 at 1:40

André Duarte

714 bronze badges

Comments

seppedl · Accepted Answer · 2020-12-30 16:06:04Z

-3

First create a websocket using websockets.connect.
Then send the JSON header in websocket.send(header)
And then start processing the responses.

This should work:

async def connect():
    async with websockets.connect("wss://site.com/ws") as websocket:
        await websocket.send(header)
        response = await websocket.recv()
        print(response)

answered Dec 30, 2020 at 16:06

seppedl

11 bronze badge

Collectives™ on Stack Overflow

Send headers in Websockets connection request from Python client

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related