{
  "openapi": "3.0.1",
  "info": {
    "title": "SEC Filings Scraper - EDGAR Full Text Search, XBRL, 10-K, 8-K",
    "description": "EDGAR full text search stops at 10,000 hits per query; splitting the period returned 27,224 documents, 2.72x more. SEC EDGAR filings API for company filings since 1993, 8-K item codes, insider Form 4 and XBRL financial statements API. 56 fields, no API key. Official SEC filings, nothing second-hand.",
    "version": "0.1",
    "x-build-id": "md1wbLJzqzbj2wFgd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/snow_leo_data~sec-edgar-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-snow_leo_data-sec-edgar-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/snow_leo_data~sec-edgar-scraper/runs": {
      "post": {
        "operationId": "runs-sync-snow_leo_data-sec-edgar-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/snow_leo_data~sec-edgar-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-snow_leo_data-sec-edgar-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": {
          "mode": {
            "title": "What to collect",
            "enum": [
              "fullTextSearch",
              "companyFilings",
              "xbrlFacts"
            ],
            "type": "string",
            "description": "Full-text search looks inside the documents themselves (2001 to today). Company filings walks the complete submission history of a ticker or CIK (1993 to today). XBRL facts returns the numbers companies tagged in their financial statements.",
            "default": "fullTextSearch"
          },
          "query": {
            "title": "Search phrase",
            "type": "string",
            "description": "Words to find inside the filing text. Wrap in double quotes for an exact phrase: `\"material weakness\"`. Without quotes any of the words counts. Leave empty to take every filing of the chosen form types."
          },
          "companyName": {
            "title": "Company name contains",
            "type": "string",
            "description": "Narrow a full-text search to filers whose registered name contains this, for example `Apple`. Matched by SEC itself, so spelling follows the EDGAR register."
          },
          "forms": {
            "title": "Form types",
            "type": "array",
            "description": "EDGAR form names such as `8-K`, `10-K`, `10-Q`, `4`, `13F-HR`, `SC 13D`, `DEF 14A`, `D`. Amendments are included with their parent form. Empty means every form — in company mode that is the whole filing history, not just current reports.",
            "items": {
              "type": "string"
            }
          },
          "tickers": {
            "title": "Tickers",
            "type": "array",
            "description": "Stock tickers such as `AAPL`, `MSFT`. Resolved against the official SEC ticker list. Used by the company filings and XBRL modes; in full-text search use CIKs instead.",
            "items": {
              "type": "string"
            }
          },
          "ciks": {
            "title": "CIK numbers",
            "type": "array",
            "description": "SEC central index keys, with or without leading zeros: `320193` and `0000320193` both work. Use these for filers that have no ticker, such as funds and individual insiders.",
            "items": {
              "type": "string"
            }
          },
          "filedWithinDays": {
            "title": "Filed within the last N days",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Used when no explicit start date is given. The default keeps a scheduled run cheap instead of quietly pulling twenty years of archive.",
            "default": 30
          },
          "filedFrom": {
            "title": "Filed from",
            "type": "string",
            "description": "Earliest filing date, `YYYY-MM-DD`. Full-text search has no documents before 2001-01-01, so anything earlier is raised to that date."
          },
          "filedTo": {
            "title": "Filed to",
            "type": "string",
            "description": "Latest filing date, `YYYY-MM-DD`. Empty means today."
          },
          "locationCode": {
            "title": "Filer location",
            "type": "string",
            "description": "Two-letter state or country code of the filer's principal office, for example `CA` or `NY`. Full-text search only."
          },
          "includeDocumentText": {
            "title": "Include the document text",
            "type": "boolean",
            "description": "Fetch each filing document and return its text with the markup stripped, capped at 200,000 characters per document. Off by default: it costs one extra request per row and makes rows much larger.",
            "default": false
          },
          "includeHistory": {
            "title": "Include the archive",
            "type": "boolean",
            "description": "Company filings mode returns the most recent 1,000 filings by default. Switch this on to walk the archive pages back to 1993 as well — one extra request per company and, for a large issuer, over a thousand extra rows.",
            "default": false
          },
          "perCompanyLimit": {
            "title": "Rows per company",
            "minimum": 0,
            "type": "integer",
            "description": "Cap on rows taken from each ticker or CIK. Without it the first large issuer eats the whole run limit and a twenty-ticker request looks like a one-company export. Left at zero the limit is shared out evenly.",
            "default": 0
          },
          "taxonomy": {
            "title": "XBRL taxonomy",
            "type": "string",
            "description": "`us-gaap`, `ifrs-full`, `dei` or `srt`. XBRL facts mode only.",
            "default": "us-gaap"
          },
          "tag": {
            "title": "XBRL tag",
            "type": "string",
            "description": "The tagged concept, for example `Revenues`, `Assets`, `NetIncomeLoss`, `AccountsPayableCurrent`. XBRL facts mode only.",
            "default": "Revenues"
          },
          "unit": {
            "title": "XBRL unit",
            "type": "string",
            "description": "Unit of measure, usually `USD`. Use `shares` for share counts. XBRL facts mode only.",
            "default": "USD"
          },
          "period": {
            "title": "XBRL period",
            "type": "string",
            "description": "Calendar period such as `CY2025Q1` for a quarter, `CY2025Q1I` for a balance-sheet instant, `CY2024` for a year. Leave empty and give tickers instead to get one company across all periods; fill it in with no tickers to get every company that reported that period in one request."
          },
          "keywords": {
            "title": "Must mention",
            "type": "array",
            "description": "Keep only rows whose company name, form, description or XBRL label contains at least one of these. Applied before you are charged.",
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Must not mention",
            "type": "array",
            "description": "Drop rows matching any of these. Applied before you are charged.",
            "items": {
              "type": "string"
            }
          },
          "excludeForms": {
            "title": "Skip these form types",
            "type": "array",
            "description": "Form names to throw away, for example `4` to drop routine insider paperwork from a company's history.",
            "items": {
              "type": "string"
            }
          },
          "items": {
            "title": "8-K item codes",
            "type": "array",
            "description": "Keep only current reports carrying one of these item numbers, for example `1.05` for a material cybersecurity incident or `5.02` for a change of directors or officers. Every code that comes back is also returned with its official title.",
            "items": {
              "type": "string"
            }
          },
          "sicCodes": {
            "title": "SIC industry codes",
            "type": "array",
            "description": "Keep only filers in these industries, for example `7372` for prepackaged software.",
            "items": {
              "type": "string"
            }
          },
          "states": {
            "title": "States or countries",
            "type": "array",
            "description": "Two-letter codes matched against the filer's business address and state of incorporation, for example `CA`, `NY`, `DE`.",
            "items": {
              "type": "string"
            }
          },
          "minValue": {
            "title": "Minimum value",
            "type": "integer",
            "description": "XBRL facts mode: drop facts below this number."
          },
          "maxValue": {
            "title": "Maximum value",
            "type": "integer",
            "description": "XBRL facts mode: drop facts above this number."
          },
          "xbrlOnly": {
            "title": "Only filings with XBRL data",
            "type": "boolean",
            "description": "Company filings mode: keep only submissions that carry machine-readable XBRL financial data.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum rows",
            "minimum": 0,
            "type": "integer",
            "description": "Hard stop for this run. Zero means no limit of your own; the run still stops at your spending limit. With no search phrase and no limit the run is treated as a trial and stops at 300 rows.",
            "default": 0
          },
          "onlyNew": {
            "title": "Only what changed since the last run",
            "type": "boolean",
            "description": "Remembers what it already handed you in a named storage that survives between runs, and returns only new and amended rows. This is what makes a daily schedule cheap: you pay for the dozens that appeared, not the thousands that did not move.",
            "default": false
          },
          "emitUnchanged": {
            "title": "Also return unchanged rows",
            "type": "boolean",
            "description": "Incremental mode normally hides rows that have not changed. Switch this on to get them too, each tagged `NEW`, `UPDATED` or `UNCHANGED`.",
            "default": false
          },
          "compactOutput": {
            "title": "Compact rows",
            "type": "boolean",
            "description": "Keep only the identifying fields and the links. Useful when the rows are fed to an AI agent and every field costs context.",
            "default": false
          },
          "excludeEmptyFields": {
            "title": "Drop empty fields",
            "type": "boolean",
            "description": "Leave out keys that have no value instead of returning them as null.",
            "default": false
          },
          "contactEmail": {
            "title": "Your contact email",
            "type": "string",
            "description": "SEC asks every automated caller to identify itself in the User-Agent header. A working default is already set; put your own address here to identify the traffic as yours, which is what the SEC Fair Access policy prefers."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}