{
  "openapi": "3.0.1",
  "info": {
    "title": "SEC EDGAR Filings Scraper: 8-K Earnings, Form 4",
    "description": "Get SEC EDGAR filings with each 8-K earnings release excerpted on request, plus its guidance sentences and a sentiment score. Rows carry the form type, filed date, 8-K items, Form 4 trade lines, 10-K and 10-Q financials and document links, and full-text search covers every filing since 2001.",
    "version": "0.2",
    "x-build-id": "h1o2DtfBlpv0CfRlc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/pradio~sec-edgar-filings/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-pradio-sec-edgar-filings",
        "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/pradio~sec-edgar-filings/runs": {
      "post": {
        "operationId": "runs-sync-pradio-sec-edgar-filings",
        "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/pradio~sec-edgar-filings/run-sync": {
      "post": {
        "operationId": "run-sync-pradio-sec-edgar-filings",
        "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": "Start URLs",
            "type": "array",
            "description": "EDGAR links only: a company's EDGAR page in any of its shapes, its submissions feed (data.sec.gov/submissions/CIK0000320193.json), its Archives folder (sec.gov/Archives/edgar/data/320193), or a browse link carrying CIK=320193. Fill this or Search Queries, or both. Any other link (a company homepage, another host) is not read: it comes back as a named miss row, never billed.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "searchQueries": {
            "title": "Search Queries",
            "type": "array",
            "description": "tickers, CIKs or names to look up, such as AAPL or 320193; names resolve through the SEC's ticker file. Fill this or Start URLs, or both. A loose name can match several companies, up to Max Companies Per Search Query.",
            "items": {
              "type": "string"
            }
          },
          "query": {
            "title": "Keyword Search",
            "type": "string",
            "description": "full-text search across filing text since 2001, such as \"going concern\". Companies, Form Types and dates narrow it; empty lists filings by company. The index answers at most its first 10,000 hits."
          },
          "maxItems": {
            "title": "Maximum filings (empty = recent feed only)",
            "minimum": 1,
            "type": "integer",
            "description": "the most filing rows a run returns, across all companies. Empty reads only each company's recent feed and never its older filing files: it is not unlimited. A number reads the older files too, until the cap is met.",
            "default": 100
          },
          "maxCompaniesPerSearchQuery": {
            "title": "Max Companies Per Search Query",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "The most companies one name query may resolve to. Default 5, at most 50. A ticker or a CIK always resolves to exactly one.",
            "default": 5
          },
          "maxFilingsPerCompany": {
            "title": "Max Filings Per Company (empty = no limit)",
            "minimum": 1,
            "type": "integer",
            "description": "the most filing rows one company may return, so a large filer cannot take the whole Maximum filings cap. Leave empty for no per-company limit; a number sets it."
          },
          "formTypes": {
            "title": "Form types (comes filled with 8-K; empty it for every form)",
            "type": "array",
            "description": "the box comes filled with 8-K, so a plain run returns 8-K filings only and no 10-Ks or 10-Qs; empty it for every form filed. Entries are EDGAR form codes such as 8-K, 10-K or 10-Q; shorthand like 10K or DEF14A is corrected for you. Amendments come along (8-K also returns 8-K/A).",
            "items": {
              "type": "string"
            }
          },
          "filedFrom": {
            "title": "Filed From",
            "type": "string",
            "description": "Only filings submitted to the SEC on or after this date, in YYYY-MM-DD form. Optional."
          },
          "filedTo": {
            "title": "Filed To",
            "type": "string",
            "description": "Only filings submitted to the SEC on or before this date, in YYYY-MM-DD form. Optional."
          },
          "extractEarnings": {
            "title": "Extract Earnings Releases ($0.001 extra per release)",
            "type": "boolean",
            "description": "off by default. On, each release it reads costs $0.001 on top of its filing row: an 8-K whose cover page reports earnings results (EDGAR's Item 2.02) with a stated figure gains item codes, an excerpt, guidance sentences and a sentiment score; its text is read from the attached press release (Exhibit 99.1) when the cover page lacks it.",
            "default": false
          },
          "onlyNew": {
            "title": "Only New Since Last Run",
            "type": "boolean",
            "description": "only filings an earlier run of this same search did not return. Already-received filings are neither returned nor charged.",
            "default": false
          },
          "includeInsiderTransactions": {
            "title": "Insider Transactions (Forms 3, 4, 5)",
            "type": "boolean",
            "description": "on each Form 3, 4 or 5 row, add the named insider, their relationship and each transaction or holding line. No extra charge.",
            "default": false
          },
          "includeFinancials": {
            "title": "Include Financials (10-K, 10-Q)",
            "type": "boolean",
            "description": "on each 10-K and 10-Q row, the figures it reported (revenue to operating cash flow) via the SEC XBRL API. No extra charge.",
            "default": false
          },
          "includeDocumentText": {
            "title": "Include Document Text",
            "type": "boolean",
            "description": "add the filing's primary document as plain text in document_text, cut at Max Document Characters. Forms 3/4/5/144 and a person's filings keep it null.",
            "default": false
          },
          "maxDocumentChars": {
            "title": "Max Document Characters",
            "minimum": 1000,
            "maximum": 100000,
            "type": "integer",
            "description": "The most characters of document text one row carries when Include Document Text is on. Default 50000, at most 100000.",
            "default": 50000
          },
          "includeSections": {
            "title": "Include Item Sections",
            "type": "boolean",
            "description": "split each filing's document on Item headings into sections, 20,000 characters per item. Forms 3/4/5/144 and a person's filings keep it null.",
            "default": false
          },
          "includeMatchedPassages": {
            "title": "Include Matched Passages",
            "type": "boolean",
            "description": "Keyword Search runs add matched_passages: up to three document sentences carrying the terms. Forms 3/4/5/144 and a person's filings keep it null.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy Configuration",
            "type": "object",
            "description": "Optional Apify proxy settings. When set, every request to sec.gov goes through one proxy address for the whole run."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}