---
title: "Welcome"
url: https://docs.truemarkets.co/api/websocket/institutional/welcome
description: "Message received when connecting to the server and establishing a websocket connection."
---

Docs index: https://docs.truemarkets.co/llms.txt

# Welcome

True Markets CeFi WebSocket sends these messages to you.

Address: `/v1/cefi/market`

## Servers

- `wss://api.truemarkets.co` (Production, wss)
- `wss://api.uat.truemarkets.co` (Uat, wss)

## Messages

### welcome

Payload: `WelcomePayload`

Example payload:

```json
{
  "connections": "string",
  "channel": "WEBSOCKET",
  "update": "WELCOME",
  "message": "string",
  "version": "string",
  "datetime": "string"
}
```

## Types

```ts
export type WelcomeMessage = WelcomePayload;

export interface WelcomePayload {
  /** Current number of active connections from the source IP. */
  connections?: string;

  /** Channel this message originated from. */
  channel?: "WEBSOCKET";

  /** Type of update for the current message. */
  update?: "WELCOME";

  /** Message supplied when initiating a connection with the server. */
  message?: string;

  /** Current version of the websocket API. */
  version?: string;

  /** Current datetime of when the server sent the message, */
  datetime?: string;
}
```