Skip to main content

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.

Website Testing

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

DNS & Network

Analyze DNS records, network paths, and connectivity.

Security

Scan for security vulnerabilities and certificate information.

HTTP & Protocol

Test HTTP protocol support and URL redirections.

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."
}