Getting Started

Welcome to the Searrrch API documentation. Searrrch provides affordable, high-performance web search and crawl capabilities for your applications.

1. Get your API Key

To get started, simply:

1. Sign up on our Dashboard.
2. Generate your API Key. (You will get $1 balance upon signup!)
3. Keep your API key secure and do not share it.

2. API Reference

All requests must include your API key in the header:

Authorization: Bearer <API_KEY>

---

Web Search API

Use this endpoint to perform web searches and retrieve search results.

Endpoint: GET api.searrrch.com/v1/web-search

Headers:

Authorization: Bearer <API_KEY>

Query Parameters:

Parameter	Required	Description
q	Yes	The search query.
language	No	Code of the language (e.g., en, zh-CN).
pageno	No	Search page number. Default is 1.
time_range	No	Time range of search (day, month, year).

Example Request:

curl "https://api.searrrch.com/v1/web-search?q=open+source+LLM" \
  -H "Authorization: Bearer YOUR_API_KEY"

---

Web Crawl API

Use this endpoint to extract markdown content from a specific webpage.

Endpoint: GET api.searrrch.com/v1/web-crawl

Headers:

Authorization: Bearer <API_KEY>

Query Parameters:

Parameter	Required	Description
url	Yes	The URL to crawl.

Example Request:

curl "https://api.searrrch.com/v1/web-crawl?url=https://example.com" \
  -H "Authorization: Bearer YOUR_API_KEY"