# club.userstyles.alpha.feed.searchUserstyles

> Published by [userstyles.club](https://lexicon.garden/identity/did:plc:z6a2tfjek74wmqinw5vjzbed)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.feed.searchUserstyles)
- [Documentation](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.feed.searchUserstyles/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.feed.searchUserstyles/examples)

## Definitions

### `club.userstyles.alpha.feed.searchUserstyles`

**Type**: `query`

Search over userstyles, with optional querying and filters.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `sort` | `string` | No | Rank by text relevance with 'top'; without a `query`, defaults to 'latest'.Rank by comment and rating activity via 'popular'. |
| `limit` | `integer` | No |  |
| `query` | `string` | No | Search terms, matched against title and description fields. |
| `since` | `string` (datetime) | No | only userstyles created at or after this time |
| `author` | `string` (at-identifier) | No |  |
| `before` | `string` (datetime) | No | only userstyles created before this time |
| `cursor` | `string` | No |  |
| `homepage` | `string` | No | substring match against homepageUrl |
| `upstream` | `string` | No | substring match against upstreamUrl |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `userstyles` | `array` | Yes |  |

#### Errors

- **ActorNotFound**

## Raw Schema

```json
{
  "id": "club.userstyles.alpha.feed.searchUserstyles",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "ActorNotFound"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "userstyles"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "userstyles": {
              "type": "array",
              "items": {
                "ref": "club.userstyles.alpha.defs#userstyleView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "sort": {
            "enum": [
              "top",
              "latest",
              "popular"
            ],
            "type": "string",
            "default": "latest",
            "description": "Rank by text relevance with 'top'; without a `query`, defaults to 'latest'.Rank by comment and rating activity via 'popular'."
          },
          "limit": {
            "type": "integer",
            "default": 25,
            "maximum": 100,
            "minimum": 1
          },
          "query": {
            "type": "string",
            "description": "Search terms, matched against title and description fields."
          },
          "since": {
            "type": "string",
            "format": "datetime",
            "description": "only userstyles created at or after this time"
          },
          "author": {
            "type": "string",
            "format": "at-identifier"
          },
          "before": {
            "type": "string",
            "format": "datetime",
            "description": "only userstyles created before this time"
          },
          "cursor": {
            "type": "string"
          },
          "homepage": {
            "type": "string",
            "description": "substring match against homepageUrl"
          },
          "upstream": {
            "type": "string",
            "description": "substring match against upstreamUrl"
          }
        }
      },
      "description": "Search over userstyles, with optional querying and filters."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```