app.bivri.search.searchArtworks

lexicons.bivri.app

Documentation

main query

No description available.

Parameters

cursor string Optional

Opaque pagination cursor. Valid only for the sort mode it was issued under; pass it back unchanged on the next request.

limit integer Optional

Maximum number of artworks to return.

q string Required

Search query. Supports boolean tag search, with 'tag:xxx' terms combined by AND, OR and NOT.

sort string Optional

Ordering of the results. 'relevance' is by match score; 'latest' is reverse-chronological; 'popular' is by like count.

Output

Encodingapplication/json
artworks array Required

No description available.

cursor string Optional

No description available.

suggestedTags array Optional

Popular tags suggested when the search matched no artworks.

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
Opaque pagination cursor. Valid only for the sort mode it was issued under; pass it back unchanged on the next request.
Maximum number of artworks to return.
Search query. Supports boolean tag search, with 'tag:xxx' terms combined by AND, OR and NOT.
Ordering of the results. 'relevance' is by match score; 'latest' is reverse-chronological; 'popular' is by like count.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "artworks"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "artworks": {
          "type": "array",
          "items": {
            "ref": "app.bivri.feed.defs#artworkView",
            "type": "ref"
          }
        },
        "suggestedTags": {
          "type": "array",
          "items": {
            "ref": "#tagSuggestion",
            "type": "ref"
          },
          "description": "Popular tags suggested when the search matched no artworks."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "q"
    ],
    "properties": {
      "q": {
        "type": "string",
        "description": "Search query. Supports boolean tag search, with 'tag:xxx' terms combined by AND, OR and NOT."
      },
      "sort": {
        "type": "string",
        "default": "relevance",
        "description": "Ordering of the results. 'relevance' is by match score; 'latest' is reverse-chronological; 'popular' is by like count.",
        "knownValues": [
          "relevance",
          "latest",
          "popular"
        ]
      },
      "limit": {
        "type": "integer",
        "default": 25,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of artworks to return."
      },
      "cursor": {
        "type": "string",
        "description": "Opaque pagination cursor. Valid only for the sort mode it was issued under; pass it back unchanged on the next request."
      }
    }
  }
}
tagSuggestion object

No description available.

Properties

count integer Required

No description available.

tag string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "tag",
    "count"
  ],
  "properties": {
    "tag": {
      "type": "string"
    },
    "count": {
      "type": "integer"
    }
  }
}

Lexicon Garden

@