{ "openapi": "3.0.1", "info": { "title": "RSS Feed Scraper API & Incremental Monitor", "description": "RSS feed scraper API for RSS, Atom and JSON Feed URLs in bulk, plus incremental monitoring for new and updated items. Get normalized records, conditional HTTP checks, per-feed failures, stable fingerprints and webhook-ready events.", "version": "0.1", "x-build-id": "IkfbYPfAnSgsrfbBA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~rss-feed-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-rss-feed-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/automa-flow~rss-feed-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-rss-feed-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/automa-flow~rss-feed-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-rss-feed-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "feeds" ], "properties": { "feeds": { "title": "Feed watchlist", "minItems": 1, "maxItems": 1000, "type": "array", "description": "One to 1,000 public RSS, Atom or JSON Feed URLs. externalId is your optional stable watchlist ID and is echoed into output. With discovery enabled, a row may instead be a public website homepage declaring a feed in its HTML head.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "title": "Feed or website URL", "type": "string", "editor": "textfield", "description": "Public HTTP(S) URL. Local, private, metadata and credential-bearing URLs are rejected." }, "externalId": { "title": "Your external ID", "type": "string", "editor": "textfield", "maxLength": 200, "description": "Stable ID from your CRM, pipeline or watchlist. Use a unique value per feed." } } } }, "mode": { "title": "Run mode", "enum": [ "monitor", "snapshot" ], "type": "string", "description": "monitor stores the last successful feed state in KVS and classifies items. snapshot returns current items without reading or writing monitoring state.", "default": "snapshot" }, "outputMode": { "title": "Item output", "enum": [ "changesOnly", "all" ], "type": "string", "description": "On a first monitor run, changesOnly emits only the BASELINE feed_summary. Later it emits NEW_ITEM and UPDATED_ITEM rows plus every feed_summary. Snapshot always returns current items.", "default": "all" }, "maxItemsPerFeed": { "title": "Max items per feed", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum entries normalized from each current feed response. This never follows article links or downloads podcast media.", "default": 100 }, "discoverFeedFromWebsite": { "title": "Discover feed from website", "type": "boolean", "description": "When enabled on the first run, inspect exactly one homepage HTML head and select a declared feed. Preference is RSS, then Atom, then JSON Feed, with document order breaking ties. No site crawl is performed.", "default": false }, "monitorId": { "title": "Monitoring scope ID", "maxLength": 200, "type": "string", "description": "Stable scope for direct/API monitor runs that share the named state store. Saved Actor Tasks are isolated automatically by Task ID; otherwise monitorId is required. Keep this value unchanged across runs that should share history." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not required for normal operation. Direct HTTP is the measured default. If a public feed needs an Apify datacenter proxy, opt in here; residential proxy is not expected.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }