---
title: "WebSocket endpoint connection information"
method: GET
path: "/api/v1/rt/ws/info"
tags: ["Real-Time Data"]
---

# WebSocket endpoint connection information

`GET /api/v1/rt/ws/info`

## Request

- Base URL: `https://api.phys.ucalgary.ca` (the document declares no server; this is the origin it was published from)
- URL: `https://api.phys.ucalgary.ca/api/v1/rt/ws/info`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api/docs/api/v1/rt/ws/info/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve connection details and protocol documentation for the real-time
data WebSocket endpoint.

The WebSocket endpoint itself is at `/api/v1/rt/ws` and is not shown in
the OpenAPI schema because WebSocket routes are not part of the OpenAPI
specification. This endpoint provides the protocol documentation instead.

## Response `200`

WebSocket protocol documentation

- RTWebSocketInfo
  - `url` string, required
  - `protocol` string, required
  - `description` string, required
  - `subscribe_message` object, required
  - `unsubscribe_message` object, required
  - `binary_format` string, required
  - `json_format` object, required

## Other responses

- `500`: Unexpected server error

---

[API](https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api.md) - [All operations](https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api/revisions/e451a425b5eb?raw)