{ "openapi": "3.0.1", "info": { "title": "Tadawul Disclosure Monitor — Saudi Exchange", "description": "Saudi Tadawul Disclosure Monitor is an Apify Actor that collects company announcements from the Saudi Exchange (Tadawul) and returns them as structured data.\n\nIt supports filtering announcements by company name, ticker, start date, end date, and maximum results.", "version": "0.0", "x-build-id": "ZHG9VKhiQVo2DpKkf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/generous_heavens~tadawul-disclosure-monitor-saudi-exchange/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-generous_heavens-tadawul-disclosure-monitor-saudi-exchange", "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/generous_heavens~tadawul-disclosure-monitor-saudi-exchange/runs": { "post": { "operationId": "runs-sync-generous_heavens-tadawul-disclosure-monitor-saudi-exchange", "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/generous_heavens~tadawul-disclosure-monitor-saudi-exchange/run-sync": { "post": { "operationId": "run-sync-generous_heavens-tadawul-disclosure-monitor-saudi-exchange", "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": { "country": { "title": "Country", "enum": [ "Saudi Arabia" ], "type": "string", "description": "Which country's exchange to monitor. Leave on \"Both\" to run every supported market in one go.", "default": "Saudi Arabia" }, "market": { "title": "Market", "enum": [ "Tadawul" ], "type": "string", "description": "Which exchange to monitor. This must match the selected country (Egypt → EGX, Saudi Arabia → Tadawul). Leave on \"Both\" to run every supported market.", "default": "Tadawul" }, "company": { "title": "Company name (optional)", "type": "string", "description": "Filter disclosures by company name, e.g. \"Telecom Egypt\" or \"Saudi Aramco\". Leave empty to collect disclosures from all companies.", "default": "" }, "ticker": { "title": "Ticker / symbol (optional)", "type": "string", "description": "Filter disclosures by ticker or symbol code, e.g. \"ETEL\" (EGX) or \"2222\" (Tadawul). Leave empty to collect disclosures for all tickers.", "default": "" }, "date": { "title": "Date (optional)", "type": "string", "description": "Only collect disclosures published on or after this date. Format: DD-MM-YYYY. Leave empty for no lower bound.", "default": "" }, "maxResults": { "title": "Max results per market", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of disclosures to return per market in this run.", "default": 100 }, "onlyNew": { "title": "Only new disclosures", "type": "boolean", "description": "If ON, the Actor remembers disclosures it has already seen (per market, in the Actor's key-value store) and only returns ones it hasn't seen before — ideal for daily scheduled monitoring. If OFF, it returns everything found in the given date range, including duplicates from earlier runs.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy settings. Using Apify Proxy (residential, if available) can help avoid being blocked by the exchanges' anti-bot protection.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }