# pub.chive.subscription.getStatus

> Published by [lexicons.governance.chive.pub](https://lexicon.garden/identity/did:plc:egjghlwgts2hlcer2txilxeh)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.subscription.getStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.subscription.getStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.subscription.getStatus/examples)

## Definitions

### `pub.chive.subscription.getStatus`

**Type**: `query`

Subscriber count for an author, and whether a given reader is among them. Subscriptions are site.standard.graph.subscription records written into readers' own repositories; Chive indexes them from the firehose and neither writes nor owns them.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | DID of the author whose publications are subscribed to |
| `viewerDid` | `string` (did) | No | Reader to report a subscription status for; omitted when nobody is signed in |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `publicationUri` | `string` (at-uri) | No | The author's publication record, when they have one. A reader needs it to write a subscription of their own. |
| `subscribed` | `boolean` | Yes | Whether viewerDid subscribes. False when no viewer was given. |
| `subscriberCount` | `integer` | Yes | Distinct readers subscribed, not records: an author may hold several publications and a reader following two of them is one follower. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Subscriber count for an author, and whether a given reader is among them. Subscriptions are site.standard.graph.subscription records written into readers' own repositories; Chive indexes them from the firehose and neither writes nor owns them.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "publicationUri": {
              "description": "The author's publication record, when they have one. A reader needs it to write a subscription of their own.",
              "format": "at-uri",
              "type": "string"
            },
            "subscribed": {
              "description": "Whether viewerDid subscribes. False when no viewer was given.",
              "type": "boolean"
            },
            "subscriberCount": {
              "description": "Distinct readers subscribed, not records: an author may hold several publications and a reader following two of them is one follower.",
              "type": "integer"
            }
          },
          "required": [
            "subscriberCount",
            "subscribed"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "did": {
            "description": "DID of the author whose publications are subscribed to",
            "format": "did",
            "type": "string"
          },
          "viewerDid": {
            "description": "Reader to report a subscription status for; omitted when nobody is signed in",
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "did"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "pub.chive.subscription.getStatus",
  "lexicon": 1,
  "revision": 1
}
```