app.bsky.actor.search_actors

pydantic model atproto.xrpc_client.models.app.bsky.actor.search_actors.Params

Bases: ParamsModelBase

Parameters model for app.bsky.actor.searchActors.

Show JSON schema

{
   "title": "Params",
   "description": "Parameters model for :obj:`app.bsky.actor.searchActors`.",
   "type": "object",
   "properties": {
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 100,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 25,
         "title": "Limit"
      },
      "q": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Q"
      },
      "term": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Term"
      }
   },
   "additionalProperties": false
}

Fields:

• cursor (Optional[str])

• limit (Optional[int])

• q (Optional[str])

• term (Optional[str])

field cursor: Optional[str] = None

Cursor.

field limit: Optional[int] = 25

Limit.

Constraints:

• ge = 1

• le = 100

field q: Optional[str] = None

search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.

field term: Optional[str] = None

DEPRECATED: use ‘q’ instead.

class atproto.xrpc_client.models.app.bsky.actor.search_actors.ParamsDict

Bases: TypedDict

cursor: typing_extensions.NotRequired[Optional[str]]

Cursor.

limit: typing_extensions.NotRequired[Optional[int]]

Limit.

q: typing_extensions.NotRequired[Optional[str]]

search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.

term: typing_extensions.NotRequired[Optional[str]]

use ‘q’ instead.

Type:

DEPRECATED

pydantic model atproto.xrpc_client.models.app.bsky.actor.search_actors.Response

Bases: ResponseModelBase

Output data model for app.bsky.actor.searchActors.

Show JSON schema

{
   "title": "Response",
   "description": "Output data model for :obj:`app.bsky.actor.searchActors`.",
   "type": "object",
   "properties": {
      "actors": {
         "items": {
            "$ref": "#/$defs/ProfileView"
         },
         "title": "Actors",
         "type": "array"
      },
      "cursor": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cursor"
      }
   },
   "$defs": {
      "Label": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`com.atproto.label.defs`. Metadata tag on an atproto resource (eg, repo or record)",
         "properties": {
            "cts": {
               "title": "Cts",
               "type": "string"
            },
            "src": {
               "title": "Src",
               "type": "string"
            },
            "uri": {
               "title": "Uri",
               "type": "string"
            },
            "val": {
               "maxLength": 128,
               "title": "Val",
               "type": "string"
            },
            "cid": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cid"
            },
            "neg": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Neg"
            },
            "$type": {
               "const": "com.atproto.label.defs#label",
               "default": "com.atproto.label.defs#label",
               "title": "$Type"
            }
         },
         "required": [
            "cts",
            "src",
            "uri",
            "val"
         ],
         "title": "Label",
         "type": "object"
      },
      "ListViewBasic": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.graph.defs`.",
         "properties": {
            "cid": {
               "title": "Cid",
               "type": "string"
            },
            "name": {
               "maxLength": 64,
               "minLength": 1,
               "title": "Name",
               "type": "string"
            },
            "purpose": {
               "anyOf": [
                  {
                     "const": "app.bsky.graph.defs#modlist"
                  },
                  {
                     "const": "app.bsky.graph.defs#curatelist"
                  }
               ],
               "title": "Purpose"
            },
            "uri": {
               "title": "Uri",
               "type": "string"
            },
            "avatar": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Avatar"
            },
            "indexedAt": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Indexedat"
            },
            "viewer": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ListViewerState"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "$type": {
               "const": "app.bsky.graph.defs#listViewBasic",
               "default": "app.bsky.graph.defs#listViewBasic",
               "title": "$Type"
            }
         },
         "required": [
            "cid",
            "name",
            "purpose",
            "uri"
         ],
         "title": "ListViewBasic",
         "type": "object"
      },
      "ListViewerState": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.graph.defs`.",
         "properties": {
            "blocked": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Blocked"
            },
            "muted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Muted"
            },
            "$type": {
               "const": "app.bsky.graph.defs#listViewerState",
               "default": "app.bsky.graph.defs#listViewerState",
               "title": "$Type"
            }
         },
         "title": "ListViewerState",
         "type": "object"
      },
      "ProfileView": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.actor.defs`.",
         "properties": {
            "did": {
               "title": "Did",
               "type": "string"
            },
            "handle": {
               "title": "Handle",
               "type": "string"
            },
            "avatar": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Avatar"
            },
            "description": {
               "anyOf": [
                  {
                     "maxLength": 2560,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "displayName": {
               "anyOf": [
                  {
                     "maxLength": 640,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Displayname"
            },
            "indexedAt": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Indexedat"
            },
            "labels": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Label"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Labels"
            },
            "viewer": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ViewerState"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "$type": {
               "const": "app.bsky.actor.defs#profileView",
               "default": "app.bsky.actor.defs#profileView",
               "title": "$Type"
            }
         },
         "required": [
            "did",
            "handle"
         ],
         "title": "ProfileView",
         "type": "object"
      },
      "ViewerState": {
         "additionalProperties": false,
         "description": "Definition model for :obj:`app.bsky.actor.defs`.",
         "properties": {
            "blockedBy": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Blockedby"
            },
            "blocking": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Blocking"
            },
            "blockingByList": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ListViewBasic"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "followedBy": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Followedby"
            },
            "following": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Following"
            },
            "muted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Muted"
            },
            "mutedByList": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ListViewBasic"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "$type": {
               "const": "app.bsky.actor.defs#viewerState",
               "default": "app.bsky.actor.defs#viewerState",
               "title": "$Type"
            }
         },
         "title": "ViewerState",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "actors"
   ]
}

Fields:

• actors (List[models.AppBskyActorDefs.ProfileView])

• cursor (Optional[str])

field actors: List[models.AppBskyActorDefs.ProfileView] [Required]

Actors.

field cursor: Optional[str] = None

Cursor.