Skip to content

Commit e9bc313

Browse files
committed
docs(users): 📝 add docs for search users
1 parent 0f3df5e commit e9bc313

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

docs/docs/usage/users/search.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
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.
2+
3+
You can get more information for this at [docs](https://developer.twitter.com/en/docs/twitter-api/users/search/introduction)
4+
5+
## Search Users
6+
7+
Get users that match a search query.
8+
9+
```python
10+
my_api.search_users(query="developers")
11+
# Response(data=[User(id='866707894389141505', name='Refinitiv Developers', username='Developers'), User(id='2244994945', name='Developers', username='XDevelopers')])
12+
```

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ nav:
5353
- Follows: usage/users/follows.md
5454
- Blocks: usage/users/blocks.md
5555
- Mutes: usage/users/mutes.md
56+
- Search: usage/users/search.md
5657
- Spaces:
5758
- Spaces Lookup: usage/spaces/spaces-lookup.md
5859
- Search Spaces: usage/spaces/search.md

0 commit comments

Comments
 (0)