diff --git a/docs/docs/usage/users/search.md b/docs/docs/usage/users/search.md new file mode 100644 index 0000000..06398fa --- /dev/null +++ b/docs/docs/usage/users/search.md @@ -0,0 +1,12 @@ +The Users Search endpoint provides a simple, relevance-based search interface to public user accounts on X. Try querying by topical interest, full name, company name, location, or other criteria. + +You can get more information for this at [docs](https://developer.twitter.com/en/docs/twitter-api/users/search/introduction) + +## Search Users + +Get users that match a search query. + +```python +my_api.search_users(query="developers") +# Response(data=[User(id='866707894389141505', name='Refinitiv Developers', username='Developers'), User(id='2244994945', name='Developers', username='XDevelopers')]) +``` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 171c160..8bd572b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -53,6 +53,7 @@ nav: - Follows: usage/users/follows.md - Blocks: usage/users/blocks.md - Mutes: usage/users/mutes.md + - Search: usage/users/search.md - Spaces: - Spaces Lookup: usage/spaces/spaces-lookup.md - Search Spaces: usage/spaces/search.md