{
  "openapi": "3.0.1",
  "info": {
    "title": "SEC EDGAR Filings & Financials: 10-K, 8-K, Form D",
    "description": "Unofficial SEC EDGAR scraper on SEC's official data APIs: filings by ticker/CIK/name (10-K, 10-Q, 8-K items, S-1, 13F), Form D funding by date range, and flattened XBRL financials (revenue, net income, EPS, cash flow). No login. Not affiliated with the SEC.",
    "version": "0.3",
    "x-build-id": "MsO5kKnPJBxG5donf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kyungminlee~sec-edgar-filings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kyungminlee-sec-edgar-filings-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/kyungminlee~sec-edgar-filings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-kyungminlee-sec-edgar-filings-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/kyungminlee~sec-edgar-filings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-kyungminlee-sec-edgar-filings-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": {
          "companies": {
            "title": "Companies (tickers, CIKs or names)",
            "type": "array",
            "description": "Stock tickers (`AAPL`, `BRK-B`), SEC CIK numbers (`320193` or `0000320193`) or company names (`Tesla`, matched against the registered name in SEC's ticker list). Use a CIK for delisted or private companies (for example Form D issuers). Required unless you only use the financial screener below; market-wide filing feeds are not supported.",
            "items": {
              "type": "string"
            }
          },
          "maxCompaniesPerName": {
            "title": "Companies per name",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "When an entry is a company name rather than a ticker or CIK, how many matching companies to include, best match first. Tickers and CIKs always give exactly one company.",
            "default": 1
          },
          "formTypes": {
            "title": "Form types",
            "type": "array",
            "description": "EDGAR form types to return, for example `10-K` (annual report), `10-Q` (quarterly), `8-K` (current report), `S-1`, `424B4`, `DEF 14A` (proxy), `13F-HR`, `D` (Form D private funding), `SC 13D`. Aliases: `13F`, `Form D`, `proxy`. Insider forms 3, 4 and 5 are not offered. Pass an empty list together with Include financials to get financials only. If the field is omitted entirely, `10-K` and `10-Q` are used.",
            "default": [
              "10-K",
              "10-Q"
            ],
            "items": {
              "type": "string"
            }
          },
          "includeAmendments": {
            "title": "Include amendments",
            "type": "boolean",
            "description": "Also return amended versions of the chosen forms (for example `10-K/A` when you chose `10-K`).",
            "default": false
          },
          "items8K": {
            "title": "8-K item codes",
            "type": "array",
            "description": "Optional filter for 8-K filings: only keep 8-Ks that report at least one of these item codes, for example `2.02` (earnings results), `1.01` (material agreement), `5.02` (officer/director changes), `1.05` (cybersecurity incident), `2.01` (acquisition completed). Other form types are not affected. Every 8-K row lists its item codes with titles.",
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "Date from",
            "type": "string",
            "description": "Earliest filing date: `YYYY-MM-DD` or relative like `3 years` or `30 days` (= that long ago)."
          },
          "dateTo": {
            "title": "Date to",
            "type": "string",
            "description": "Latest filing date: `YYYY-MM-DD` or relative like `7 days`. Empty means today."
          },
          "maxFilingsPerCompany": {
            "title": "Max filings per company",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Newest filings first. Caps how many filings are returned (and charged) for each company.",
            "default": 20
          },
          "maxFilings": {
            "title": "Max filings in total",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Hard cap on filings returned (and charged) in this run across all companies.",
            "default": 100
          },
          "onlyNewFilings": {
            "title": "Only new filings (watchlist)",
            "type": "boolean",
            "description": "Remember which filings were already delivered (accession numbers per company, kept in a named key-value store) and output and charge only filings not seen before; rows get `isNew: true`. The first run returns everything inside the date window and records it. Schedule the Actor daily with your companies as a watchlist. Unchanged filings are neither output nor charged.",
            "default": false
          },
          "stateStoreName": {
            "title": "Watchlist state store name",
            "type": "string",
            "description": "Name of the key-value store that remembers seen filings when Only new filings is on (letters, digits and hyphens). Use a different name per watchlist. Delete the store to start over.",
            "default": "sec-edgar-watchlist"
          },
          "includeFinancials": {
            "title": "Include financials (XBRL)",
            "type": "boolean",
            "description": "Add one row per fiscal period with revenue, cost of revenue, gross profit, R&D, operating income, net income, EPS (basic/diluted), diluted shares, operating cash flow, capex, free cash flow, assets, cash, liabilities, long-term debt and equity, taken from SEC's XBRL company facts. Needs companies. Works for US-GAAP filers (10-K/10-Q); foreign (IFRS) filers, funds and private issuers usually have none. Charged once per company, not per period.",
            "default": false
          },
          "financialsPeriod": {
            "title": "Financial periods",
            "enum": [
              "annual",
              "quarterly",
              "both"
            ],
            "type": "string",
            "description": "`annual` = fiscal years from 10-Ks, `quarterly` = single quarters from 10-Qs (cash-flow items are derived from the year-to-date figures; the fourth quarter is not reported separately by companies, use annual), `both` = all.",
            "default": "annual"
          },
          "financialsYears": {
            "title": "Financial history (years)",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "How many years back the financial periods go.",
            "default": 5
          },
          "screenerConcept": {
            "title": "Screener: metric (XBRL concept)",
            "enum": [
              "Revenues",
              "RevenueFromContractWithCustomerExcludingAssessedTax",
              "NetIncomeLoss",
              "OperatingIncomeLoss",
              "GrossProfit",
              "ResearchAndDevelopmentExpense",
              "NetCashProvidedByUsedInOperatingActivities",
              "EarningsPerShareBasic",
              "EarningsPerShareDiluted",
              "Assets",
              "Liabilities",
              "StockholdersEquity",
              "CashAndCashEquivalentsAtCarryingValue",
              "LongTermDebt"
            ],
            "type": "string",
            "description": "Screener (market-wide, no companies needed): the US-GAAP metric to rank all SEC filers by. Many companies report revenue under `RevenueFromContractWithCustomerExcludingAssessedTax` rather than `Revenues`; run both if needed. Leave empty to not use the screener."
          },
          "screenerPeriod": {
            "title": "Screener: period",
            "type": "string",
            "description": "Period in SEC frames notation: `CY2025Q2` (calendar quarter) or `CY2024` (calendar year). Companies are assigned to the calendar period that best fits their fiscal period. Required when a metric is chosen."
          },
          "screenerCompareToPeriod": {
            "title": "Screener: compare to period",
            "type": "string",
            "description": "Optional second period (for example `CY2024Q2` to compare with `CY2025Q2`) used to compute growth percent per company."
          },
          "screenerMinValue": {
            "title": "Screener: minimum value",
            "type": "number",
            "description": "Keep only companies whose value is at least this (USD, or USD per share for EPS). Example: 1000000000 for $1B."
          },
          "screenerMaxValue": {
            "title": "Screener: maximum value",
            "type": "number",
            "description": "Keep only companies whose value is at most this (USD, or USD per share for EPS)."
          },
          "screenerMinGrowthPct": {
            "title": "Screener: minimum growth %",
            "type": "number",
            "description": "Keep only companies whose growth versus the comparison period is at least this percent. Needs Compare to period. Companies without a comparison value are dropped."
          },
          "screenerSortBy": {
            "title": "Screener: sort by",
            "enum": [
              "valueDesc",
              "valueAsc",
              "growthDesc",
              "growthAsc",
              "name"
            ],
            "type": "string",
            "description": "Order of the screener rows before the company cap is applied. Default: valueDesc."
          },
          "screenerMaxCompanies": {
            "title": "Screener: max companies",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum screener rows returned (and charged) after filtering and sorting. Default: 100."
          },
          "screener": {
            "title": "Screener (JSON alternative)",
            "type": "object",
            "description": "Optional JSON form of the screener, for API users: `{\"concept\":\"Revenues\",\"period\":\"CY2025Q2\",\"compareToPeriod\":\"CY2024Q2\",\"minValue\":1000000000,\"minGrowthPct\":20,\"sortBy\":\"growthDesc\",\"maxCompanies\":50}`. Values here override the separate screener fields."
          },
          "contactEmail": {
            "title": "Your contact email (recommended)",
            "type": "string",
            "description": "SEC's fair-access policy requires automated tools to identify themselves with a company or app name and a contact email in the User-Agent header. Enter your own email and it is sent to SEC in that header (nowhere else, and not stored in the results). If left empty, a generic identifier pointing to the Actor author's Apify profile is used."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}