{ "openapi": "3.0.1", "info": { "title": "Simply Wall Street Scraper", "description": "Collect public Simply Wall St company reports, security matches, investment narratives, and contributor profiles. Look up stocks by ticker or ISIN, or pull contributor profiles by handle. No Simply Wall St member login is needed.", "version": "0.0", "x-build-id": "WBQ82LyPDikNwoqGN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~simply-wall-street/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-simply-wall-street", "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/maximedupre~simply-wall-street/runs": { "post": { "operationId": "runs-sync-maximedupre-simply-wall-street", "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/maximedupre~simply-wall-street/run-sync": { "post": { "operationId": "run-sync-maximedupre-simply-wall-street", "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": [ "resultType" ], "properties": { "resultType": { "title": "Result type", "enum": [ "companyReports", "securityMatches", "investmentNarratives", "contributorProfiles" ], "type": "string", "description": "Choose the kind of data to collect. Fields for other result types are ignored." }, "companyDiscovery": { "title": "Find company reports by", "enum": [ "companyUrls", "companySearchTerms" ], "type": "string", "description": "Choose how to find company reports. Fill the list that matches your choice. The other list is ignored.", "default": "companyUrls" }, "companyUrls": { "title": "Company report URLs", "type": "array", "description": "Add Simply Wall Street company report URLs. Used only when Find company reports by is Company report URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "companySearchTerms": { "title": "Company search words", "type": "array", "description": "Add tickers or company search words, one per line. Used only when Find company reports by is Company search words.", "items": { "type": "string" } }, "companyMatch": { "title": "Company search match", "enum": [ "exactTicker", "relatedCompanies" ], "type": "string", "description": "Exact ticker finds the stock with the ticker you enter. If several companies share a ticker, such as SAP, the first match in the search results is used. Add the exchange code before the ticker, such as XTRA:SAP, to pick one listing. Related company suggestions finds companies linked to your search words. Applies only when Find company reports by is Company search words.", "default": "exactTicker" }, "identifiers": { "title": "Security identifiers", "type": "array", "description": "For security matches, add tickers, exchange-qualified tickers such as NASDAQ:AAPL, or ISINs, one per line. If several companies share a ticker, such as SAP, the first match in the search results is used. Add the exchange code before the ticker, such as XTRA:SAP, to pick one listing.", "items": { "type": "string" } }, "narrativeDiscovery": { "title": "Find investment narratives by", "enum": [ "stockTickers", "countryMarkets", "handles" ], "type": "string", "description": "Choose how to find investment narratives. Fill the list that matches your choice. Other lists are ignored.", "default": "stockTickers" }, "stockTickers": { "title": "Stock tickers", "type": "array", "description": "Find investment narratives for these stocks. Add one ticker per line. If several companies share a ticker, such as SAP, the first match in the search results is used. Add the exchange code before the ticker, such as XTRA:SAP, to pick one listing. Used only when Find investment narratives by is Stock tickers.", "items": { "type": "string" } }, "countryMarkets": { "title": "Country markets", "type": "array", "description": "Find investment narratives in these markets. Add two-letter country codes, such as US or GB, one per line. Used only when Find investment narratives by is Country markets.", "items": { "type": "string" } }, "narrativeOrder": { "title": "Market narrative order", "enum": [ "popularity", "undervaluation", "overvaluation" ], "type": "string", "description": "Choose how the source orders the narratives found by country markets. Applies only when Find investment narratives by is Country markets.", "default": "popularity" }, "contributorDiscovery": { "title": "Find contributor profiles by", "enum": [ "handles", "topAuthors" ], "type": "string", "description": "Choose how to find contributor profiles. Contributor handles finds the profiles you list. Top-author leaderboard collects the community's top authors and ignores handles.", "default": "handles" }, "contributorHandles": { "title": "Contributor handles", "type": "array", "description": "Add Simply Wall Street contributor handles, one per line. A handle is the public ID after /community/users/ in a contributor's profile address, such as susy37pq in simplywall.st/community/users/susy37pq. The display name shown on the profile does not work. Used when Find investment narratives by is Contributor handles, and when Find contributor profiles by is Contributor handles.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Stop after this many results across the run. Leave empty to collect all available results for the selected inputs until the source runs out of results. Related company suggestions are the exception. They return at most 1,000 matches for each search word, so a broad word such as Apple gives at most 1,000 suggestions, even when this field is empty." } } }, "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 } } } } } } } } } }