{
  "openapi": "3.0.1",
  "info": {
    "title": "SEC EDGAR 8-K Material Event Alerts: Item Decoder",
    "description": "New SEC EDGAR 8-K filings as an alert feed: every item decoded into plain English and ranked high, medium or low, with a severity filter and new-only monitor mode. Bankruptcy, cyber, restatement, delisting alerts. Also 10-K, IPO, full-text search.",
    "version": "0.2",
    "x-build-id": "XqvZ8O5GQW8WXqr7H"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/transparent_meteorite~sec-edgar-filings-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-transparent_meteorite-sec-edgar-filings-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/transparent_meteorite~sec-edgar-filings-monitor/runs": {
      "post": {
        "operationId": "runs-sync-transparent_meteorite-sec-edgar-filings-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/transparent_meteorite~sec-edgar-filings-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-transparent_meteorite-sec-edgar-filings-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",
        "required": [
          "formTypes"
        ],
        "properties": {
          "formTypes": {
            "title": "Form types",
            "type": "array",
            "description": "SEC forms to return, one per line. Examples: 8-K, 10-K, 10-Q, S-1, F-1, 424B* (all final prospectuses), 13D, 13G, 6-K, 20-F, DEF 14A, S-4, 425, SC TO-T, NT 10-K. Shortcuts: IPO (S-1, F-1, S-11, 424B4), proxy, M&A, tender offer, delisting, late filing, any (every company form). Amendments (/A) are included automatically. Insider Forms 3, 4, 5 and 144 are not available because they name individual people.",
            "default": [
              "8-K"
            ],
            "items": {
              "type": "string"
            }
          },
          "eightKItems": {
            "title": "8-K items (events)",
            "type": "array",
            "description": "Only 8-K filings that report at least one of these items. Use codes or event names: 1.01 material agreement, 1.03 bankruptcy, 1.05 cybersecurity incident, 2.01 acquisition completed, 2.02 earnings, 2.05 restructuring/layoffs, 3.01 delisting notice, 4.01 auditor change, 4.02 restatement, 5.01 change in control, 5.02 executive change, 5.07 shareholder vote, 7.01 Reg FD, 8.01 other events. Setting this limits the run to Form 8-K.",
            "items": {
              "type": "string"
            }
          },
          "minSeverity": {
            "title": "Minimum event severity",
            "enum": [
              "any",
              "low",
              "medium",
              "high"
            ],
            "type": "string",
            "description": "Return only 8-K filings whose most serious item is at least this tier. Combine with 'Only new filings since last run' for a material-event alert feed. Any value other than 'any' limits the run to Form 8-K.",
            "default": "any"
          },
          "tickers": {
            "title": "Tickers",
            "type": "array",
            "description": "Only filings by these companies, by exchange ticker (AAPL, MSFT, BRK-B). Resolved to CIK with the official SEC ticker file. Leave empty for the whole market.",
            "items": {
              "type": "string"
            }
          },
          "ciks": {
            "title": "CIK numbers",
            "type": "array",
            "description": "Only filings by these companies, by SEC Central Index Key (with or without leading zeros, e.g. 320193). Works for private and pre-IPO companies that have no ticker.",
            "items": {
              "type": "string"
            }
          },
          "fullTextQuery": {
            "title": "Full-text phrase",
            "type": "string",
            "description": "Optional. Search inside the filing text and exhibits with EDGAR full-text search, for example \"going concern\", \"material weakness\" or \"artificial intelligence\". Put a phrase in double quotes for an exact match. Results are ordered by relevance and include the matched document."
          },
          "filedWithinDays": {
            "title": "Filed within the last (days)",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Look-back window counted back from today (or from the 'Filed to' date). Default 7 days.",
            "default": 7
          },
          "filedFrom": {
            "title": "Filed from (optional)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Exact start date (YYYY-MM-DD). Overrides the look-back when set. EDGAR full-text search covers 2001 onward."
          },
          "filedTo": {
            "title": "Filed to (optional)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Exact end date (YYYY-MM-DD). Default today."
          },
          "includeAmendments": {
            "title": "Include amendments (/A)",
            "type": "boolean",
            "description": "Keep amended filings such as 8-K/A and 10-K/A. Turn off to get original filings only.",
            "default": true
          },
          "onlyNewSinceLastRun": {
            "title": "Only new since last run (monitor mode)",
            "type": "boolean",
            "description": "Remember every accession number delivered and skip it in later runs, so a scheduled run returns (and charges) only filings you have not received yet. Uses a named key-value store in your account.",
            "default": false
          },
          "stateStoreName": {
            "title": "Monitor state store name",
            "type": "string",
            "description": "Name of the key-value store that keeps the delivered accession numbers. Use a different name per schedule to keep separate watch lists.",
            "default": "sec-edgar-filings-monitor-seen"
          },
          "maxItems": {
            "title": "Max filings",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop after this many filings. Newest first (or most relevant first with a full-text phrase). You pay only for filings delivered.",
            "default": 100
          },
          "maxApiRequests": {
            "title": "Max SEC requests",
            "minimum": 5,
            "maximum": 2000,
            "type": "integer",
            "description": "Safety cap on requests to SEC per run (each search page holds 100 filings). Raise it for large backfills.",
            "default": 200
          },
          "maxRunSeconds": {
            "title": "Max run time (seconds)",
            "minimum": 30,
            "maximum": 3600,
            "type": "integer",
            "description": "The run ends cleanly with the filings found so far when this time is reached.",
            "default": 300
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}