ptr.pet
at protocol indexer with flexible filtering, xrpc queries, and a cursor-backed event stream, built on fjall
at-protocol
atproto
indexer
rust
fjall
[docs] update readme
+8
-26
README.md
+8
-26
README.md
···
97
98
### repository management
99
100
-
- `GET /repos`: get an NDJSON stream of repositories and their sync status. Supports pagination and filtering:
101
- `limit`: max results (default 100, max 1000)
102
-
- `cursor`: DID or u64 index ID depending on partition
103
- `partition`: `all` (default), `pending` (backfill queue), or `resync` (retries)
104
- `GET /repos/{did}`: get the sync status and metadata of a specific repository.
105
- `PUT /repos`: explicitly track repositories. accepts an NDJSON body of `{"did": "..."}` (or JSON array of the same).
···
109
110
`hydrant` implements the following XRPC endpoints under `/xrpc/`:
111
112
-
#### `com.atproto.repo.getRecord`
113
-
114
-
retrieve a single record by its AT URI components.
115
-
116
-
| param | required | description |
117
-
| :--- | :--- | :--- |
118
-
| `repo` | yes | DID or handle of the repository. |
119
-
| `collection` | yes | NSID of the collection. |
120
-
| `rkey` | yes | record key. |
121
-
122
-
returns the record value, its CID, and its AT URI. responds with `RecordNotFound` if not present.
123
-
124
-
#### `com.atproto.repo.listRecords`
125
126
-
list records in a collection, newest-first by default.
127
128
-
| param | required | description |
129
-
| :--- | :--- | :--- |
130
-
| `repo` | yes | DID or handle of the repository. |
131
-
| `collection` | yes | NSID of the collection. |
132
-
| `limit` | no | max records to return (default `50`, max `100`). |
133
-
| `cursor` | no | opaque cursor for pagination (from a previous response). |
134
-
| `reverse` | no | if `true`, iterates oldest-first. |
135
136
-
returns `{ records, cursor }`. if `cursor` is present there are more results.
137
-
138
-
#### `systems.gaze.hydrant.countRecords`
139
140
return the total number of stored records in a collection.
141
···
97
98
### repository management
99
100
+
- `GET /repos`: get an NDJSON stream of repositories and their sync status. supports pagination and filtering:
101
- `limit`: max results (default 100, max 1000)
102
+
- `cursor`: opaque key for paginating.
103
- `partition`: `all` (default), `pending` (backfill queue), or `resync` (retries)
104
- `GET /repos/{did}`: get the sync status and metadata of a specific repository.
105
- `PUT /repos`: explicitly track repositories. accepts an NDJSON body of `{"did": "..."}` (or JSON array of the same).
···
109
110
`hydrant` implements the following XRPC endpoints under `/xrpc/`:
111
112
+
#### `com.atproto.*`
113
114
+
the following are implemented currently:
115
+
- `com.atproto.repo.getRecord`
116
+
- `com.atproto.repo.listRecords`
117
118
+
#### `systems.gaze.hydrant.*`
119
120
+
##### `systems.gaze.hydrant.countRecords`
121
122
return the total number of stored records in a collection.
123