Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leo5imon/farcaster-scraper
Script for Farcaster scraping, using Neynar API.
https://github.com/leo5imon/farcaster-scraper
farcaster farcaster-protocol neynar
Last synced: 9 days ago
JSON representation
Script for Farcaster scraping, using Neynar API.
- Host: GitHub
- URL: https://github.com/leo5imon/farcaster-scraper
- Owner: leo5imon
- Created: 2024-02-07T14:26:18.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-01T08:13:11.000Z (10 months ago)
- Last Synced: 2024-12-01T01:42:34.928Z (12 days ago)
- Topics: farcaster, farcaster-protocol, neynar
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 12
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-farcaster - leo5imon/farcaster-scraper
- awesome-farcaster-dev - `farcaster-scraper`
- awesome-farcaster-dev - `farcaster-scraper`
README
# 🌟 Farcaster Scraper 🌟
Welcome to the **Farcaster Scraper**! This powerful CLI tool leverages the Neynar API to dive into the depths of Farcaster, allowing you to fetch, filter, and fine-tune your search for Imgur URLs based on specific criteria. Perfect for data enthusiasts, content creators, and meme lovers alike, our tool brings the vast universe of Farcaster content right to your command line.
## ✨ Features
- **Comprehensive Fetching:** Retrieve all posted content from your favorite Farcaster channels with ease.
- **Interactive Filtering:** Use likes, recasts, and follower counts to filter content, ensuring you only get the best.
- **Targeted Searches:** Specifically filter for images or URLs hosted on `imgur.com`, or customize it to your preference.
## 🚀 Installation
Embark on your Farcaster scraping adventure with these simple steps:
```bash
git clone https://github.com/leo5imon/farcaster-scraper.git
cd farcaster-scraper
npm install
```
Don't forget to secure your Neynar API key and set it up in your `.env` file for seamless access.
## 📚 How to Use
Once installed, dive into the world of Farcaster content by executing the `fetch` command with customizable options:
```bash
node src/index.js fetch --channelId="yourFavoriteChannel" --likeThreshold=50 --limit=100
```
Tailor your search with parameters like `likeThreshold`, `recastThreshold`, `followerCountThreshold`, and more to find exactly what you're looking for.
(for more information, run `node src/index.js fetch --help`)
## 🤝 Contributing
We're on the lookout for enthusiastic contributors who want to make Farcaster Scraper even better! 🌈 If you're ready to add features, fix bugs, or improve functionality, here's how you can join in:
1. **Fork** this repository to your own GitHub account.
2. **Clone** your fork and create a new branch for your contributions.
3. **Code** away your improvements.
4. **Commit** your changes with clear, descriptive messages.
5. **Push** your updates back to your fork on GitHub.
6. Open a **Pull Request** here, and let's discuss your awesome enhancements!
Thank you for considering contributing to Farcaster Scraper. Your efforts help make our community vibrant and our tool more effective!
---
Happy Scraping! 🎉 Dive into Farcaster content like never before with **Farcaster Scraper**.