pet.trezy.getPets

trezy.pet

Documentation

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

main query

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

Parameters

cursor string Optional

No description available.

did string did Required

Ther owner for whom to retrieve pets.

direction string Optional

Whether to sort ascending or descending.

hydrate boolean Optional

Whether to return the pet's full record.

limit integer Optional

No description available.

sort string Optional

No description available.

state array of string Optional

Filter on state.

Output

Encodingapplication/json
cursor string Optional

Absent if there are no more results.

error string Optional

The type of error encountered.

Known values: bad-did, unknown-state, unknown-sort, unknown-direction, bad-cursor, unavailable
message string Optional

No description available.

pets array Optional

Sorted list of pet AT URIs.

records array Optional

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

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Ther owner for whom to retrieve pets.
Whether to sort ascending or descending.
Whether to return the pet's full record.
Filter on state.
View raw schema 
{
  "description": "The at-uris of a player's pets, newest first, optionally filtered by state. Returns IDs only by default.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Absent if there are no more results.",
          "type": "string"
        },
        "error": {
          "description": "The type of error encountered.",
          "knownValues": [
            "bad-did",
            "unknown-state",
            "unknown-sort",
            "unknown-direction",
            "bad-cursor",
            "unavailable"
          ],
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "pets": {
          "description": "Sorted list of pet AT URIs.",
          "items": {
            "format": "at-uri",
            "type": "string"
          },
          "type": "array"
        },
        "records": {
          "description": "Pet records (only present if `hydrate` is true).",
          "items": {
            "ref": "#hydratedPet",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "type": "string"
      },
      "did": {
        "description": "Ther owner for whom to retrieve pets.",
        "format": "did",
        "type": "string"
      },
      "direction": {
        "default": "desc",
        "description": "Whether to sort ascending or descending.",
        "knownValues": [
          "asc",
          "desc"
        ],
        "type": "string"
      },
      "hydrate": {
        "default": false,
        "description": "Whether to return the pet's full record.",
        "type": "boolean"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "sort": {
        "default": "age",
        "knownValues": [
          "rarity",
          "name",
          "price",
          "age",
          "attention"
        ],
        "type": "string"
      },
      "state": {
        "description": "Filter on state.",
        "items": {
          "knownValues": [
            "active",
            "inactive",
            "retired"
          ],
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "did"
    ],
    "type": "params"
  },
  "type": "query"
}
hydratedPet object

No description available.

Properties

active boolean Optional

No description available.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

name string Optional

No description available.

price integer Optional

No description available.

retired boolean Optional

No description available.

species string Optional

No description available.

tier string Optional

No description available.

totalInteractions integer Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "properties": {
    "active": {
      "type": "boolean"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "price": {
      "type": "integer"
    },
    "retired": {
      "type": "boolean"
    },
    "species": {
      "type": "string"
    },
    "tier": {
      "type": "string"
    },
    "totalInteractions": {
      "type": "integer"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri"
  ],
  "type": "object"
}

Lexicon Garden

@