pub.chive.tag.search

chive.pub

Documentation

Search for tags matching a query

main query

Search for tags matching a query

Parameters

cursor string Optional

Pagination cursor for next page

includeSpam boolean Optional

Include tags flagged as potential spam

limit integer Optional

Maximum number of results to return

minQuality integer Optional

Minimum quality score (0-100, scaled from 0-1)

q string Required

Search query

Output

Encodingapplication/json
cursor string Optional

Cursor for next page

hasMore boolean Required

Whether more results are available

tags array Required

Search results

total integer Optional

Total count of matching tags

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
Pagination cursor for next page
Include tags flagged as potential spam
Maximum number of results to return
Minimum quality score (0-100, scaled from 0-1)
Search query
View raw schema 
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "tags",
        "hasMore"
      ],
      "properties": {
        "tags": {
          "type": "array",
          "items": {
            "ref": "#tagSummary",
            "type": "ref"
          },
          "description": "Search results"
        },
        "total": {
          "type": "integer",
          "minimum": 0,
          "description": "Total count of matching tags"
        },
        "cursor": {
          "type": "string",
          "description": "Cursor for next page"
        },
        "hasMore": {
          "type": "boolean",
          "description": "Whether more results are available"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "q"
    ],
    "properties": {
      "q": {
        "type": "string",
        "maxLength": 100,
        "minLength": 2,
        "description": "Search query"
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of results to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor for next page"
      },
      "minQuality": {
        "type": "integer",
        "maximum": 100,
        "minimum": 0,
        "description": "Minimum quality score (0-100, scaled from 0-1)"
      },
      "includeSpam": {
        "type": "boolean",
        "default": false,
        "description": "Include tags flagged as potential spam"
      }
    }
  },
  "description": "Search for tags matching a query"
}
promotionTarget object

Target of tag promotion

Properties

type string Required

Type of promotion target

Known values: facet, authority
uri string Required

URI of the promotion target

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "description": "URI of the promotion target"
    },
    "type": {
      "type": "string",
      "description": "Type of promotion target",
      "knownValues": [
        "facet",
        "authority"
      ]
    }
  },
  "description": "Target of tag promotion"
}
tagSummary object

Summary information for a tag

Properties

displayForms array of string Required

All display forms used for this tag

isPromoted boolean Required

Whether the tag has been promoted to a facet or authority

normalizedForm string Required

Normalized tag form (lowercase, hyphenated)

qualityScore integer Required

Tag quality score (0-100, scaled from 0-1)

minimum: 0maximum: 100
usageCount integer Required

Number of eprints tagged with this tag

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "normalizedForm",
    "displayForms",
    "usageCount",
    "qualityScore",
    "isPromoted"
  ],
  "properties": {
    "isPromoted": {
      "type": "boolean",
      "description": "Whether the tag has been promoted to a facet or authority"
    },
    "promotedTo": {
      "ref": "#promotionTarget",
      "type": "ref",
      "description": "Promotion target if promoted"
    },
    "usageCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of eprints tagged with this tag"
    },
    "displayForms": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "All display forms used for this tag"
    },
    "qualityScore": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Tag quality score (0-100, scaled from 0-1)"
    },
    "normalizedForm": {
      "type": "string",
      "description": "Normalized tag form (lowercase, hyphenated)"
    }
  },
  "description": "Summary information for a tag"
}

Lexicon Garden

@