# app.bivri.feed.getRelatedTags

> Published by [lexicons.bivri.app](https://lexicon.garden/identity/did:plc:uqat5a7hrbww3snbbinxgwah)

✓ This is the authoritative definition for this NSID.

## Description

Get tags that frequently appear together with a given tag, ranked by co-occurrence count.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.feed.getRelatedTags)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.feed.getRelatedTags/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.feed.getRelatedTags/examples)

## Definitions

### `app.bivri.feed.getRelatedTags`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tag` | `string` | Yes | Tag to find companions for. |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tags` | `array` | Yes |  |

### `app.bivri.feed.getRelatedTags#tagCount`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tag` | `string` | Yes |  |
| `artworkCount` | `integer` | Yes |  |

## Raw Schema

```json
{
  "id": "app.bivri.feed.getRelatedTags",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "tags"
          ],
          "properties": {
            "tags": {
              "type": "array",
              "items": {
                "ref": "#tagCount",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "tag"
        ],
        "properties": {
          "tag": {
            "type": "string",
            "description": "Tag to find companions for."
          },
          "limit": {
            "type": "integer",
            "default": 10,
            "maximum": 20,
            "minimum": 1
          }
        }
      }
    },
    "tagCount": {
      "type": "object",
      "required": [
        "tag",
        "artworkCount"
      ],
      "properties": {
        "tag": {
          "type": "string"
        },
        "artworkCount": {
          "type": "integer"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Get tags that frequently appear together with a given tag, ranked by co-occurrence count."
}
```