geekflare-api
Official Python SDK for the Geekflare.
- API version: 1.0.0
- Package version: 0.3.2
Requirements.
Python 3.10+
Installation & Usage
pip install
pip install geekflare-api
Quick Start
from geekflare_api.client import GeekflareClient
from geekflare_api.models import WebScrapeDto
with GeekflareClient(api_key="your-api-key") as client:
result = client.web_scrape(WebScrapeDto(url="https://toscrape.com/"))
print(result)
Available Methods
| Method | Description |
|---|---|
client.meta_scrape(body) |
Scrape meta tags from a URL |
client.web_scrape(body) |
Scrape web page content |
client.brand(body) |
Get structured brand and company information for a domain |
client.dns_record(body) |
Look up DNS records |
client.screenshot(body) |
Take a screenshot of a URL |
client.site_status(body) |
Check if a site is up or down |
client.redirect_check(body) |
Check redirect chain of a URL |
client.broken_link(body) |
Find broken links on a page |
client.url2_pdf(body) |
Convert a URL to PDF |
client.open_ports(body) |
Scan open ports on a host |
client.tls_scan(body) |
Scan TLS/SSL configuration |
client.load_time(body) |
Test page load time |
client.mixed_content(body) |
Check for mixed content issues |
client.dns_sec(body) |
Check DNSSEC configuration |
client.mtr(body) |
Perform MTR network test |
client.ping(body) |
Ping a host |
client.lighthouse(body) |
Run Lighthouse audit |
client.search(body) |
Perform a web search |
Error Handling
import geekflare_api
from geekflare_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.geekflare.com
# See configuration.py for a list of all supported configuration parameters.
configuration = geekflare_api.Configuration(
host = "https://api.geekflare.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: x-api-key
configuration.api_key['x-api-key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with geekflare_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = geekflare_api.ApiToolApi(api_client)
broken_link_dto = geekflare_api.BrokenLinkDto() # BrokenLinkDto |
try:
# Check if a webpage contains broken links
api_response = api_instance.broken_link(broken_link_dto)
print("The response of ApiToolApi->broken_link:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiToolApi->broken_link: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.geekflare.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApiToolApi | brand | POST /brand | Get brand data for a domain |
| ApiToolApi | broken_link | POST /brokenlink | Check if a webpage contains broken links |
| ApiToolApi | dns_record | POST /dnsrecord | Retrieve DNS records for a given domain |
| ApiToolApi | dns_sec | POST /dnssec | Check if DNSSEC is enabled for a domain |
| ApiToolApi | lighthouse | POST /lighthouse | Run Lighthouse audit on a website |
| ApiToolApi | load_time | POST /loadtime | Measure the page load time for a given URL |
| ApiToolApi | meta_scrape | POST /metascraping | Scrape a webpage meta with custom options |
| ApiToolApi | mixed_content | POST /mixedcontent | Check for mixed content on a site |
| ApiToolApi | mtr | POST /mtr | Perform MTR (My Traceroute) network diagnostic test |
| ApiToolApi | open_ports | POST /openport | Scan a website for open ports |
| ApiToolApi | ping | POST /ping | Perform ICMP Ping test on a given URL or IP |
| ApiToolApi | redirect_check | POST /redirectcheck | Check the redirection chain of a given URL |
| ApiToolApi | screenshot | POST /screenshot | Capture a full-page screenshot of a website |
| ApiToolApi | search | POST /search | Search API for AI Agents & LLMs |
| ApiToolApi | site_status | POST /up | Check if a site is up or down |
| ApiToolApi | tls_scan | POST /tlsscan | Perform TLS scan for a given domain |
| ApiToolApi | url2_pdf | POST /url2pdf | Capture a full-page Url2Pdf of a website |
| ApiToolApi | web_scrape | POST /webscraping | Scrape a webpage with custom options |
Documentation For Models
- BaseErrorResponseDto
- BrandButtonStyleDto
- BrandColorEntryDto
- BrandColorsDto
- BrandCompanyDto
- BrandComponentsDto
- BrandDataDto
- BrandDto
- BrandFontDto
- BrandLinksDto
- BrandLocationDto
- BrandLogoDto
- BrandMetaDto
- BrandPageMetaDto
- BrandResponseDto
- BrandSocialProfileDto
- BrandSpacingDto
- BrandTypographyDto
- BrokenLinkDto
- BrokenLinkMetaDto
- BrokenLinkResponseDto
- BrokenLinkSummaryDto
- DefaultExtractionFieldDto
- DetectedServiceDto
- DnsMetaDto
- DnsRecordDto
- DnsRecordResponseDto
- DnsSecDataDto
- DnsSecDto
- DnsSecMetaDto
- DnsSecResponseDto
- ExtractionSchemaDto
- ExtractionSchemaDtoFieldsInner
- GroundedAnswerDataDto
- GroundedAnswerResponseDto
- GroundedSourceDto
- HealthResponseDto
- ImageSearchResponseDto
- ImageSearchResultItemDto
- KeywordsAiPromptDto
- LighthouseDto
- LighthouseMetaDto
- LighthouseResponseDto
- ListingAiPromptDto
- LoadTime200Response
- LoadTimeDataDto
- LoadTimeDto
- LoadTimeLocationResultDto
- LoadTimeMetaDto
- LoadTimeMultiLocationMetaDto
- LoadTimeMultiLocationResponseDto
- LoadTimeMultiLocationResponseDtoSummary
- LoadTimeResponseDto
- MarginDto
- MetaScrapeDto
- MetaScrapeMetaDto
- MetaScrapeResponseDto
- MetaScrapeResponseDtoData
- MixedContentDataDto
- MixedContentDto
- MixedContentMetaDto
- MixedContentResponseDto
- MixedContentResponseDtoData
- MtrDataDto
- MtrDto
- MtrMetaDto
- MtrResponseDto
- NetworkDto
- OpenPortDto
- OpenPortMetaDto
- OpenPortResponseDto
- PingDataDto
- PingDto
- PingMetaDto
- PingResponseDto
- PortServiceDetectionResultDto
- PromptAiPromptDto
- ProtocolSupportDto
- RedirectCheckDto
- RedirectCheckMetaDto
- RedirectCheckResponseDto
- RedirectHopDto
- SchemaAiPromptDto
- ScreenshotDto
- ScreenshotInlineDto
- ScreenshotMetaDto
- ScreenshotResponseDto
- Search200Response
- SearchHtmlResponseDto
- SearchMarkdownResponseDto
- SearchMetaDto
- SearchRequestDto
- SearchResponseDto
- SearchResultItemDto
- SelectorExtractionFieldDto
- SentimentAiPromptDto
- ServiceHealthResponseDto
- ServiceStatus
- SiteStatusDto
- SiteStatusMetaDto
- SiteStatusResponseDto
- SummaryAiPromptDto
- TestMetaDto
- TimingsDto
- TlsAdvisoryDto
- TlsCertificateChainDto
- TlsCertificateChainEntryDto
- TlsCertificateDto
- TlsCertificateIssuerDto
- TlsForwardSecrecyDto
- TlsProtocolsDto
- TlsScanDataDto
- TlsScanDto
- TlsScanMetaDto
- TlsScanResponseDto
- TlsVulnerabilitiesDto
- Url2PdfDto
- Url2PdfMetaDto
- Url2PdfResponseDto
- WebScrapeDto
- WebScrapeDtoAiPrompt
- WebScrapeDtoProxyMode
- WebScrapeMetaDto
- WebScrapeResponseDto
- WebScrapeResponseDtoData
Documentation For Authorization
Authentication schemes defined for the API:
x-api-key
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
bearer-token
- Type: Bearer authentication (JWT)
gf_auth_session
- Type: API key
- API key parameter name: gf_auth_session
- Location:
Links
License
MIT
mcp-name: com.geekflare/mcp
Metadata
Release files for geekflare-api 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| geekflare_api-0.3.2.tar.gz | 116.3 kB | Without provenance | Details for geekflare_api-0.3.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| geekflare_api-0.3.2-py3-none-any.whl | Python 3 | none | any | Details for geekflare_api-0.3.2-py3-none-any.whl |
Total release size: 373.7 kB
Release files / geekflare_api-0.3.2.tar.gz
| Download URL | geekflare_api-0.3.2.tar.gz |
|---|---|
| Size | 116.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d9c1fdcbdf33ab4aac4cd8998965b8a0210c287dfe9eaf907dd37826953b8e35
|
|
BLAKE2b-256 checksum How to use checksums |
b05f6b9f73003a97d6900c7c078170b4d3cadbcf4756fb3e1fbe1b4f4f611fbe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.4
|
Release files / geekflare_api-0.3.2-py3-none-any.whl
| Download URL | geekflare_api-0.3.2-py3-none-any.whl |
|---|---|
| Size | 257.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
56a8d5a84e3ab64d5582d900b0fcbfb1d7035d296bd59390bc53182e84c5f5d9
|
|
BLAKE2b-256 checksum How to use checksums |
afb1c67cc3dad1a8d22c0c87b951fa6217b9bb7630cf1a26c208398157e3288e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.4
|
Security for geekflare-api 0.3.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.