Fast web scraping
- Description
- Output Format
- Usage as a CLI Application
- Usage as a Server
- Building and Developing
- Roadmap
scrape provides a self-contained low-to-no-setup tool to grab metadata and text content from web pages at medium scale.
Results are stored, so subsequent fetches of a particular URL are fast. Install the binary, and operate it as a shell command or a server with a REST API. The default SQLite storage backend is performance-optimized and can store to disk or in memory. Scraped resources are stored on a 30-day TTL, but you can clear the database at any time (in-memory DBs are wiped whenever the server process dies).
RSS and Atom feeds are supported via an endpoint in scrape-server. Loading a feed returns the parsed results for all item links in the feed.
The scrape and scrape-server binaries should be buildable and runnable in any cgo-enabled environment where SQLite3 is present. A docker build is also included.
scrape is powered by:
- go-trafilatura HTML parsing
- gofeed Atom and RSS parsing
- sqlite data storage
JSON output is a superset of Trafilatura format. Empty fields may be omitted in responses.
| Field | Type | Description |
|---|---|---|
OriginalURL |
String | Exactly the url that was in the inbound request |
RequestedURL |
URL | The URL that was actually requested. (Some URL params (e.g. utm_*) may be stripped before the outbound request) |
StatusCode |
Int | The status code returned by the target server when fetching this page |
Error |
String | Error message(s), if there were any, while processing this page |
Hostname |
Domain name | The domain serving this resource |
URL |
URL | The (canonical) URL for the page, as reported by the page itself. If the page doesn't supply that, this field will contain the same value as RequestedURL |
Date |
ISO8601 | The publish date of the page, in UTC time |
FetchTime |
ISO8601 | The time that URL was retrieved |
Sitename |
Text | Identifies the publisher. Can be domain, company name, or other text, IRL usage not consistent |
Image |
URL | Hero image link |
Title |
Text | The page's title |
Author |
Text | Author |
Description |
Text | Page summary or excerpt |
Categories |
Array | Content categories, if supplied |
Tags |
Array | Tags, if supplied |
ID |
Text | Generally empty |
License |
Text | Generally empty |
Language |
Text | 2-letter language code |
PageType |
Text | If it's there it's usually "article" following the `og`` usage |
ContentText |
Text | The text of the page, with all HTML removed |
Parsed field content is largely dependent on metadata included in the page. GIGO/YMMV.
Here's an example, with long fields truncated:
{
"OriginalURL": "https://www.nasa.gov/missions/webb/nasas-webb-stuns-with-new-high-definition-look-at-exploded-star/",
"RequestedURL": "https://www.nasa.gov/missions/webb/nasas-webb-stuns-with-new-high-definition-look-at-exploded-star/",
"Title": "NASA’s Webb Stuns With New High-Definition Look at Exploded Star - NASA",
"Author": "Steve Sabia",
"URL": "https://www.nasa.gov/missions/webb/nasas-webb-stuns-with-new-high-definition-look-at-exploded-star/",
"Hostname": "www.nasa.gov",
"Description": "Like a shiny, round ornament ready to be placed in the perfect spot on a holiday tree, supernova remnant Cassiopeia A (Cas A) gleams in a new image from",
"Sitename": "NASA",
"Date": "2023-12-10T00:00:00Z",
"Categories": [
"Astrophysics",
"Goddard Space Flight Center",
"James Webb Space Telescope (JWST)",
"Missions",
"Nebulae",
"Science \u0026 Research",
"Stars",
"Supernovae",
"The Universe"
],
"Tags": [
"Astrophysics",
"Goddard Space Flight Center",
"James Webb Space Telescope (JWST)",
"Missions",
"Nebulae",
"Science \u0026 Research",
"Stars",
"Supernovae",
"The Universe"
],
"ID": "",
"Fingerprint": "",
"License": "",
"Language": "en",
"Image": "https://www.nasa.gov/wp-content/uploads/2023/12/webb-stsci-01hggzdyh8ghhssnwzd71mf0xh-2k.png",
"PageType": "article",
"ContentText": "Mysterious features hide in near-infrared light Like a shiny, round ornament ready to be placed in the perfect spot on a holiday tree, supernova remnant Cassiopeia A (Cas A) gleams in a new image from NASA’s James Webb Space Telescope. As part of the 2023...(there's about 10x more content in this example, truncated in the docs for readability)",
"FetchTime": "2023-12-18T03:37:14Z"
}go install github.com/efixler/scrape/cmd/scrape@latest
The scrape command provides single and batch retrieval, using or bypassing the connected storage db. It also provide command to manage the backing store.
> scrape http://www.foo.com/some/url/path
That's actually it. The database will be created if it doesn't exist already.
scrape % ./scrape -h
Usage:
scrape [flags] :url [...urls]
-h
Show this help message
-clear
Clear the database and exit
-csv string
CSV file path
-csv-column int
The index of the column in the CSV that contains the URLs (default 1)
-database string
Database file path (default "scrape_data/scrape.db")
-maintain
Execute database maintenance and exit
-notext
Skip text content
The server provides a REST API to get resource data one-at-a-time or in bulk. The root URL serves up a page that can be used to spot check results for any url.
scrape-server is intended for use in closed environments at medium scale. There's no authentication, rate limiting or url sanitization beyond encoding checks. Don't deploy this on an open public network. Do deploy it as a sidecar, in a firewalled environment, or another environment that won't get unbounded quantities of hits.
go install github.com/efixler/scrape/cmd/scrape-server@latest
Usage:
scrape-server [-port nnnn] [-h]
-h
Show this help message
-database string
Database path. If the database doesn't exist, it will be created.
Use ':memory:' for an in-memory database (default "scrape_data/scrape.db")
-log-level value
Set the log level [debug|error|info|warn] (default info)
-port int
The port to run the server on (default 8080)
-profile
Enable profiling at /debug/pprof (default off)
Use caution when using the in-memory database: There are currently no constraints on database size.
The root path of the server (/) is browsable and provides a simple url to test URLs and results.
Returns the metadata for the supplied list of URLs. Returned metadatas are not guaranteed to be in the same order as the request.
The batch endpoint behaves indentically to the extract endpoint in all ways except two:
- The endpoint returns an array of the JSON payload described above
- When individual items have errors, the request will still return with a 200 status code. Inspect the payload for individual items to determine the status of an individual item request.
| Param | Description | Required |
|---|---|---|
| urls | A JSON array of the urls to fetch | Y |
Fetch the metadata and text content for the specified URL. Returns JSON payload as decribed above.
If the server encounters an error fetching a requested URL, the status code for the request will be set to 422 (Unprocessable Entity). This may change.
The returned JSON payload will include a StatusCode field in all cases, along with an Error field when
there's an error fetching or parsing the requested content.
| Param | Description | Required |
|---|---|---|
| url | The url to fetch. Should be url encoded. | Y |
| StatusCode | Description |
|---|---|
| 415 | The requested resource was for a content type not supported by this service |
| 422 | The request could not be completed |
| 504 | The request for the target url timed out |
In all other cases, requests should return a 200 status code, and any errors received when fetching a resource will be included in the returned JSON payload.
Feed parses an RSS or Atom feed and returns the parsed results for each of the item links in the feed.
| Param | Description | Required |
|---|---|---|
| url | The feed url to fetch. Should be url encoded. | Y |
| StatusCode | Description |
|---|---|
| 422 | The url was not a valid feed |
| 504 | Request for the feed timed out |
These params work for any endpoint
| Param | Value | Description |
|---|---|---|
| pp | 1 | Pretty print JSON output |
Best to build with make. The Makefile has a help target, here is its output:
Usage:
make
build build the binaries, to the build/ folder (default target)
clean clean the build directory
docker-build build the docker image
docker-run run the docker image, binding to port 8080, or the env value of SCRAPE_PORT
test run the tests
vet fmt, vet, and staticcheck
cognitive run the cognitive complexity checker
help show this help message
The Docker is mostly intended for distribution and testing. The docker build
pulls the source from the repo via go install and the latest tag, so, this build will
not be up to date with local changes.
By default, the Docker will run using an in-memory database. This can be changed by modifying the arguments passed to scrape-server in the Dockerfile ENTRYPOINT.
The docker-run make target docker will mount a local folder called docker/data and bind that to the container for file storage. If you want to use a file-based db you can use this directory, or update the Makefile to mount the desired local directory.
- Improve test coverage
- Enforce TTLs and DB capacity limits for record eviction (TTLs are enforced, but not proactively flushed)
- Expose TTL, Request Timeout, and User Agent configuration
- Outbound request pacing
- Headless fallback for pages that require Javascript
- Add test coverage to cmd/.../main.go files
- Explore performance optimizations if needed, e.g.
- Batch request parallelization
- zstd compression for stored resources
Feature request or bug? Post issues here.