colly Documentation

File: README.md Copy Chapter

Colly

Lightning Fast and Elegant Scraping Framework for Gophers

Colly provides a clean interface to write any kind of crawler/scraper/spider.

With Colly you can easily extract structured data from websites, which can be used for a wide range of applications, like data mining, data processing or archiving.

Sponsor Copy Chapter

NodeMaven: The most efficient proxy provider for Web Scrapping and Automation with the Highest Quality IP on the market.

Why NodeMaven?

• 99.9% uptime
• ZIP Targeting
• IP filtering: all proxies have fraud score <97%
• No KYC required
• Unique free tools: Proxy Bandwidth Checker, Meta Tag Checker, IP Lookup and others!

Special codes for Colly users:

• COLLY35 - 35% off to Mobile and Residential Proxies
• COLLY40 - 40% off to ISP (Static) Proxies

Features Copy Chapter

• Clean API
• Fast (>1k request/sec on a single core)
• Manages request delays and maximum concurrency per domain
• Automatic cookie and session handling
• Sync/async/parallel scraping
• Caching
• Automatic encoding of non-unicode responses
• Robots.txt support
• Distributed scraping
• Configuration via environment variables
• Extensions

Example Copy Chapter

import (
	"fmt"

	"github.com/gocolly/colly/v2"
)

func main() {
	c := colly.NewCollector()

	// Find and visit all links
	c.OnHTML("a[href]", func(e *colly.HTMLElement) {
		e.Request.Visit(e.Attr("href"))
	})

	c.OnRequest(func(r *colly.Request) {
		fmt.Println("Visiting", r.URL)
	})

	c.Visit("http://go-colly.org/")
}

See examples folder for more detailed examples.

Installation Copy Chapter

go get github.com/gocolly/colly/v2

Bugs Copy Chapter

Bugs or suggestions? Visit the issue tracker or join #colly on freenode

Other Projects Using Colly Copy Chapter

Below is a list of public, open source projects that use Colly:

• greenpeace/check-my-pages Scraping script to test the Spanish Greenpeace web archive.
• altsab/gowap Wappalyzer implementation in Go.
• jesuiscamille/goquotes A quotes scraper, making your day a little better!
• jivesearch/jivesearch A search engine that doesn't track you.
• Leagify/colly-draft-prospects A scraper for future NFL Draft prospects.
• lucasepe/go-ps4 Search playstation store for your favorite PS4 games using the command line.
• yringler/inside-chassidus-scraper Scrapes Rabbi Paltiel's web site for lesson metadata.
• gamedb/gamedb A database of Steam games.
• lawzava/scrape CLI for email scraping from any website.
• eureka101v/WeiboSpiderGo A sina weibo(chinese twitter) scraper
• Go-phie/gophie Search, Download and Stream movies from your terminal
• imthaghost/goclone Clone websites to your computer within seconds.
• superiss/spidy Crawl the web and collect expired domains.
• docker-slim/docker-slim Optimize your Docker containers to make them smaller and better.
• seversky/gachifinder an agent for asynchronous scraping, parsing and writing to some storages(elasticsearch for now)
• eval-exec/goodreads crawl all tags and all pages of quotes from goodreads.

If you are using Colly in a project please send a pull request to add it to the list.

Contributors Copy Chapter

This project exists thanks to all the people who contribute. [Contribute].

Backers Copy Chapter

Thank you to all our backers! 🙏 [Become a backer]

Sponsors Copy Chapter

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License Copy Chapter

File: _examples/README.md Copy Chapter

Colly examples

This folder provides easy to understand code snippets on how to get started with colly.

To execute an example run go run [example/example.go]

Demo Copy Chapter

$ go run rate_limit/rate_limit.go
[000001] 1 [     1 - request] map["url":"https://httpbin.org/delay/2?n=4"] (60.872µs)
[000002] 1 [     2 - request] map["url":"https://httpbin.org/delay/2?n=2"] (154.425µs)
[000003] 1 [     3 - request] map["url":"https://httpbin.org/delay/2?n=0"] (158.374µs)
[000004] 1 [     5 - request] map["url":"https://httpbin.org/delay/2?n=3"] (426.999µs)
[000005] 1 [     4 - request] map["url":"https://httpbin.org/delay/2?n=1"] (448.75µs)
[000007] 1 [     2 - response] map["url":"https://httpbin.org/delay/2?n=2" "status":"OK"] (2.855764394s)
[000008] 1 [     2 - scraped] map["url":"https://httpbin.org/delay/2?n=2"] (2.855797868s)
[000006] 1 [     1 - response] map["url":"https://httpbin.org/delay/2?n=4" "status":"OK"] (2.855756753s)
[000009] 1 [     1 - scraped] map["url":"https://httpbin.org/delay/2?n=4"] (2.855819581s)
[000010] 1 [     3 - response] map["status":"OK" "url":"https://httpbin.org/delay/2?n=0"] (5.002065299s)
[000011] 1 [     3 - scraped] map["url":"https://httpbin.org/delay/2?n=0"] (5.002103755s)
[000012] 1 [     5 - response] map["status":"OK" "url":"https://httpbin.org/delay/2?n=3"] (5.012080614s)
[000013] 1 [     5 - scraped] map["url":"https://httpbin.org/delay/2?n=3"] (5.012101056s)
[000014] 1 [     4 - response] map["url":"https://httpbin.org/delay/2?n=1" "status":"OK"] (7.155725591s)
[000015] 1 [     4 - scraped] map["url":"https://httpbin.org/delay/2?n=1"] (7.155759136s)