Reference · Platform methods
pub.techne.draft.query.listRecords
query · GETIn the SDK, techne.query
One page of the records a pub.techne.draft.query names, in its order.
Every record comes through the platform's one read path. A record in a space comes back only if it is yours or the space's read policy admits you. Anyone may call it. Signed out, you get public records only.
Input query parameters
| Name | Type | What it is |
|---|---|---|
query | string | A pub.techne.draft.query object, as JSON. Give this or queryUri. |
queryUri | at-uri | A published pub.techne.draft.query record to run. Give this or query. |
params | string | The query's parameters as a JSON object of strings, e.g. {"here": "40.01,-105.27"}. $viewer and $now are the platform's and cannot be passed. |
limit | integer, 1–100 | The page size. It defaults to the query's limit, else 50. |
cursor | string | The previous page's cursor, passed back as it came, with the same query. |
count | boolean | Also count the records the query answers you. The output gains count and capped. |
Output application/json
| Name | Type | What it is |
|---|---|---|
recordsrequired | record[] | In the query's order, ties broken by URI. |
cursor | string | Pass it back for the next page. Absent on the last page. A short page with a cursor is not the last page. |
count | integer | How many records the query answers you, up to 1000. Only with count=true. |
capped | boolean | True when there are more than count. Only with count=true. |
Each record
urirequired | at-uri | The record's address. |
cidrequired | cid | The version's content hash. |
authorrequired | did | The DID whose repo holds the record. |
collectionrequired | nsid | Its type. |
valuerequired | unknown | The record body. |
timerequired | datetime | When it was indexed. |
sourcerequired | string | public (on the firehose) or permissioned. |
space | at-uri | The space a permissioned record counts in. |
curated | boolean | A live curated record, merged from its sources by a trusted curator. |
measures | unknown | Numbers the query's operators produced, e.g. a near distance in metres. |
Also held, signals and included; errors InvalidRequest (400) and NotFound (404). The full lexicon is at listRecords.query.draft.techne.pub.
Places within 5 km
Inside <TechneProvider>. data is the same items as on the SDK tab, each { uri, cid, record, verdict, problems, curated, byline }.
Places within 5 km
What comes back
The SDK answers each record as an item, { uri, cid, record, verdict, problems, curated, byline }.