fyi.opensocial.listSiteRecords

lexicons.opensocial.fyi

Documentation

Records of one collection from the host's index, newest first. Without `repo`, a collection the group's site declares it reads, from the group (answered to anyone) or its members (members only). With `repo`, that one account's records — the group's or a member's — of any collection, kept on demand once asked for; members only. `field` and `equals` keep only records whose field (a name, or a path like subject.uri) equals that value. With `from: "network"`, everyone's records of the collection, from every account on the network that writes it: answered to anyone once the host keeps it, which it does from when a saved page declares it, unless too many accounts write it; `filling` says it is still being gathered. With `repos`, each of those accounts' newest record of any collection, such as each one's profile, answered to anyone; an account not heard from in time is left out, and fills in for the next read.

main query

Records of one collection from the host's index, newest first. Without `repo`, a collection the group's site declares it reads, from the group (answered to anyone) or its members (members only). With `repo`, that one account's records — the group's or a member's — of any collection, kept on demand once asked for; members only. `field` and `equals` keep only records whose field (a name, or a path like subject.uri) equals that value. With `from: "network"`, everyone's records of the collection, from every account on the network that writes it: answered to anyone once the host keeps it, which it does from when a saved page declares it, unless too many accounts write it; `filling` says it is still being gathered. With `repos`, each of those accounts' newest record of any collection, such as each one's profile, answered to anyone; an account not heard from in time is left out, and fills in for the next read.

Parameters

collection string nsid Required

A namespaced identifier (e.g., app.bsky.feed.post).

cursor string Optional

With `from: "network"`: from the last page, for older records.

equals string Optional

No description available.

field string Optional

Only records whose field (a name or a dotted path) equals `equals`.

from string Optional

Without `repo`: the group's records, its members', or everyone's on the network.

group string did Required

A decentralized identifier (DID).

limit integer Optional

No description available.

repo string did Optional

One account's records: the group's or a member's.

repos array of string Optional

Many accounts, anyone's: each one's newest record of the collection.

search string Optional

With `from: "network"`: records whose words have any of these words, "quoted phrases" kept together, a trailing * for a prefix, and AND, OR and NOT for more.

sort string Optional

With `from: "network"` and a search: newest first, or the most relevant first.

Output

Encodingapplication/json
cursor string Optional

With `from: "network"`, when there are older records.

filling boolean Optional

With `from: "network"`: the host is still gathering the collection, so older records may be missing.

records array Required

No description available.

Errors

NotFound
NotDeclared
NotAuthorized
NotKept
TooLarge
TooMany
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
A namespaced identifier (e.g., app.bsky.feed.post).
With `from: "network"`: from the last page, for older records.
Only records whose field (a name or a dotted path) equals `equals`.
Without `repo`: the group's records, its members', or everyone's on the network.
A decentralized identifier (DID).
One account's records: the group's or a member's.
Many accounts, anyone's: each one's newest record of the collection.
With `from: "network"`: records whose words have any of these words, "quoted phrases" kept together, a trailing * for a prefix, and AND, OR and NOT for more.
With `from: "network"` and a search: newest first, or the most relevant first.
View raw schema 
{
  "description": "Records of one collection from the host's index, newest first. Without `repo`, a collection the group's site declares it reads, from the group (answered to anyone) or its members (members only). With `repo`, that one account's records — the group's or a member's — of any collection, kept on demand once asked for; members only. `field` and `equals` keep only records whose field (a name, or a path like subject.uri) equals that value. With `from: \"network\"`, everyone's records of the collection, from every account on the network that writes it: answered to anyone once the host keeps it, which it does from when a saved page declares it, unless too many accounts write it; `filling` says it is still being gathered. With `repos`, each of those accounts' newest record of any collection, such as each one's profile, answered to anyone; an account not heard from in time is left out, and fills in for the next read.",
  "errors": [
    {
      "name": "NotFound"
    },
    {
      "name": "NotDeclared"
    },
    {
      "name": "NotAuthorized"
    },
    {
      "name": "NotKept"
    },
    {
      "name": "TooLarge"
    },
    {
      "name": "TooMany"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "With `from: \"network\"`, when there are older records.",
          "type": "string"
        },
        "filling": {
          "description": "With `from: \"network\"`: the host is still gathering the collection, so older records may be missing.",
          "type": "boolean"
        },
        "records": {
          "items": {
            "ref": "#siteRecord",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "records"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "collection": {
        "format": "nsid",
        "type": "string"
      },
      "cursor": {
        "description": "With `from: \"network\"`: from the last page, for older records.",
        "maxLength": 1024,
        "type": "string"
      },
      "equals": {
        "maxLength": 2048,
        "type": "string"
      },
      "field": {
        "description": "Only records whose field (a name or a dotted path) equals `equals`.",
        "maxLength": 128,
        "type": "string"
      },
      "from": {
        "description": "Without `repo`: the group's records, its members', or everyone's on the network.",
        "knownValues": [
          "group",
          "members",
          "network"
        ],
        "type": "string"
      },
      "group": {
        "format": "did",
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "repo": {
        "description": "One account's records: the group's or a member's.",
        "format": "did",
        "type": "string"
      },
      "repos": {
        "description": "Many accounts, anyone's: each one's newest record of the collection.",
        "items": {
          "format": "did",
          "type": "string"
        },
        "maxLength": 100,
        "type": "array"
      },
      "search": {
        "description": "With `from: \"network\"`: records whose words have any of these words, \"quoted phrases\" kept together, a trailing * for a prefix, and AND, OR and NOT for more.",
        "maxLength": 512,
        "type": "string"
      },
      "sort": {
        "default": "newest",
        "description": "With `from: \"network\"` and a search: newest first, or the most relevant first.",
        "knownValues": [
          "newest",
          "relevance"
        ],
        "type": "string"
      }
    },
    "required": [
      "group",
      "collection"
    ],
    "type": "params"
  },
  "type": "query"
}
siteRecord object

No description available.

Properties

cid string cid Optional

A content identifier (CID) referencing immutable data.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

handle string handle Optional

With `from: "network"` or `repos`: the account's handle, when it's known.

repo string did Required

A decentralized identifier (DID).

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

value unknown Required

No description available.

View raw schema 
{
  "properties": {
    "cid": {
      "format": "cid",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "handle": {
      "description": "With `from: \"network\"` or `repos`: the account's handle, when it's known.",
      "format": "handle",
      "type": "string"
    },
    "repo": {
      "format": "did",
      "type": "string"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "value": {
      "type": "unknown"
    }
  },
  "required": [
    "uri",
    "repo",
    "value"
  ],
  "type": "object"
}

Lexicon Garden

@