{ "openapi": "3.0.1", "info": { "title": "News API - Blogs, Forums and Reviews Search, Webz.io", "description": "Search news articles, blog posts, forum discussions and customer reviews from the open web with Boolean queries and filters for language, country, site, category, sentiment, people, companies and tickers, using the Webz.io News, Blogs, Forums and Reviews APIs. Bring your own API token.", "version": "0.1", "x-build-id": "RadsU062qpdl4GKqd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~news-blogs-forums-reviews-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-news-blogs-forums-reviews-api", "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/nabeelbaghoor~news-blogs-forums-reviews-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-news-blogs-forums-reviews-api", "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/nabeelbaghoor~news-blogs-forums-reviews-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-news-blogs-forums-reviews-api", "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": { "mode": { "title": "What to search", "enum": [ "news", "blogs", "forums", "reviews" ], "type": "string", "description": "News articles are from news sites, with sentiment, categories, topics, named entities and source trust data. Blog posts and forum posts and replies share the same query language. Reviews are customer reviews of products, hotels, apps and businesses with their rating and the reviewed item.", "default": "news" }, "queries": { "title": "Search queries", "type": "array", "description": "One Boolean query per line, each read separately. A space means AND; use OR, NOT or -, parentheses, \"exact phrases\", \"words near\"~3, prefix wildcards such as crypt*, and field filters such as title:bitcoin. Quotes and parentheses must be balanced. Leave empty to search by the filters below only.", "items": { "type": "string" } }, "since": { "title": "Start date", "type": "string", "description": "Start of the search window, by crawl time: a date such as 2026-09-30, a date and time, or a relative value such as 24h or 7d. Empty searches the last 3 days. News, blogs, forums and reviews are searchable for about 31 days; older news needs news history." }, "newsHistory": { "title": "News history (older than 31 days)", "type": "boolean", "description": "News articles only. Allow a start date more than 31 days back, up to about a year. The provider bills 2 to 4 credits a request for older windows, and serves them only in crawl order.", "default": false }, "languages": { "title": "Languages", "type": "array", "description": "Only posts in these languages. All products.", "items": { "type": "string", "enum": [ "afrikaans", "albanian", "amharic", "arabic", "armenian", "azerbaijani", "basque", "belarusian", "bengali", "bulgarian", "burmese", "catalan", "cherokee", "chinese", "chineset", "croatian", "czech", "danish", "dhivehi", "dutch", "english", "estonian", "finnish", "french", "galician", "georgian", "german", "greek", "gujarati", "hebrew", "hindi", "hungarian", "icelandic", "indonesian", "inuktitut", "irish", "italian", "japanese", "kannada", "khmer", "korean", "kurdish", "laothian", "latvian", "lithuanian", "macedonian", "malay", "malayalam", "maltese", "norwegian", "oriya", "persian", "polish", "portuguese", "punjabi", "romanian", "russian", "serbian", "sinhalese", "slovak", "slovenian", "spanish", "swahili", "swedish", "syriac", "tagalog", "tamil", "telugu", "thai", "tibetan", "turkish", "ukrainian", "urdu", "vietnamese", "welsh", "yiddish" ], "enumTitles": [ "Afrikaans", "Albanian", "Amharic", "Arabic", "Armenian", "Azerbaijani", "Basque", "Belarusian", "Bengali", "Bulgarian", "Burmese", "Catalan", "Cherokee", "Chinese", "Chinese (traditional)", "Croatian", "Czech", "Danish", "Dhivehi", "Dutch", "English", "Estonian", "Finnish", "French", "Galician", "Georgian", "German", "Greek", "Gujarati", "Hebrew", "Hindi", "Hungarian", "Icelandic", "Indonesian", "Inuktitut", "Irish", "Italian", "Japanese", "Kannada", "Khmer", "Korean", "Kurdish", "Laothian", "Latvian", "Lithuanian", "Macedonian", "Malay", "Malayalam", "Maltese", "Norwegian", "Oriya", "Persian", "Polish", "Portuguese", "Punjabi", "Romanian", "Russian", "Serbian", "Sinhalese", "Slovak", "Slovenian", "Spanish", "Swahili", "Swedish", "Syriac", "Tagalog", "Tamil", "Telugu", "Thai", "Tibetan", "Turkish", "Ukrainian", "Urdu", "Vietnamese", "Welsh", "Yiddish" ] } }, "countries": { "title": "Source countries", "type": "array", "description": "Two letter country codes of the source site, such as US, GB or DE (UK is read as GB). All products; for reviews it is the reviewed site's country.", "items": { "type": "string" } }, "sites": { "title": "Sites", "type": "array", "description": "Only posts from these domains, such as reuters.com, or amazon.com and tripadvisor.com for reviews. All products.", "items": { "type": "string" } }, "excludeSites": { "title": "Exclude sites", "type": "array", "description": "Leave out posts from these domains. All products.", "items": { "type": "string" } }, "domainRankMax": { "title": "Highest domain rank", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Only sites ranked at or above this position in the Tranco top sites list (lower is more popular), such as 1000. All products." }, "authors": { "title": "Authors", "type": "array", "description": "Only posts by these authors. All products.", "items": { "type": "string" } }, "categories": { "title": "News categories", "type": "array", "description": "News articles only. The 17 IPTC based categories.", "items": { "type": "string", "enum": [ "Arts, Culture and Entertainment", "Crime, Law and Justice", "Disaster and Accident", "Economy, Business and Finance", "Education", "Environment", "Health", "Human Interest", "Labor", "Lifestyle and Leisure", "Politics", "Religion and Belief", "Science and Technology", "Social Issue", "Sport", "War, Conflict and Unrest", "Weather" ] } }, "topics": { "title": "News topics", "type": "array", "description": "News articles only. Finer IPTC topics such as election, economy, climate change, cyber crime or tennis. An unknown topic returns nothing rather than an error.", "items": { "type": "string" } }, "sentiment": { "title": "Sentiment", "enum": [ "any", "positive", "negative", "neutral" ], "type": "string", "description": "News articles only. Overall sentiment of the article.", "default": "any" }, "organizations": { "title": "Organizations mentioned", "type": "array", "description": "News articles and blog posts. Organizations the post mentions (English, German, Spanish and Italian posts).", "items": { "type": "string" } }, "people": { "title": "People mentioned", "type": "array", "description": "News articles and blog posts. People the post mentions.", "items": { "type": "string" } }, "locations": { "title": "Locations mentioned", "type": "array", "description": "News articles and blog posts. Locations the post mentions.", "items": { "type": "string" } }, "tickers": { "title": "Stock tickers", "type": "array", "description": "News articles and blog posts. Stock tickers of organizations the post mentions, such as AAPL or NVDA.", "items": { "type": "string" } }, "trustBias": { "title": "Source political bias", "enum": [ "any", "left", "center", "right" ], "type": "string", "description": "News articles only. Political bias of the source.", "default": "any" }, "trustCategory": { "title": "Source trust category", "enum": [ "any", "trusted_news", "fake_news", "satirical_news" ], "type": "string", "description": "News articles only. Trusted news, fake news or satirical news sources.", "default": "any" }, "topNews": { "title": "Curated top news sources", "type": "string", "description": "News articles only. top_news for every curated list, or one country such as top_news_us or top_news_gb." }, "breakingOnly": { "title": "Breaking news only", "type": "boolean", "description": "News articles only. Only stories flagged as breaking." }, "performanceScoreMin": { "title": "Minimum performance score", "minimum": 1, "maximum": 10, "type": "integer", "description": "News articles only. Engagement score of the article from 1 to 10." }, "forumPosts": { "title": "Forum post type", "enum": [ "any", "first", "replies" ], "type": "string", "description": "Forum posts only. Thread starters, replies, or both.", "default": "any" }, "minReplies": { "title": "Minimum replies in thread", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Forum posts only. Only threads with at least this many replies." }, "ratingMin": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Reviews only. Rating from 0 to 5, such as 4 for positive reviews." }, "ratingBelow": { "title": "Rating below", "minimum": 0, "maximum": 5, "type": "number", "description": "Reviews only. Only reviews rated below this value, such as 3 for complaints." }, "minItemReviews": { "title": "Minimum reviews per item", "minimum": 1, "maximum": 100000000, "type": "integer", "description": "Reviews only. Only items with at least this many reviews." }, "highConfidenceOnly": { "title": "High accuracy reviews only", "type": "boolean", "description": "Reviews only. Leave out reviews extracted by generic RSS or shallow crawl parsers." }, "includeSyndicated": { "title": "Include syndicated copies", "type": "boolean", "description": "News, blogs and forums. Also return syndicated copies of the same article, which are left out by default." }, "sortBy": { "title": "Sort by", "enum": [ "crawled", "relevancy", "published", "thread.published", "updated", "domain_rank", "performance_score", "replies_count", "participants_count", "ord_in_thread", "rating", "social.facebook.likes", "social.facebook.shares", "social.facebook.comments", "social.gplus.shares", "social.pinterest.shares", "social.linkedin.shares", "social.stumbledupon.shares", "social.vk.shares", "item.reviews_count", "item.reviewers_count", "item.domain_rank" ], "type": "string", "description": "Crawl time is the default and the only order that pages through everything and reaches news history. Social and performance sorts only order news meaningfully. Reviews accept crawl time, published, rating, position in thread and the item sorts.", "default": "crawled" }, "order": { "title": "Order", "enum": [ "default", "asc", "desc" ], "type": "string", "description": "Provider default is ascending for crawl time and domain rank, descending otherwise.", "default": "default" }, "highlight": { "title": "Highlight matches", "type": "boolean", "description": "Add the matched terms wrapped in em tags in highlightText and highlightTitle." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most rows this run returns and charges for, across all queries. Pages of up to 100 are read, and every page costs at least one credit on your Webz.io plan.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 120, "type": "integer", "description": "Pacing. The provider allows about one request a second per token, and the actor waits and retries when it answers 429.", "default": 50 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own Webz.io API token from the dashboard. Stored as a secret and sent only in the Authorization header; it is never logged. You can instead set the DATA_API_KEY environment secret." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }