{
  "openapi": "3.0.1",
  "info": {
    "title": "SEC 8-K Material Event & Change Monitor",
    "description": "Find official SEC 8-K and 8-K/A material events by ticker, CIK, or whole market, classify SEC items, link amendments, and track verified accession changes.",
    "version": "0.3",
    "x-build-id": "b93W2mTXEgih7p6LI"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/luminar~sec-8k-material-event-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-luminar-sec-8k-material-event-monitor",
        "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/luminar~sec-8k-material-event-monitor/runs": {
      "post": {
        "operationId": "runs-sync-luminar-sec-8k-material-event-monitor",
        "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/luminar~sec-8k-material-event-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-luminar-sec-8k-material-event-monitor",
        "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": "Workflow",
            "enum": [
              "baseline",
              "changes"
            ],
            "type": "string",
            "description": "Baseline returns current filing rows. Changes compares the exact same scope with its previous successful state and returns NEW or source-metadata UPDATED accession events.",
            "default": "baseline"
          },
          "searchScope": {
            "title": "Search scope",
            "enum": [
              "watchlist",
              "whole_market"
            ],
            "type": "string",
            "description": "Watchlist uses official company submission history. Whole market exhausts official SEC daily master indexes for the requested date range.",
            "default": "whole_market"
          },
          "tickers": {
            "title": "Ticker symbols",
            "maxItems": 500,
            "uniqueItems": true,
            "type": "array",
            "description": "Watchlist ticker symbols resolved through the official SEC ticker/CIK directory. Tickers and CIKs are deduplicated to at most 500 issuers.",
            "items": {
              "type": "string",
              "pattern": "^[A-Za-z0-9.\\-]{1,16}$",
              "maxLength": 16
            }
          },
          "ciks": {
            "title": "SEC CIK numbers",
            "maxItems": 500,
            "uniqueItems": true,
            "type": "array",
            "description": "Watchlist CIKs. Use CIK for private/non-ticker filers or to bypass ticker resolution.",
            "items": {
              "type": "string",
              "pattern": "^[0-9]{1,10}$",
              "maxLength": 10
            }
          },
          "includeAmendments": {
            "title": "Include 8-K/A amendments",
            "type": "boolean",
            "description": "Includes 8-K/A as separate accession rows and links each amendment to an original 8-K only when official SEC history supplies a unique match.",
            "default": true
          },
          "lookbackDays": {
            "title": "Rolling discovery window",
            "minimum": 1,
            "maximum": 31,
            "type": "integer",
            "description": "Used when explicit dates are empty. Whole-market rolling scans end on the last completed calendar day because SEC daily indexes are finalized nightly; watchlists can include today. Repeat Changes runs keep this value stable; filings leaving the rolling window are never treated as ended.",
            "default": 7
          },
          "startDate": {
            "title": "Filed from",
            "type": "string",
            "description": "Optional inclusive filing start date. Set both dates for a fixed historical or repeatable same-day scope."
          },
          "endDate": {
            "title": "Filed to",
            "type": "string",
            "description": "Optional inclusive filing end date. If omitted with Filed from, the end is today."
          },
          "itemCodes": {
            "title": "SEC 8-K items",
            "maxItems": 40,
            "uniqueItems": true,
            "type": "array",
            "description": "Optional official item-code filter such as 2.02 (results), 5.02 (directors/officers), or 1.05 (material cybersecurity incidents). Every delivered code also includes its official title and deterministic event category.",
            "items": {
              "type": "string",
              "pattern": "^[1-9]\\.[0-9]{2}$",
              "maxLength": 4
            }
          },
          "categories": {
            "title": "Material-event category shortcuts",
            "maxItems": 12,
            "uniqueItems": true,
            "type": "array",
            "description": "Optional shortcuts that expand to official SEC item codes and combine with SEC 8-K items. For example, earnings maps to 2.02, cyber to 1.05, and exec_changes to 5.02.",
            "items": {
              "type": "string",
              "pattern": "^(earnings|exec_changes|ma|material_agreements|cyber|bankruptcy|delisting|impairments|accountant|control|regulation_fd|other)$",
              "maxLength": 19
            }
          },
          "companyNameContains": {
            "title": "Company name contains",
            "maxLength": 120,
            "type": "string",
            "description": "Optional case-insensitive issuer-name filter. It never substitutes for exact ticker/CIK matching in Watchlist mode."
          },
          "keywords": {
            "title": "Filing body keywords",
            "maxItems": 10,
            "uniqueItems": true,
            "type": "array",
            "description": "Optional keyword or exact-phrase matching against the official primary filing document. Adds one official SEC source request per candidate filing and more runtime. The filing price is unchanged; unmatched filings are not delivered or charged.",
            "items": {
              "type": "string",
              "minLength": 2,
              "maxLength": 100
            }
          },
          "keywordMode": {
            "title": "Keyword matching",
            "enum": [
              "any",
              "all"
            ],
            "type": "string",
            "description": "Used only when Filing body keywords are supplied.",
            "default": "any"
          },
          "maxFilingsPerCompany": {
            "title": "Maximum filings per company",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Watchlist-only newest-first cap for each issuer. If otherwise matching history remains, coverage is CAPPED.",
            "default": 100
          },
          "maxFilings": {
            "title": "Maximum filings",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Global unique filing limit. Reaching it while more qualifying official rows exist reports CAPPED rather than complete coverage.",
            "default": 25
          },
          "maxTrackedItems": {
            "title": "Maximum tracked accessions",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Changes-only state limit. It must be at least Maximum filings. Up to 20,000 complete accession snapshots are committed in bounded atomic generations; rows that cannot fit are never delivered as paid changes.",
            "default": 1000
          },
          "includeUnchanged": {
            "title": "Include unchanged audit rows",
            "type": "boolean",
            "description": "Changes-only. It adds no source call or source runtime, but adds Dataset delivery work for free UNCHANGED audit rows. These rows are included without a paid change charge.",
            "default": false
          },
          "watchlistName": {
            "title": "Monitoring scope name",
            "maxLength": 64,
            "type": "string",
            "description": "Optional stable label that isolates Changes state for otherwise identical inputs."
          },
          "maxBuyerChargeUsd": {
            "title": "Maximum Actor charge",
            "minimum": 0.001,
            "maximum": 100,
            "type": "number",
            "description": "Stops before source work if the requested limits could exceed this Actor charge. Your Apify account may apply an additional Maximum cost per run.",
            "default": 1
          },
          "maxRequests": {
            "title": "Maximum official SEC requests",
            "minimum": 1,
            "maximum": 2500,
            "type": "integer",
            "description": "Run-wide infrastructure safety limit for official SEC/EDGAR requests and bounded retries.",
            "default": 1200
          },
          "maxSourceBytes": {
            "title": "Maximum official source bytes",
            "minimum": 100000,
            "maximum": 200000000,
            "type": "integer",
            "description": "Run-wide official-source transfer limit.",
            "default": 50000000
          },
          "maxRuntimeSecs": {
            "title": "Maximum source-work runtime",
            "minimum": 30,
            "maximum": 900,
            "type": "integer",
            "description": "Run-wide source-work runtime limit.",
            "default": 600
          },
          "_luminarQaFaultStage": {
            "title": "Private QA fault stage",
            "type": "string",
            "description": "Internal fault-injection control accepted only by the registered private QA Actor on this exact immutable build. Buyer and positive workload inputs omit this field."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}