Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.geekflare.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This section provides detailed documentation for all available API endpoints, including request parameters, response formats, and code examples. All API endpoints use the base URL: 
https://api.geekflare.com

​
Available Endpoints

The Geekflare API is comprised of the following endpoint categories:

​
AI & Scraping

Scrape LLM-ready content, capture screenshots, and generate PDFs.

Web Scraping

Extract LLM-ready, JSON and HTML from web pages.

Meta Scraping

Extract metadata in markdown or JSON format from web pages.

Search

Aggregates results, removes noise, and returns clean structured data. Supports JSON, Markdown, HTML, and Image search.

Screenshot

Capture full-page screenshots using desktop or mobile device.

PDF Generator

Convert any URL to a PDF document.

​
Website Testing

Test and monitor website performance, broken links, and overall site health.

Broken Link Checker

Check if a webpage contains any broken links.

Mixed Content

Detect mixed HTTP/HTTPS content on web pages.

Lighthouse

Run Google Lighthouse audits for performance and SEO.

Load Time

Measure total time taken to load webpage.

URL Redirection

Track URL redirects with status codes and headers.

​
DNS & Network

Analyze DNS records, network paths, and connectivity.

DNS Records

Retrieve DNS records for any domain.

DNSSEC

Test if DNSSEC is enabled on a domain.

MTR

Traceroute domain or IP to check network path.

Ping

Test reachability and get latency information.

​
Security

Scan for security vulnerabilities and certificate information.

TLS Scan

Check TLS versions and certificate details.

Port Scanner

Scan for open TCP ports on a domain or IP.

​
Common Parameters

Many endpoints share common parameters:
​
url
string
required
The URL or domain to be tested
​
proxyCountry
string
Proxy country code for testing from different locations. See supported APIs for available options.
Proxy is available to premium plan users only.
​
followRedirect
boolean
Whether to follow HTTP redirects. Default is false.
​
device
string
Device type for rendering. Options: desktop, mobile. Default is desktop.

​
Response Format

All API responses follow a consistent structure:

​
Success Response

{
  "timestamp": 1657109686205,
  "apiStatus": "success",
  "apiCode": 200,
  "message": "Operation completed successfully",
  "meta": {
    "url": "example.com",
    "test": {
      "id": "unique-test-identifier"
    }
  },
  "data": {}
}

​
Error Response

{
  "timestamp": 1657109686205,
  "apiStatus": "failure",
  "apiCode": 403,
  "message": "You are not allowed to access. This is available to premium plan only."
}