Skip to content

Commit eaf703b

Browse files
committed
Update READMEs and directory structure
1 parent c4e6d01 commit eaf703b

41 files changed

Lines changed: 307 additions & 161 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Working code samples for the **X API v2** in Python, JavaScript, Ruby, Java, and
77
## 📁 Repository Structure
88

99
```
10-
├── python/ # 108 Python examples
11-
├── javascript/ # 70 JavaScript examples
10+
├── python/ # 65 Python examples
11+
├── javascript/ # 59 JavaScript examples
1212
├── ruby/ # 58 Ruby examples
1313
├── java/ # 19 Java examples
1414
├── r/ # 5 R examples
@@ -35,31 +35,36 @@ export CONSUMER_SECRET='your_consumer_secret'
3535
```bash
3636
# Python
3737
cd python && pip install -r requirements.txt
38-
python posts/recent_search.py
38+
python posts/search_recent.py
3939

4040
# JavaScript
41-
cd javascript && npm install
42-
node posts/recent_search.js
41+
cd javascript
42+
node posts/search_recent.js
4343

4444
# Ruby
4545
cd ruby && bundle install
46-
ruby posts/recent_search.rb
46+
ruby posts/search_recent.rb
47+
48+
# Java
49+
cd java
50+
javac -cp ".:lib/*" posts/RecentSearchDemo.java
51+
java -cp ".:lib/*" RecentSearchDemo
4752
```
4853

4954
## 📚 Examples by Category
5055

5156
| Category | Python | JavaScript | Ruby | Java | R |
5257
|----------|--------|------------|------|------|---|
53-
| Posts (search, create, delete, likes, retweets) ||||||
54-
| Users (lookup, followers, blocks, mutes) ||||||
58+
| Posts (search, create, delete, likes, reposts) ||||||
59+
| Users (lookup, followers, following, blocks, mutes) ||||||
5560
| Timelines (user, mentions, home) ||||| |
5661
| Streams (filtered, sampled) ||||| |
57-
| Lists (lookup, manage, members) |||| | |
62+
| Lists (lookup, manage, members, follow) |||| | |
5863
| Spaces (lookup, search) ||||| |
5964
| Bookmarks |||| | |
6065
| Direct Messages || | | | |
6166
| Media Upload || | | | |
62-
| Compliance ||| | | |
67+
| Compliance ||| | | |
6368
| Usage ||| || |
6469

6570
## 🔐 Authentication

java/README.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,56 @@ export BEARER_TOKEN='your_bearer_token'
3939
## Examples by Category
4040

4141
### Posts
42-
| File | Description | Auth |
43-
|------|-------------|------|
44-
| `posts/SearchRecent.java` | Search recent posts (7 days) | Bearer |
42+
- `posts/FullArchiveSearchDemo.java` - Full archive search demo
43+
- `posts/FullArchiveTweetCountsDemo.java` - Full archive tweet counts demo
44+
- `posts/QuoteTweetsDemo.java` - Get posts that quote a post
45+
- `posts/RecentSearchDemo.java` - Recent search demo (last 7 days)
46+
- `posts/RecentTweetCountsDemo.java` - Recent tweet counts demo
47+
- `posts/SearchRecent.java` - Recent search (last 7 days)
48+
- `posts/TweetsDemo.java` - Look up posts by ID
4549

4650
### Users
47-
| File | Description | Auth |
48-
|------|-------------|------|
49-
| `users/Lookup.java` | Look up users by username | Bearer |
51+
- `users/FollowersLookupDemo.java` - Get user's followers
52+
- `users/FollowingLookupDemo.java` - Get users a user is following
53+
- `users/Lookup.java` - Look up users by username
54+
- `users/UsersDemo.java` - Users lookup demo
55+
56+
### Timelines
57+
- `timelines/reverse-chron-home-timeline-java-sdk.java` - Get home timeline (reverse chronological)
58+
- `timelines/UserMentionsDemo.java` - Get user mentions timeline
59+
- `timelines/UserTweetsDemo.java` - Get user's posts timeline
60+
61+
### Streams
62+
- `streams/FilteredStreamDemo.java` - Filtered stream with rules
63+
- `streams/SampledStream.java` - Sampled stream
64+
65+
### Spaces
66+
- `spaces/SearchSpacesDemo.java` - Search for Spaces
67+
- `spaces/SpacesLookupDemo.java` - Look up Spaces by ID
68+
69+
### Usage
70+
- `usage/UsageTweetsDemo.java` - Get API usage information
5071

5172
## Building and Running
5273

74+
### Compile
75+
5376
```bash
54-
# Compile
77+
# Compile a single file
5578
javac -cp ".:lib/*" posts/SearchRecent.java
5679

57-
# Run
58-
java -cp ".:lib/*" SearchRecent
80+
# Or compile all files
81+
find . -name "*.java" -exec javac -cp ".:lib/*" {} \;
82+
```
83+
84+
### Run
85+
86+
```bash
87+
# Run a single example
88+
java -cp ".:lib/*" posts.SearchRecent
89+
90+
# Or with package structure
91+
java -cp ".:lib/*" posts/RecentSearchDemo
5992
```
6093

6194
## More Information

javascript/README.md

Lines changed: 81 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ node --version
1212

1313
### 2. Install dependencies
1414

15-
```bash
16-
npm install
17-
```
15+
No package.json is required. Examples use Node.js built-in modules or standard libraries.
1816

1917
### 3. Set environment variables
2018

@@ -32,38 +30,96 @@ export CONSUMER_SECRET='your_consumer_secret'
3230
## Examples by Category
3331

3432
### Posts
35-
| File | Description | Auth |
36-
|------|-------------|------|
37-
| `posts/create_post.js` | Create a new post | OAuth 1.0a |
38-
| `posts/delete_post.js` | Delete a post | OAuth 1.0a |
39-
| `posts/lookup.js` | Look up posts by ID | Bearer |
40-
| `posts/search_recent.js` | Search recent posts (7 days) | Bearer |
33+
- `posts/create_post.js` - Create a new post
34+
- `posts/delete_post.js` - Delete a post
35+
- `posts/get_liking_users.js` - Get users who liked a post
36+
- `posts/get_post_counts_all.js` - Get post counts (full archive)
37+
- `posts/get_post_counts_recent.js` - Get post counts (recent)
38+
- `posts/get_posts_by_ids.js` - Look up posts by ID (bearer token)
39+
- `posts/get_posts_by_ids_user_context.js` - Look up posts by ID (user context)
40+
- `posts/get_quoted_posts.js` - Get posts that quote a post
41+
- `posts/get_reposted_by.js` - Get users who reposted a post
42+
- `posts/search_all.js` - Full archive search
43+
- `posts/search_recent.js` - Recent search (last 7 days)
4144

4245
### Users
43-
| File | Description | Auth |
44-
|------|-------------|------|
45-
| `users/lookup.js` | Look up users by username | Bearer |
46-
| `users/followers.js` | Get user's followers | Bearer |
46+
- `users/get_users_by_usernames.js` - Look up users by username (bearer token)
47+
- `users/get_users_by_usernames_user_context.js` - Look up users by username (user context)
48+
- `users/get_users_me.js` - Get authenticated user (me)
49+
50+
#### User Actions - Block
51+
- `users/block/get_blocking.js` - Get users blocked by a user
52+
53+
#### User Actions - Bookmark
54+
- `users/bookmark/create_bookmark.js` - Create a bookmark
55+
- `users/bookmark/delete_bookmark.js` - Delete a bookmark
56+
- `users/bookmark/get_bookmarks.js` - Get user's bookmarks
57+
58+
#### User Actions - Follow
59+
- `users/follow/get_followers.js` - Get user's followers
60+
- `users/follow/get_followers_paginated.js` - Get user's followers (paginated)
61+
- `users/follow/get_following_paginated.js` - Get users a user is following (paginated)
62+
63+
#### User Actions - Like
64+
- `users/like/get_liked_posts.js` - Get posts liked by a user
65+
- `users/like/like_post.js` - Like a post
66+
- `users/like/unlike_post.js` - Unlike a post
67+
68+
#### User Actions - Lists
69+
- `users/lists/follow_list.js` - Follow a list
70+
- `users/lists/get_followed_lists.js` - Get lists followed by a user
71+
- `users/lists/get_list_memberships.js` - Get list memberships
72+
- `users/lists/get_owned_lists.js` - Get lists owned by a user
73+
- `users/lists/pin_list.js` - Pin a list
74+
- `users/lists/unfollow_list.js` - Unfollow a list
75+
- `users/lists/unpin_list.js` - Unpin a list
76+
77+
#### User Actions - Mute
78+
- `users/mute/get_muting.js` - Get users muted by a user
79+
- `users/mute/mute_user.js` - Mute a user
80+
- `users/mute/unmute_user.js` - Unmute a user
81+
82+
#### User Actions - Repost
83+
- `users/repost/repost_post.js` - Repost a post
84+
- `users/repost/unrepost_post.js` - Undo a repost
85+
86+
#### User Actions - Timeline
87+
- `users/timeline/get_home_timeline.js` - Get home timeline
88+
- `users/timeline/get_mentions.js` - Get user mentions timeline
89+
- `users/timeline/get_posts.js` - Get user's posts timeline
90+
- `users/timeline/get_posts_paginated.js` - Get user's posts timeline (paginated)
4791

4892
### Timelines
49-
| File | Description | Auth |
50-
|------|-------------|------|
51-
| `timelines/user_posts.js` | User's posts timeline | Bearer |
93+
- See `users/timeline/` directory for timeline examples
5294

5395
### Streams
54-
| File | Description | Auth |
55-
|------|-------------|------|
56-
| `streams/filtered_stream.js` | Filtered stream with rules | Bearer |
96+
- `streams/stream_posts_filtered.js` - Filtered stream with rules
97+
- `streams/stream_posts_sample.js` - Sampled stream
5798

5899
### Lists
59-
| File | Description | Auth |
60-
|------|-------------|------|
61-
| `lists/lookup.js` | Look up a list | Bearer |
100+
- `lists/add_member.js` - Add member to a list
101+
- `lists/create_list.js` - Create a new list
102+
- `lists/delete_list.js` - Delete a list
103+
- `lists/get_list_by_id.js` - Get list by ID
104+
- `lists/get_list_followers.js` - Get list followers
105+
- `lists/get_list_members.js` - Get list members
106+
- `lists/get_list_posts.js` - Get posts from a list
107+
- `lists/remove_member.js` - Remove member from a list
108+
- `lists/update_list.js` - Update a list
62109

63110
### Spaces
64-
| File | Description | Auth |
65-
|------|-------------|------|
66-
| `spaces/lookup.js` | Look up Spaces | Bearer |
111+
- `spaces/get_spaces_by_ids.js` - Look up Spaces by ID
112+
- `spaces/search_spaces.js` - Search for Spaces
113+
114+
### Compliance
115+
- `compliance/create_jobs.js` - Create compliance job
116+
- `compliance/download_results.js` - Download compliance results
117+
- `compliance/get_jobs_by_id.js` - Get compliance job by ID
118+
- `compliance/get_jobs.js` - Get compliance jobs
119+
- `compliance/upload_ids.js` - Upload IDs for compliance
120+
121+
### Usage
122+
- `usage/get_usage.js` - Get API usage information
67123

68124
## Running Examples
69125

0 commit comments

Comments
 (0)