pub.oysters.getFeed

A page of the board's feed. Public: no authentication, and the same answer for everybody.

pub.oysters.getFeed

query

A page of the board's feed. Public: no authentication, and the same answer for everybody.

Parameters

field	type	about
sort	string	Ranking to page through. 'hot' is the board's own ranking; 'new' is submission order. default "hot"known "hot" \| "new"
tags	string[]	Restrict to submissions carrying any of these tags. OR, not AND. Tags outside the curated vocabulary are an error rather than an empty page, so a typo is visible. maxItems 10items: maxLength 128
limit	integer	How many submissions to return. min 1max 100default 25
cursor	string	Opaque. Pass back what the previous page returned; do not construct one.

Output · application/json

field	type	about
cursor	string	Pass to the next call. Absent when there is nothing more.
feedrequired	defs#postView[]	The page, in ranking order.

Errors

InvalidRequest

An unknown tag, an unknown sort, or a cursor that did not decode.

Raw document

{
  "lexicon": 1,
  "id": "pub.oysters.getFeed",
  "defs": {
    "main": {
      "type": "query",
      "description": "A page of the board's feed. Public: no authentication, and the same answer for everybody.",
      "parameters": {
        "type": "params",
        "properties": {
          "sort": {
            "type": "string",
            "description": "Ranking to page through. 'hot' is the board's own ranking; 'new' is submission order.",
            "knownValues": [
              "hot",
              "new"
            ],
            "default": "hot"
          },
          "tags": {
            "type": "array",
            "description": "Restrict to submissions carrying any of these tags. OR, not AND. Tags outside the curated vocabulary are an error rather than an empty page, so a typo is visible.",
            "maxLength": 10,
            "items": {
              "type": "string",
              "maxLength": 128
            }
          },
          "limit": {
            "type": "integer",
            "description": "How many submissions to return.",
            "minimum": 1,
            "maximum": 100,
            "default": 25
          },
          "cursor": {
            "type": "string",
            "description": "Opaque. Pass back what the previous page returned; do not construct one."
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "feed"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "description": "Pass to the next call. Absent when there is nothing more."
            },
            "feed": {
              "type": "array",
              "description": "The page, in ranking order.",
              "items": {
                "type": "ref",
                "ref": "pub.oysters.defs#postView"
              }
            }
          }
        }
      },
      "errors": [
        {
          "name": "InvalidRequest",
          "description": "An unknown tag, an unknown sort, or a cursor that did not decode."
        }
      ]
    }
  }
}