Skip to content

Commit

Permalink
docs: include web and discord profile endpoints (#80)
Browse files Browse the repository at this point in the history
  • Loading branch information
obasilakis authored Jun 12, 2024
1 parent 238c155 commit aef87e2
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions docs/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,31 @@ To get started, follow **[this walkthrough](./setup/intro.md).**

### 1. Validator API Endpoints

1. **Profile Endpoint**
1. **Twitter Profile Endpoint**

- `GET /data/twitter/profile/{handle}`
- `GET /data/twitter/profile/{handle}`

2. **Followers Endpoint**

- `GET /data/twitter/followers/{handle}`
2. **Twitter Followers Endpoint**

- `GET /data/twitter/followers/{handle}`


3. **Recent Tweets Endpoint**
- `POST /data/twitter/tweets/recent`
- **Body:** `{ "query": "keyword", "count": 10 }`

- `POST /data/twitter/tweets/recent`
- **Body:** `{ "query": "keyword", "count": 10 }`


4. **Web Scraper Endpoint**

- `POST /data/web`
- **Body:** `{ "url": "https://github.com", "depth": 1 }`


5. **Discord Profile Endpoint**

- `GET /data/discord/profile/{user_id}`

### 2. Validator Forwarding Functions

Expand Down

0 comments on commit aef87e2

Please sign in to comment.