{ "openapi": "3.0.1", "info": { "title": "Apple Podcasts Search + Charts API | Rankings + Watchlists", "description": "Search Apple Podcasts, fetch official Apple chart rankings, and refresh watchlists of known show IDs for recurring market-watch workflows.", "version": "0.1", "x-build-id": "IEuhWP73JFIPuXmwE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~apple-podcast-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-apple-podcast-scraper", "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/taroyamada~apple-podcast-scraper/runs": { "post": { "operationId": "runs-sync-taroyamada-apple-podcast-scraper", "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/taroyamada~apple-podcast-scraper/run-sync": { "post": { "operationId": "run-sync-taroyamada-apple-podcast-scraper", "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", "properties": { "searchTerm": { "title": "Search Term", "type": "string", "description": "Optional keyword search powered by the iTunes Search API. This is the lowest-friction quickstart lane for the first useful buyer run." }, "chartRequests": { "title": "Top Chart Requests", "type": "array", "description": "Optional array of Apple rankings requests. Leave this empty for the cheapest first success, then add one chart lane after the search quickstart is green. Each item can include {\"country\":\"us\",\"feedType\":\"podcasts\",\"limit\":10}. Supported feedType values: podcasts, podcast-episodes." }, "lookupIds": { "title": "Watchlist / Lookup IDs", "type": "array", "description": "Optional list of Apple Podcasts collection IDs to resolve through the iTunes Lookup API. Add these when you want recurring watchlist refreshes for known shows." }, "country": { "title": "Default Country Code", "type": "string", "description": "Default ISO country code for search and lookup requests (us, gb, jp, etc). Chart requests can override this per item.", "default": "us" }, "limit": { "title": "Default Limit", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of podcasts returned for search, and the default limit for chart requests that omit their own limit. Keep the first run small, then scale up only after the quickstart output is already useful.", "default": 50 }, "includeEpisodes": { "title": "Include Episodes", "type": "boolean", "description": "Also fetch recent episodes for each resolved podcast (slower). Leave this off unless episode-level context materially improves the workflow.", "default": false }, "delivery": { "title": "Delivery Mode", "enum": [ "dataset", "webhook" ], "type": "string", "description": "How to deliver results. Start with 'dataset' for reviewable output, then move to 'webhook' after the buyer approves the payload shape.", "default": "dataset" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Webhook URL to send results to when delivery is 'webhook'. Works with Slack, Discord, Zapier, or any HTTP endpoint." }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "If true, runs without saving results or sending webhooks. Useful for testing a new watch setup or validating a webhook endpoint before going live.", "default": 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 } } } } } } } } } }