{ "openapi": "3.0.1", "info": { "title": "House Stock Trades Scraper", "description": "Extract transaction-level purchases, sales, and exchanges from public U.S. House Periodic Transaction Report PDFs.", "version": "0.1", "x-build-id": "C7XDoxbct9WbiJZ6h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~house-stock-trades-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-house-stock-trades-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/automation-lab~house-stock-trades-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-house-stock-trades-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/automation-lab~house-stock-trades-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-house-stock-trades-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": { "startUrls": { "title": "PTR PDF URLs", "type": "array", "description": "Optional public House Clerk PTR PDF URLs. These are processed together with any discovery filters below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "filingYears": { "title": "Filing years", "type": "array", "description": "House member filing years to search. When no PDF URL is supplied, the current year is used by default.", "items": { "type": "integer", "minimum": 2008, "maximum": 2027 } }, "states": { "title": "States or territories", "type": "array", "description": "Optional two-letter postal codes such as CA or NY. Leave empty to search every state.", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" } }, "districts": { "title": "Districts", "type": "array", "description": "Optional district numbers or AL for at-large districts.", "items": { "type": "string" } }, "lastNames": { "title": "Member last names", "type": "array", "description": "Optional House Clerk search names such as Chu or Pelosi.", "items": { "type": "string" } }, "memberNames": { "title": "Full member name filters", "type": "array", "description": "Keep transactions whose filer name contains one of these values, case-insensitively.", "items": { "type": "string" } }, "tickers": { "title": "Ticker symbols", "type": "array", "description": "Keep only these ticker symbols, for example ASTH or NVDA.", "items": { "type": "string" } }, "transactionTypes": { "title": "Transaction types", "type": "array", "description": "Keep purchases, sales, exchanges, or any combination.", "items": { "type": "string", "enum": [ "purchase", "sale", "exchange" ], "enumTitles": [ "Purchase", "Sale", "Exchange" ] } }, "transactionDateFrom": { "title": "Transaction date from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional inclusive lower date in YYYY-MM-DD format." }, "transactionDateTo": { "title": "Transaction date to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional inclusive upper date in YYYY-MM-DD format." }, "maxFilings": { "title": "Maximum PTR filings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum unique PTR PDFs to download and inspect.", "default": 50 }, "maxItems": { "title": "Maximum transactions", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum matching transaction rows to save.", "default": 100 } } }, "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 } } } } } } } } } }