Skip to content

Commit 1aa82d3

Browse files
committed
docs(bookmarks): 📝 update docs for bookmarks
1 parent 076367f commit 1aa82d3

File tree

3 files changed

+37
-3
lines changed

3 files changed

+37
-3
lines changed

README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ Now cover features:
9595
- Volume streams
9696
- Retweets
9797
- Likes
98+
- Bookmarks
9899
- Hide replies
99100

100101
- Users
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Bookmarks are a core feature of the Twitter app that allows you to “save” Tweets and easily access them later. With these endpoints, you can retrieve, create, delete or build solutions to manage your Bookmarks via the API.
2+
3+
You can get more information for this at [docs](https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/introduction)
4+
5+
## Manage Bookmarks
6+
7+
### Bookmark tweet
8+
9+
Causes the user ID of an authenticated user identified in the path parameter to Bookmark the target Tweet provided in the request body.
10+
11+
```python
12+
my_api.bookmark_tweet(user_id="1301152652357595137", tweet_id="1511645952418885636")
13+
# {'data': {'bookmarked': True}}
14+
```
15+
16+
### Remove bookmark tweet
17+
18+
Allows a user or authenticated user ID to remove a Bookmark of a Tweet.
19+
20+
```python
21+
my_api.bookmark_tweet_remove(user_id="1301152652357595137", tweet_id="1511645952418885636")
22+
# {'data': {'bookmarked': False}}
23+
```
24+
25+
## Bookmarks lookup
26+
27+
Allows you to get information about a authenticated user’s 800 most recent bookmarked Tweets.
28+
29+
```python
30+
my_api.get_bookmark_tweets(user_id="1301152652357595137")
31+
# Response(data=[Tweet(id=1511645952418885636, text=https://t.co/Hl9Sa0uP9W)])
32+
```

docs/mkdocs.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,22 @@ nav:
3737
- Tweets:
3838
- Tweet Lookup: usage/tweets/tweet-lookup.md
3939
- Manage Tweets: usage/tweets/tweet-manage.md
40-
- Quote Tweets: usage/tweets/qutoe_tweets.md
4140
- Timelines: usage/tweets/timelines.md
4241
- Search Tweets: usage/tweets/search_tweets.md
4342
- Tweet counts: usage/tweets/tweets_counts.md
44-
- Hide replies: usage/tweets/hide_reply.md
4543
- Retweets: usage/tweets/retweet.md
44+
- Quote Tweets: usage/tweets/qutoe_tweets.md
4645
- Likes: usage/tweets/likes.md
46+
- Bookmarks: usage/tweets/bookmarks.md
47+
- Hide replies: usage/tweets/hide_reply.md
4748
- Users:
4849
- Users Lookup: usage/users/user-lookup.md
4950
- Follows: usage/users/follows.md
5051
- Blocks: usage/users/blocks.md
5152
- Mutes: usage/users/mutes.md
5253
- Spaces:
5354
- Spaces Lookup: usage/spaces/spaces-lookup.md
54-
- Spaces Search: usage/spaces/search.md
55+
- Search Spaces: usage/spaces/search.md
5556
- Lists:
5657
- List lookup: usage/lists/list-lookup.md
5758
- Manage Lists: usage/lists/manage-lists.md

0 commit comments

Comments
 (0)