oppi.li
atproto pastebin service: https://plonk.li
1{
2 "lexicon": 1,
3 "id": "com.atproto.repo.listRecords",
4 "defs": {
5 "main": {
6 "type": "query",
7 "description": "List a range of records in a repository, matching a specific collection. Does not require auth.",
8 "parameters": {
9 "type": "params",
10 "required": [
11 "repo",
12 "collection"
13 ],
14 "properties": {
15 "repo": {
16 "type": "string",
17 "format": "at-identifier",
18 "description": "The handle or DID of the repo."
19 },
20 "collection": {
21 "type": "string",
22 "format": "nsid",
23 "description": "The NSID of the record type."
24 },
25 "limit": {
26 "type": "integer",
27 "minimum": 1,
28 "maximum": 100,
29 "default": 50,
30 "description": "The number of records to return."
31 },
32 "cursor": {
33 "type": "string"
34 },
35 "rkeyStart": {
36 "type": "string",
37 "description": "DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)"
38 },
39 "rkeyEnd": {
40 "type": "string",
41 "description": "DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)"
42 },
43 "reverse": {
44 "type": "boolean",
45 "description": "Flag to reverse the order of the returned records."
46 }
47 }
48 },
49 "output": {
50 "encoding": "application/json",
51 "schema": {
52 "type": "object",
53 "required": [
54 "records"
55 ],
56 "properties": {
57 "cursor": {
58 "type": "string"
59 },
60 "records": {
61 "type": "array",
62 "items": {
63 "type": "ref",
64 "ref": "#record"
65 }
66 }
67 }
68 }
69 }
70 },
71 "record": {
72 "type": "object",
73 "required": [
74 "uri",
75 "cid",
76 "value"
77 ],
78 "properties": {
79 "uri": {
80 "type": "string",
81 "format": "at-uri"
82 },
83 "cid": {
84 "type": "string",
85 "format": "cid"
86 },
87 "value": {
88 "type": "unknown"
89 }
90 }
91 }
92 }
93}