support.supper.feed.listCandidates

supper.support

Documentation

List public feed candidates indexed by the Supper AppView for a bounded set of author DIDs. No authentication is required. This discovery projection includes site.standard.document and support.supper.poll.poll records; source records remain authoritative and consumers must enforce their own moderation and access rules.

main query

List public feed candidates indexed by the Supper AppView for a bounded set of author DIDs. No authentication is required. This discovery projection includes site.standard.document and support.supper.poll.poll records; source records remain authoritative and consumers must enforce their own moderation and access rules.

Parameters

authors array of string Required

Author DIDs whose indexed public records may be returned.

before string datetime Required

Inclusive immutable upper bound for this feed snapshot.

cursor string Optional

Opaque keyset cursor from a previous response.

limit integer Optional

No description available.

sources array of string Required

No description available.

Output

Encodingapplication/json
candidates array Required

No description available.

cursor string Optional

No description available.

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
Author DIDs whose indexed public records may be returned.
Inclusive immutable upper bound for this feed snapshot.
Opaque keyset cursor from a previous response.
View raw schema
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "candidates"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "maxLength": 8192
        },
        "candidates": {
          "type": "array",
          "items": {
            "refs": [
              "#standardSiteCandidate",
              "#pollCandidate"
            ],
            "type": "union",
            "closed": false
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "authors",
      "sources",
      "before"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "before": {
        "type": "string",
        "format": "datetime",
        "description": "Inclusive immutable upper bound for this feed snapshot."
      },
      "cursor": {
        "type": "string",
        "maxLength": 8192,
        "description": "Opaque keyset cursor from a previous response."
      },
      "authors": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "maxLength": 100,
        "minLength": 1,
        "description": "Author DIDs whose indexed public records may be returned."
      },
      "sources": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 32,
          "knownValues": [
            "standard-site",
            "poll"
          ]
        },
        "maxLength": 2,
        "minLength": 1
      }
    }
  },
  "description": "List public feed candidates indexed by the Supper AppView for a bounded set of author DIDs. No authentication is required. This discovery projection includes site.standard.document and support.supper.poll.poll records; source records remain authoritative and consumers must enforce their own moderation and access rules."
}
plyrEmbed object

No description available.

Properties

url string uri Required

Validated public URL of the Plyr track embedded by the source document.

View raw schema
{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Validated public URL of the Plyr track embedded by the source document."
    }
  }
}
pollCandidate object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

CID of the exact support.supper.poll.poll generation represented by this candidate.

options array of string Required

No description available.

maxLength: 10 itemsminLength: 2 items
question string Required

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
sortAt string datetime Required

An RFC 3339 formatted timestamp.

uri string at-uri Required

AT URI of the indexed support.supper.poll.poll source record.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "sortAt",
    "question",
    "options"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact support.supper.poll.poll generation represented by this candidate."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the indexed support.supper.poll.poll source record."
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "sortAt": {
      "type": "string",
      "format": "datetime"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 1000,
        "maxGraphemes": 100
      },
      "maxLength": 10,
      "minLength": 2
    },
    "question": {
      "type": "string",
      "maxLength": 3000,
      "maxGraphemes": 300
    }
  }
}
pollEmbed object

No description available.

Properties

cid string cid Required

CID of the exact embedded support.supper.poll.poll record generation.

uri string at-uri Required

AT URI of the support.supper.poll.poll record embedded by the source document.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact embedded support.supper.poll.poll record generation."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the support.supper.poll.poll record embedded by the source document."
    }
  }
}
standardSiteCandidate object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

cid string cid Required

CID of the exact site.standard.document generation represented by this candidate.

sortAt string datetime Required

An RFC 3339 formatted timestamp.

sourceEmbeds array of union Required

No description available.

maxLength: 16 items
Known types:
uri string at-uri Required

AT URI of the indexed site.standard.document source record.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "sortAt",
    "sourceEmbeds"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the exact site.standard.document generation represented by this candidate."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the indexed site.standard.document source record."
    },
    "author": {
      "type": "string",
      "format": "did"
    },
    "sortAt": {
      "type": "string",
      "format": "datetime"
    },
    "bskyPostRef": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    },
    "sourceEmbeds": {
      "type": "array",
      "items": {
        "refs": [
          "#pollEmbed",
          "#plyrEmbed"
        ],
        "type": "union",
        "closed": false
      },
      "maxLength": 16
    }
  }
}

Lexicon Garden

@