Lexicon Garden

pet.trezy.getPets

The at-uris of a player's pets, newest first, optionally filtered by state. Returns IDs only by default.

Repository @trezy.pet did:plc:ollch4g7tes2reb5eceiwuol namespace authority
Details · query
Kindquery
Authoritytrezy.pet
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

cursor

string

did

requiredstring · did

Ther owner for whom to retrieve pets.

direction

string

Whether to sort ascending or descending.

  • default: "desc"
  • knownValues: asc | desc

hydrate

boolean

Whether to return the pet's full record.

  • default: false

limit

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

sort

string
  • default: "age"
  • knownValues: rarity | name | price | age | attention

state

array

Filter on state.

itemsstring
  • knownValues: active | inactive | retired

Output

application/json

cursor

string

Absent if there are no more results.

error

string

The type of error encountered.

  • knownValues: bad-did | unknown-state | unknown-sort | unknown-direction | bad-cursor | unavailable

message

string

pets

array

Sorted list of pet AT URIs.

itemsstring · at-uri

records

array

Pet records (only present if `hydrate` is true).

itemsref
Reference

#hydratedPet

object

Properties

active

boolean

createdAt

string · datetime

name

string

price

integer

retired

boolean

species

string

tier

string

uri

requiredstring · at-uri

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • pet.trezy.getPet

    query

  • pet.trezy.getNewPets

    query

    The pets adopted in the 7 days before asOf, for the weekly arrivals post. Live pets only: a pet retired inside the same week is not an arrival any more. ⚠ `total` IS THE TRUE COUNT AND `pets` IS ONLY WHAT FITS ON STAGE — the post's number must be how many animals arrived, not how many the renderer could draw. Carries no keeper DID and no pet name, because the post says neither — `#pet` carries `rkey` rather than the at-URI so the caller never even receives the keeper's DID, which sits in the URI