---
title: "Get ranked chat mutualities and message suggestions"
method: GET
path: "/v1/chat/mutualities"
tags: ["chat"]
---

# Get ranked chat mutualities and message suggestions

`GET /v1/chat/mutualities`

## Request

- Base URL: `https://app.legend.trade/api/rest`
- URL: `https://app.legend.trade/api/rest/v1/chat/mutualities`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/legend/apis/legend-api/docs/v1/chat/mutualities/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `userIds` string[], required
- `locale` 'en' | 'fr' | 'th' | 'ko' | 'ja' | 'zh-CN' | 'de' | 'es'

## Response `200`

Successful response

- ChatMutualitiesOutput
  - `rotates_at` string, date-time, required
  - `results` ChatMutualitiesResult[], required
    - `user_id` string, uuid, required
    - `status` 'ok' | 'unavailable', required
    - `mutualities` ChatMutuality[], required
      - `type` union, required
        - 'shared_follows' | 'shared_token_pnl' | 'shared_open_orders' | 'shared_open_positions' | 'shared_top_volume_assets' | 'shared_autocopy_targets'
        - string
      - `total` integer, required
      - `assets` ChatMutualityAsset[], required
        - `symbol` string, required
        - `viewer_side` 'LONG' | 'SHORT', nullable, required
        - `user_side` 'LONG' | 'SHORT', nullable, required
        - `outcome` 'profit' | 'loss', nullable, required
      - `users` ChatMutualityUser[], required
        - `id` string, uuid, required
        - `username` string, nullable, required
        - `display_name` string, required
        - `avatar_url` string, required
    - `suggestions` ChatMessageSuggestion[], required
      - `id` string, required
      - `kind` union, required
        - 'contextual' | 'neutral'
        - string
      - `text` string, required
      - `mutuality_type` union, required
        - 'shared_follows' | 'shared_token_pnl' | 'shared_open_orders' | 'shared_open_positions' | 'shared_top_volume_assets' | 'shared_autocopy_targets'
        - string

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

## Changes

> 113 revisions in range; 1 not diffed.

- **2026-11-04** `cea96c83cd34`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/legend/apis/legend-api/changes/v1/chat/mutualities/get.md)

---

[API](https://skmtc.dev/legend/apis/legend-api.md) - [All operations](https://skmtc.dev/legend/apis/legend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/legend/apis/legend-api/revisions/965e2d0a9c7d?raw)