us.off-the-clock.searchRecords

Posts, events, bookmarks, polls, documents, listings and reviews of one content space the viewer reads, matching every condition given: words (keyword), a full-text query (text) or a meaning (semantic), an H3 cell, a radius around a point, a bookmark's domain and a tag. Only records the viewer may see are answered, never another space's. SearchUnavailable is answered for mode=semantic before any other parameter is read, so a call without q tells a client whether meaning search is on.

Details · query
Kindquery
Authorityoff-the-clock.us
Indexed

Showing version bafyreialn5sccpfppwsvxeoeut5mz2ilojqsyxiz7yrbuh5zrrsscya3zq. Show the latest

Query

query · GET

Parameters

query string

collection

string · nsid

Posts, events, bookmarks, polls, documents, listings or reviews; all seven when absent.

  • knownValues: app.bsky.feed.post | community.lexicon.calendar.event | community.lexicon.bookmarks.bookmark | us.off-the-clock.polls.poll | site.standard.document | us.off-the-clock.listing | us.off-the-clock.review

cursor

string

domain

string

Bookmarks whose subject's host is this domain or a subdomain of it, case-insensitive.

  • maxLength: 253

from

string · datetime

Records sorted at or after this time.

h3

string

An H3 cell index in hexadecimal, at resolution 4 to 10.

  • maxLength: 16

limit

integer
  • minimum: 1
  • maximum: 50
  • default: 25

mode

string
  • maxLength: 16
  • default: "keyword"
  • knownValues: keyword | text | semantic

near

string

A point as decimal degrees, latitude,longitude.

  • maxLength: 64

q

string

Required unless h3, near, domain or tag is given.

  • minLength: 1
  • maxLength: 200

space

requiredstring · tid

The pair's TID.

tag

string

Bookmarks carrying this tag, case-insensitive.

  • maxLength: 64

until

string · datetime

Records sorted before this time.

within

string

The radius around near in kilometres, a decimal from 0.1 to 100; 5 by default.

  • maxLength: 16

Output

application/json

cursor

string

hits

requiredarray
itemsref
Reference

mapUrl

string · uri

For a search by place: a signed map of this page's first ten hits, numbered in order (IMG-14), when a map provider is configured.

noPlaces

boolean

True on a search by place that found nothing in a space where no record has a place yet.

Errors

InvalidRequest

No description in schema.

NotSpaceMember

No description in schema.

SearchUnavailable

mode=semantic on a site with no embeddings endpoint.

#hit

object

Properties

For near: the distance in kilometres from the point to the record's nearest place, a decimal.

  • maxLength: 16

score

requiredstring

The mode's own number as a decimal: BM25 made positive for keyword and text, cosine similarity for semantic, 0 for a search by place alone. Lexicons carry no floats.

  • maxLength: 32

snippet

string

The matched text with each match between [ and ].

  • maxLength: 2000