pub.chive.subscription.getStatus

lexicons.governance.chive.pub

Documentation

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.

main 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

did string did Required

DID of the author whose publications are subscribed to

viewerDid string did Optional

Reader to report a subscription status for; omitted when nobody is signed in

Output

Encodingapplication/json
publicationUri stringat-uri Optional

The author's publication record, when they have one. A reader needs it to write a subscription of their own.

subscribed boolean Required

Whether viewerDid subscribes. False when no viewer was given.

subscriberCount integer Required

Distinct readers subscribed, not records: an author may hold several publications and a reader following two of them is one follower.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
DID of the author whose publications are subscribed to
Reader to report a subscription status for; omitted when nobody is signed in
View raw schema 
{
  "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"
}

Lexicon Garden

@