so.sprk.feed.searchPosts Documentation (EN)

main query

Find posts matching search criteria, returning views of those posts.

Parameters

cursor string Optional

Optional pagination mechanism; may not necessarily allow scrolling through entire result set.

limit integer Optional

No description available.

q string Required

Search query string; to match against post descriptions and such.

sort string Optional

Specifies the ranking order of results.

Output

Encodingapplication/json

cursor string Optional

No description available.

hitsTotal integer Optional

Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.

posts array Required

No description available.

Errors

BadQueryString

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

cursor Optional pagination mechanism; may not necessarily allow scrolling through entire result set.

limit

q * Search query string; to match against post descriptions and such.

sort Specifies the ranking order of results.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "BadQueryString"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "posts"
      ],
      "properties": {
        "posts": {
          "type": "array",
          "items": {
            "ref": "so.sprk.feed.defs#postView",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string"
        },
        "hitsTotal": {
          "type": "integer",
          "description": "Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "q"
    ],
    "properties": {
      "q": {
        "type": "string",
        "description": "Search query string; to match against post descriptions and such."
      },
      "sort": {
        "type": "string",
        "default": "latest",
        "description": "Specifies the ranking order of results.",
        "knownValues": [
          "top",
          "latest"
        ]
      },
      "limit": {
        "type": "integer",
        "default": 25,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string",
        "description": "Optional pagination mechanism; may not necessarily allow scrolling through entire result set."
      }
    }
  },
  "description": "Find posts matching search criteria, returning views of those posts."
}