OpenAPI Discovery & Contract Auditor

Discover OpenAPI documents from website URLs and audit contract version, paths, operations, security schemes and regressions for API integration and monitoring.

Why use this Actor

API and integration teams need to discover machine-readable contracts, understand operation/auth surface and detect integration-breaking contract regressions.

Key features

• Buyer-native inputs aligned to OpenAPI discovery auditor.
• Predictable structured output in the default Apify Dataset.
• Pay Per Event pricing tied to measurable result rows or reports.
• Optional MCP connector delivery for downstream automation and AI agents.

Quick start

Start with this working example and replace the target values with your own:

{
  "urls": [
    "https://example.com",
    "https://www.python.org"
  ]
}

The Actor writes structured results to the default Apify Dataset and can be used from the Store, API, schedules, Tasks, automations and MCP-compatible AI workflows.

Input

• urls — API or documentation URLs: Configure API or documentation URLs for this Actor run.
• discoveryPaths — Discovery paths: Configure Discovery paths for this Actor run.
• previousSnapshots — Previous contract snapshots: Configure Previous contract snapshots for this Actor run.
• failRunOnRegression — Fail on contract regression: Configure Fail on contract regression for this Actor run.
• maxUrls — Maximum APIs: Configure Maximum APIs for this Actor run.

All integration and advanced analysis fields are optional. The default example is intentionally runnable without configuring MCP or a previous-run baseline.

Output

The Dataset exposes predictable machine-readable output. Representative fields include dataset.

Pricing

This Actor uses Pay Per Event. The current factory base price is $0.001600 per result event. The Apify Store remains the source of truth for the price and plan/tier details shown to the buyer.

Use cases

• Run the buyer-ready workflows exposed as Apify Tasks without preparing a custom integration first.
• Use the Actor from API or schedules for recurring collection, comparison or monitoring.
• Feed the structured Dataset output into spreadsheets, databases, automations or AI agents.
• Compare repeat runs when the product supports snapshots or previous-run inputs.

Automation and AI

Use the same Actor through Apify API, schedules, public Tasks and the Apify MCP server. Outputs are structured for downstream workflows and AI agents rather than requiring manual copy/paste.

Limitations

• Public websites and upstream APIs can change markup, access rules, rate limits or field availability without notice.
• Fields that are not publicly available are returned as unavailable or omitted rather than fabricated.
• Analytical outputs depend on the quality and coverage of the supplied or collected source data.
• Treat marketplace, reputation, workforce, safety or commercial signals as decision support and validate material decisions against the underlying source evidence.

Detailed documentation

Detailed documentation

Detailed documentation

Why use this Actor

Public APIs often expose a machine-readable contract, but the document may move, disappear, lose operations, change authentication declarations, or drift during a release. API teams and integration builders need more than a raw specification download. This Actor discovers common public contract locations, summarizes the callable surface, fingerprints the important contract structure, and compares it with previous observations so automated workflows can detect regressions before integrations fail somewhere less convenient.

Key features

• Checks caller-provided URLs and common OpenAPI/Swagger discovery paths.
• Recognizes OpenAPI 3.x and Swagger 2.0 contracts in JSON or YAML.
• Inventories paths, HTTP methods, operation IDs, servers, and security schemes.
• Distinguishes missing documents from discovered but incomplete contracts.
• Computes a deterministic contract-health score with issue codes.
• Creates a normalized contract snapshot and fingerprint.
• Compares previous snapshots and reports changed fields and operation-count regressions.
• Supports fail-after-evidence behavior for contract regression gates.
• Rejects private and reserved network destinations.

Input

Provide urls containing public API, developer portal, or documentation origins. discoveryPaths can override the common paths checked. previousSnapshots enables change detection. Use failRunOnRegression when a pipeline should fail after writing evidence if a contract materially regresses.

Output

Each result includes discovery status, final contract URL, spec version, path count, operation count, sampled operation inventory, server list, security schemes, contract score, fingerprint, changed fields, regression state, issue codes, and an agentAction.

Example

{
  "urls": ["https://petstore3.swagger.io"],
  "discoveryPaths": ["/openapi.json", "/swagger.json", "/v3/api-docs"],
  "previousSnapshots": {},
  "failRunOnRegression": false
}

Use cases

• API release QA.
• Partner integration monitoring.
• Developer portal health checks.
• Agent and MCP tool preparation.
• API migration validation.
• Contract inventory for platform engineering.

Pricing

Billing is pay per audited API result. No external API catalog or paid AI service is required.

Limitations

Authenticated/private specifications and runtime endpoint testing are outside scope. Extremely large or non-standard documents may be rejected conservatively. A declared contract can still differ from server behavior.

Privacy and permissions

Only public HTTP(S) targets are queried. Private, loopback, link-local, and reserved destinations are rejected.

Input reliability — 25 October 2026

Target lists are validated before network work, trimmed and deduplicated. Empty lists and malformed baselines are rejected rather than silently auditing a default website. Exact duplicate targets produce one result. Existing output fields and prices are preserved.