How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenSERP Server (self-hosted)

The MIT-licensed, self-hosted OpenSERP REST server. Runs on port 7000 by default and exposes dedicated per-engine web and image search, Google and Bing SERP HTML parsing, multi-engine mega search, single and batch URL extraction, health and readiness probes, and cache, proxy-pool and circuit-breaker statistics. Ships a published OpenAPI 3.0.3 contract and a Swagger UI at /docs.

This API exposes 18 operations across 17 paths, organized into 5 resource areas, and defines 45 schemas. It is described by OpenAPI 3.0.3, at version 2.2.0.

Requests are made against a single base URL, http://127.0.0.1:7000.

18 operations 17 paths 45 schemas 14 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.2.0
Base URL
http://localhost:7000
License
Resource Areas
5

Paths & Operations 18

Across 17 paths, the API surfaces 18 operations — 14 GET, 4 POST. They span 5 resource areas: Search, Mega, Health, Stats, Docs. Each is listed below with its method, path, parameters, and response codes.

Search 7

Dedicated per-engine search endpoints

GET
/{engine}/search
Search web results from a specific engine
searchWeb 22 params → 200400403429502503504404
GET
/{engine}/image
Search image results from a specific engine
searchImages 19 params → 200400403429502503504404
POST
/google/parse
Parse a Google SERP HTML document into structured results
parseGoogleHTML 1 param body → 200400500
POST
/bing/parse
Parse a Bing SERP HTML document into structured results
parseBingHTML 1 param body → 200400500
GET
/extract
Extract clean content from one URL
extractURL 9 params → 200400502
POST
/extract
Extract clean content from one URL
extractURLPost body → 200400502
POST
/extract/batch
Extract content from multiple URLs
extractBatch 2 params body → 200400
Mega 3

Cross-engine aggregated search endpoints

GET
/mega/search
Search across multiple engines with selectable execution mode
megaSearch 25 params → 200400403429502503504500
GET
/mega/image
Image search across multiple engines with selectable execution mode
megaImageSearch 22 params → 200400403429502503504500
GET
/mega/engines
List available engines and runtime state
listMegaEngines → 200
Health 2

Health and readiness endpoints

GET
/health
Service health status
healthCheck → 200503
GET
/ready
Service readiness status
readinessCheck → 200503
Stats 4

Runtime statistics endpoints

GET
/stats
Combined cache, proxy, and circuit-breaker stats
getStats → 200
GET
/stats/cache
Cache statistics only
getCacheStats → 200
GET
/stats/proxy
Proxy pool and per-engine proxy policy statistics
getProxyStats → 200
GET
/stats/cb
Circuit breaker state per engine
getCircuitBreakerStats → 200
Docs 2

OpenAPI and Swagger UI endpoints

GET
/openapi.yaml
Get raw OpenAPI YAML
getOpenAPISpec → 200
GET
/docs
Swagger UI for interactive API docs
getSwaggerUI → 200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are Result (14 properties), ExtractResult (12 properties), SerpFeature (11 properties), ProxyStats (9 properties). Each schema is shown below with its type and property counts.

QueryEcho
object
4 properties 2 required
ResponseMeta
object
6 properties 5 required
EngineErrorDetail
object
3 properties 2 required
Pagination
object
3 properties 3 required
Position
object
1 property 1 required
DomainInfo
object
3 properties 1 required
Classification
object
2 properties
ResultType
string
SERP block type. New values require a minor version bump (meta.version: "2.1"). In v2.1, engines may emit specialized modules such as peoplealsoask when a pars…
Result
object
14 properties 11 required
ExtractedContent
object
One enriched target page. content holds a single representation chosen by the response format (plain text for format=text, markdown otherwise), named by format…
6 properties
ExtractResult
object
12 properties
ExtractHeading
object
2 properties
ExtractLink
object
2 properties
ExtractMeta
object
4 properties
FeatureItem
object
3 properties
FeatureLink
object
2 properties
SerpFeature
object
11 properties 4 required
ImageData
object
4 properties 1 required
ImageSource
object
2 properties 2 required
ImageResult
object
7 properties 7 required
ClusterOccurrence
object
3 properties 3 required
Cluster
object
8 properties 8 required
SearchEnvelope
object
5 properties 5 required
MegaSearchEnvelope
ImageEnvelope
object
4 properties 4 required
ErrorResponse
object
6 properties 2 required
EngineHealth
object
3 properties 3 required
HealthStatus
object
4 properties 4 required
ReadinessStatus
object
1 property 1 required
CacheStatsEnabled
object
8 properties 8 required
CacheStatsDisabled
object
1 property 1 required
CacheStats
ProxyTagSummary
object
2 properties 2 required
ProxyStatsEntry
object
5 properties 5 required
ProxyEngineStats
object
2 properties 1 required
LaneStats
object
Sticky proxy lane state observed by this worker.
3 properties 3 required
BrowserPoolStats
object
Live state of the per-process Chrome pool. Each authenticated upstream proxy identity (scheme+host+port+username) gets a dedicated Chrome so Chrome can answer…
4 properties 4 required
ProxyStats
object
9 properties 8 required
CircuitBreakerStat
object
6 properties 4 required
CircuitBreakerStatsResponse
object
1 property 1 required
StatsResponse
object
3 properties 3 required
MegaEngineInfo
object
3 properties 2 required
MegaEnginesResponse
object
2 properties 2 required
BatchExtractRequest
object
6 properties 1 required
BatchExtractItem
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openserp-oss-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of OpenSERP Server (self-hosted), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.