# StreamsApi

All URIs are relative to *https://fsb.generalresearch.com*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**websocketDebugPageWsDebugGet**](#websocketdebugpagewsdebugget) | **GET** /ws/debug/ | Websocket Debug Page|
|[**websocketEventsDocsWsEventsDocsGet**](#websocketeventsdocswseventsdocsget) | **GET** /ws/events/docs/ | Websocket Events Docs|

# **websocketDebugPageWsDebugGet**
> string websocketDebugPageWsDebugGet()


### Example

```typescript
import {
    StreamsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let productId: string; // (default to undefined)

const { status, data } = await apiInstance.websocketDebugPageWsDebugGet(
    productId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] |  | defaults to undefined|


### Return type

**string**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/html, application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **websocketEventsDocsWsEventsDocsGet**
> ResponseWebsocketEventsDocsWsEventsDocsGet websocketEventsDocsWsEventsDocsGet()

WebSocket endpoint: `/ws/events/`  Protocol: - Client connects - Client sends a SubscribeMessage `{ kind: \"subscribe\", product_id: \"{product_id}\" }` - Server sends a PingMessage `{ kind: \"ping\" }` - Client must reply a PongMessage: `{ kind: \"pong\" }` - Other messages are EventMessage or StatsMessage  Close on missing pong after 20s.

### Example

```typescript
import {
    StreamsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

const { status, data } = await apiInstance.websocketEventsDocsWsEventsDocsGet();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ResponseWebsocketEventsDocsWsEventsDocsGet**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)