Docs/Search API/Scrape

Scrape API

Give it a URL, get the page back as clean text and a list of links.

POST/v1/scrape
$0.0010 / page
docs.example/guide/tides
text0 chars

# Tides

Tides are the regular rise and fall of the sea. They follow the Moon and the Sun, and most coasts see two highs a day.

## Spring and neap

The largest tides happen when the bodies line up: see spring tides. Look up a harbor in the tide tables before you sail.

## Reading the water

High water and low water are listed with their height. A rising tide is called the flood, a falling tide the ebb.

links0
Moon/moon
Sun/sun
spring tides/spring-neap
tide tables/tide-tables
POST/v1/scrapekey required
200okapplication/jsonBearer vk-…billed $0.0010 per page
Pick a status to see the error body the gateway returns.

Request

POST /v1/scrapecURL
curl https://venym.io/v1/scrape \  -H "Authorization: Bearer $VENYM_API_KEY" \  -H "Content-Type: application/json" \  -d '{"url": "https://example.com/article", "max_chars": 8000}'
urlstring, required
Must be http or https. Localhost and private network addresses are refused (10.x, 192.168.x, 127.x, link-local).
max_charsinteger
Truncate the returned text. Default 20000, maximum 100000.

Response

payload.jsonJSON
{  "url": "https://example.com/article",  "title": "Article title",  "text": "Main text of the page...",  "links": ["https://example.com/next", "https://example.org/ref"],  "cost_usd": 0.001}
  • text has scripts, styles and page chrome removed, with paragraph breaks kept.
  • links are the absolute http(s) links found on the page. It may be omitted.
  • Pages that need JavaScript to render may come back thin. We fetch what the server sends.

Pricing

$0.0010 per successful scrape, from your prepaid balance. Failed scrapes are not charged.

Errors

  • 400 if url is missing.
  • 401 key problems, 402 out of credits. See errors.
  • 502 if the fetch failed, the URL is not allowed, or the target returned an error. The message says which.

Pair it with search: search to find pages, scrape to read them.