Skip to content
Forjed Crawler · API

API reference

The Forjed Crawler API is currently accessible only to specific individuals. Please contact Forjed if you wish to access it.

Base URL

https://crawler.forjed.xyz/api/

Authentication

?key=fk_…

Search parameters

q
Words to search for. Supports "phrases", OR, -word, prefix* and the site:, locale: and uses: filters.
locale
One language-country pair, like fr-CA or en-GB.
language
Every country of one language: en or fr.
country
Every language of one country, like CA or BE.
site
Results from one site only.
uses
Only pages that load a given third party, like hotjar.
limit
How many results to return.
offset
How many to skip, to get the next page.

JSON Content:

total
How many results match.
limit
How many this answer holds.
offset
Where this answer starts.
nextOffset
Where the next page starts, if there is one.
rows
The results.

Endpoints

/api/search
Full-text search.
/api/pages
Crawled pages, newest first.
/api/third-parties
The most common third-party domains.
/api/hosts
The crawled sites.
/api/stats
Totals per locale.

Errors

401
No key, a mistyped one, or a revoked one.
429
Too many wrong keys from one address: it is locked out for 15 minutes.
503
This endpoint is closed for now by the operator.