xplore 0.1.12

X/Twitter scraper for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

<div align="center">

# xplore   
X scraper for Rust

[![Version](https://img.shields.io/crates/v/xplore)](https://crates.io/crates/xplore)
![Crates Downloads](https://img.shields.io/crates/d/xplore?logo=rust)
![GitHub License](https://img.shields.io/github/license/solagent-rs/xplore)

</div>

>> 💥 PRs are welcome.   
>> ❗We are still in the early development phase, so please be aware that the interfaces may evolve as we continue to refine the project.

## Features
- Authentication with cookies
- Comprehensive user profile management
- Timeline retrieval
- Tweet interactions (like, retweet, post)
- Advanced search capabilities
- User relationship management (follow/unfollow)

## Installation
```toml
[dependencies]
xplore = "0.1"
```

## Usage
Two method to authenticate with Cookie:
* By using `login`
```rust
let mut xplore = Xplore::new(None).await.unwrap();

xplore.login(username, password, email, two_factor_secret).await;
```

OR

* By using `set_cookie`
```rust
let mut xplore = Xplore::new(None).await.unwrap();

let cookie = env::var("X_COOKIE_STRING").expect("X_COOKIE_STRING");
xplore.set_cookie(&cookie).await;
```

---
> [!IMPORTANT]
> **How to Get Request Cookie for Authentication**
> 
> **Steps to Retrieve Cookie:**
> 1. Open Chrome Developer Tools:
>    - Press `F12` or `Fn+F12` (depending on your keyboard)
>    - Alternatively: Right-click → "Inspect" → "Network" tab
> 
> 2. Locate the Request:
>    - Filter requests and select `user_flow.json`
>    - Navigate to the "Headers" section
> 
> 3. Copy Cookie Value:
>    - Under "Request Headers" → Find the "Cookie" field
>    - Select and copy the entire cookie string
> 
> 4. Configure Environment:
>    - Paste the copied value in your `.env` file:
>      ```env
>      X_COOKIE_STRING=your_copied_cookie_value_here
>      ```
> 
> **Note:** This cookie is used for authentication - keep it secure and never commit to version control.

--- 

### A quick start
```rust
use dotenv::dotenv;
use std::env;
use xplore::Xplore;

#[tokio::main]
async fn main() {
    dotenv().ok();

    let mut xplore = Xplore::new(None).await.unwrap();

    let cookie = env::var("X_COOKIE_STRING").expect("X_COOKIE_STRING");
    xplore.set_cookie(&cookie).await;

    let screen_name = "zTgx5"; // Replace with the desired screen name
    println!("Getting profile for: {screen_name}");
    let profile = xplore.get_profile(screen_name).await.expect("Failed to get profile");
    println!("Profile: {profile:#?}");
}
```

## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=zTgx/xplore&type=Date)](https://www.star-history.com/#zTgx/xplore&Date)

## License

MIT