WebSocket.IN

WebSocket.IN Documentation

THE OPEN AND FREE WEBSOCKET SERVER FOR ALL.


Overview

WebSocket.in is an open WebSocket server, anyone can create an account and generate an API key to start using the server. There is no additional plugin or library installation required in your app to use the WebSocket.in server.

Followning URL is all you need.

{primary} wss://connect.websocket.in/v3/CHANNEL_ID?apiKey=API_KEY

Copy the WebSocket server URL below, replace CHANNEL_ID (it can be any positive integer) and API_KEY

Try it

{info} Want to test the server without writing any code?

You can use the Online Websocket Tester.

This tool can be used to test other websocket servers too.

Parameters

API Key

You can generate API Keys from your Websocket.in account for free

You can generate at most two api keys that can be used for multiple projects Not required, but you shoud hide your token while using it on the client-side (Javascript).

Channel ID

It should be a positive integer between 1-10000.

When a message is sent by a user, it is passed to only the members of the sender's channel.

For example: Let's say you are using two WebSocket.in endpoints,

  • wss://connect.websocket.in/v3/1998?apiKey=hidden
  • wss://connect.websocket.in/v3/1999?apiKey=hidden.

Suppose, there are 5 users connected to each channel. When a user from channel 1998 sends a message, it is recieved by other 4 members of the channel 1998 only (Your own messages are not recieved by you).

Choosing a channel:

  • Channel ID can be any number between 1-10000
  • Change Channel ID when you want to isolate a group of users for data transmission.
  • Sender of a message will not receive their own message.

Code Samples

Following code samples demonstrate how to connect to WebSocket.IN server using various programming languages.

Javascript

var socket = new WebSocket("wss://connect.websocket.in...");

Android/Java

private void start() {
    Request request = new Request.Builder().url("wss://connect.websocket.in...").build();
    EchoWebSocketListener listener = new EchoWebSocketListener();
    WebSocket ws = client.newWebSocket(request, listener);
    client.dispatcher().executorService().shutdown();
}

Reference:https://medium.com/@ssaurel/learn-to-use-websockets-on-android-with-okhttp-ba5f00aea988


iOS/Swift

var socket = WebSocket(url: URL(string: "wss://connect.websocket.in...")!, protocols: ["chat"])

Reference:https://www.raywenderlich.com/861-websockets-on-ios-with-starscream


Rate Limit

Rate limit depends upon the pricing plan you are on, see all here

The free plan has a rate limit of 30 messages/minutes.


Frequently Asked Questions

Is WebSocket.in free?

Yes, we have a free version.

How many API Keys can I use?

You can have 2 api keys per account with any of the plans.

Can anyone connect to my channel?

Yes, if they have your api key. You can protect your api key using hostname validation feature.

I'm having troubles with the Websocket

You can test your websocket connection issues with the Online websocket tester. The tool helps you to send and receive data through the Websocket connection.

Will WebSocket.in always be free?

Yes! We recently launched paid plans on request of our users but there is always going to be a free plan.


Let us know on Slack what we can do to make the docs and our services better ,Thank you!

Grab your Websocket.IN account to create API keys, create an account.