OpenAPI JSON Operation Inventory API

Inventory declared OpenAPI/Swagger operations, parameters, response codes and security declarations from public JSON specs. No endpoint execution or reference fetching.

Quick start

{
  "urls": [
    "https://petstore3.swagger.io/api/v3/openapi.json"
  ],
  "maxItems": 20
}

Download the default dataset as JSON, CSV or Excel. Read OUTPUT before relying on completeness; source availability can change. Use sources you are authorized to access.

Documented behavior and limits

Supports JSON OpenAPI 3.0.x/3.1.x and Swagger 2.0; one public document per run, up to 300 operations. Lists method/path, operationId, summary, deprecation flag, merged inline path/operation parameters, declared response codes and root/operation security declarations. An operation security=[] overrides root security. Duplicate operation IDs and unresolved Path Item references appear in OUTPUT. References are preserved and never fetched, including external refs. No schema validation, compatibility judgment, auth testing, server discovery, endpoint execution, YAML parsing, callback inventory or arbitrary remote dependency retrieval. An empty paths object is valid zero-result input. The document must be public and at most 2 MiB decoded. Cap truncation and unresolved Path Items make operation inventory incomplete.

Changes and snapshots

Each result includes itemKey, contentHash and observedAt. Pass SNAPSHOT.previousHashes in the next input. NO_BASELINE means no prior map; FIRST_SEEN means absent from a supplied map; UNCHANGED/CHANGED compare hashes. FIRST_SEEN does not prove newly created content. Snapshot contains only emitted rows. Missing rows are not deletions. No hidden persistence or scheduled tasks. For header observations, redirect trace is excluded from the hash; it remains in output. Other observations hash their normalized fields, excluding pagination source URL and time.

Pricing

$0.0008 per emitted operation observation ($0.8 per 1,000), plus $0.005 Actor-start at the default 256 MB. Higher memory can multiply startup events under Apify rules. Event-only pricing includes platform usage; no paid upstream API, proxy or browser. Failed sources incur no result event, but the start event can apply. An intentional missing-policy observation is billable for the robots product. Check Store pricing before running. Budget truncation sets PARTIAL_BUDGET and complete=false.

Network and data

Public HTTP(S), ports 80/443 only; credentials and private IPs rejected. DNS addresses are validated and pinned while TLS hostname verification stays enabled. Up to five redirects, 2 MiB decoded responses and approximately 95 seconds network budget. Site/content/spec fetches respect robots.txt; missing 404/410 policy allows access, unavailable/denied policy is an error. The robots product reads the policy file itself and never requests the evaluated page. No login, cookies, proxy, access-block workaround, external reference fetching or active security tests. All failed sources are reported; successful sources can continue. A run with no rows and source errors fails; valid empty collections/specs can succeed. Sources, redirects and their robots files are the only network targets. Inputs and output stay in your Apify run storage under platform retention; no separate customer analytics endpoint. Do not provide secrets.

Integration and support

POST https://api.apify.com/v2/actors/soilair~openapi-json-operation-inventory-api/runs with your Apify authorization header and input JSON. Poll the returned run and retrieve its defaultDatasetId and defaultKeyValueStoreId for OUTPUT/SNAPSHOT. Configure integrations/schedules in Console if needed; the Actor creates neither. Developed with AI assistance, fixtures and public-source/cloud checks. Examples do not establish arbitrary-source compatibility. Report a run ID and expected behavior through the issue tab without credentials.

Source specification: https://spec.openapis.org/oas/v3.0.3.html