hatk.dev / hatk
AppView in a box as a Vite plugin thing hatk.dev
fork atom
hatk / docs / site / api / feeds.md
at main 1.3 kB view raw view code
chadtmiller.com docs: complete docs overhaul for current API surface
0e7be988

title: Feeds description: Feed API endpoints.#

dev.hatk.getFeed#

Retrieve a named feed of items.

  • Type: Query (GET)
  • Auth: None

Parameters#

Name Type Required Default Description
feed string Yes — Feed name
limit integer No 30 Results per page (1–100)
cursor string No — Pagination cursor

Example#

curl "http://127.0.0.1:3000/xrpc/dev.hatk.getFeed?feed=recent&limit=20"

import { callXrpc } from "$hatk/client";

const { items, cursor } = await callXrpc("dev.hatk.getFeed", {
  feed: "recent",
  limit: 20,
});

Response#

{
  "items": [ ... ],
  "cursor": "..."
}

dev.hatk.describeFeeds#

List all available feeds.

  • Type: Query (GET)
  • Auth: None
  • Parameters: None

Example#

curl "http://127.0.0.1:3000/xrpc/dev.hatk.describeFeeds"

Response#

{
  "feeds": [
    { "name": "recent", "label": "Recent" },
    { "name": "popular", "label": "Popular" }
  ]
}

See Feeds guide for how to define feeds with defineFeed().