{
  "openapi": "3.0.1",
  "info": {
    "title": "SEC Filings API — Who Mentions What in EDGAR",
    "description": "Find which public companies name a product, vendor or competitor in their SEC filings, with the sentence around each mention as proof.",
    "version": "1.0",
    "x-build-id": "5ZMuitgvdRchPIeSr"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/spool~sec-filings-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-spool-sec-filings-api",
        "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/spool~sec-filings-api/runs": {
      "post": {
        "operationId": "runs-sync-spool-sec-filings-api",
        "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/spool~sec-filings-api/run-sync": {
      "post": {
        "operationId": "run-sync-spool-sec-filings-api",
        "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": [
          "terms"
        ],
        "properties": {
          "terms": {
            "title": "1. What to look for",
            "type": "array",
            "description": "The exact phrase to find in SEC filings. Each term is searched separately.\n\n• A vendor — `Snowflake`, `Databricks`, `Salesforce`\n• A competitor — `Palantir`, `Datadog`\n• A risk or theme — `generative AI`, `supply chain disruption`, `cybersecurity incident`\n• A person or fund — `BlackRock`, `Elliott Management`\n\nEach is searched as a **phrase**, so `Palo Alto Networks` matches that name and not every filing containing the word \"networks\".",
            "items": {
              "type": "string"
            }
          },
          "forms": {
            "title": "Filing types",
            "type": "array",
            "description": "Leave empty to search every filing type. The common ones:\n\n• **10-K** — annual report, the richest source of vendor and risk mentions\n• **10-Q** — quarterly\n• **8-K** — material events, the fastest signal\n• **S-1** — IPO registration\n• **DEF 14A** — proxy statement, executive pay and governance\n• **13F-HR** — institutional holdings\n• **4** — insider transactions",
            "items": {
              "type": "string",
              "enum": [
                "10-K",
                "10-Q",
                "8-K",
                "S-1",
                "DEF 14A",
                "20-F",
                "13F-HR",
                "4",
                "SC 13D",
                "SC 13G"
              ]
            },
            "default": []
          },
          "dateFrom": {
            "title": "Filed on or after",
            "type": "string",
            "description": "`YYYY-MM-DD`. EDGAR full-text search covers filings from **2001 onward**. Narrowing the range is also how you get past the 10,000-hit paging ceiling on a very common term."
          },
          "dateTo": {
            "title": "Filed on or before",
            "type": "string",
            "description": "`YYYY-MM-DD`. Leave empty for today."
          },
          "verifyContext": {
            "title": "2. Read the filing and quote the mention",
            "type": "boolean",
            "description": "**This is the difference between a lead list and a keyword dump.** On by default.\n\nA search hit for `Snowflake` also matches Arizona Public Service and Hormel Foods — because Snowflake is a town in Arizona. With this on, the filing is fetched and the sentence around each mention is returned, so you can see whether it says *\"migrated our warehouse to Snowflake\"* or *\"our facility in Snowflake, Arizona\"*.\n\nIt costs one extra request per company, so a large scan is slower with it on.",
            "default": true
          },
          "maxSnippets": {
            "title": "Quotes per company",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many surrounding-sentence quotes to return per company. Three is usually enough to judge whether a mention is genuine.",
            "default": 3
          },
          "minMentions": {
            "title": "Minimum mentions in the filing",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "A company that names a vendor once in a 300-page annual report is different from one that names it forty times. Raise this to keep only substantive mentions. Only applies when the filing is actually read, above.",
            "default": 1
          },
          "excludeSelfMentions": {
            "title": "Exclude the company talking about itself",
            "type": "boolean",
            "description": "Searching for a vendor returns that vendor's own filings first, and they are never a sales lead. On by default.",
            "default": true
          },
          "excludePlaceNames": {
            "title": "Drop matches that look like a place name",
            "type": "boolean",
            "description": "Some product names are also towns. Searching **Snowflake** returns a paper mill in Snowflake, Arizona and a solar farm of the same name. With this on, a company is dropped when *every* quoted mention looks like a place — followed by a state, or sitting among words like mill, county or solar.\n\nOff by default, because it is a heuristic. Left off, those rows still arrive but carry `likelyPlaceName: true` and a `placeNameMentions` count, so you can filter them yourself.",
            "default": false
          },
          "relationships": {
            "title": "Only these kinds of relationship",
            "type": "array",
            "description": "Leave empty to keep every match. This is what turns a mention list into a lead list — read from the words around each mention.\n\n• **user** — the filer says it uses or runs the thing\n• **partner** — an integration or partnership\n• **competitor** — the filer names it as competition\n• **customer_of_ours** — the filer names it as one of *their* customers\n• **investor** — the filer holds it as an investment\n• **acquisition** — an acquisition or merger\n• **vendor** — named as a supplier or third-party provider\n• **mentioned** — named, but the sentence does not say how\n• **place** — a town or facility of the same name\n\nEach company gets the most specific label its quotes support.",
            "items": {
              "type": "string",
              "enum": [
                "user",
                "partner",
                "competitor",
                "customer_of_ours",
                "investor",
                "acquisition",
                "vendor",
                "mentioned",
                "place"
              ]
            },
            "default": []
          },
          "maxCompaniesPerTerm": {
            "title": "Companies per term",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Cap on companies returned for each search term, most-filings-first. Start at 50 to see the shape of the results, then raise it.",
            "default": 50
          },
          "industries": {
            "title": "Only these industries",
            "type": "array",
            "description": "Leave empty for all. Derived from the SEC's own SIC classification on each filer.",
            "items": {
              "type": "string",
              "enum": [
                "Prepackaged software",
                "Computer services",
                "Computer programming services",
                "Data processing",
                "Business services",
                "Semiconductors",
                "Pharmaceuticals",
                "Biological products",
                "Health services",
                "National commercial banks",
                "State commercial banks",
                "Security brokers",
                "Life insurance",
                "REITs",
                "Real estate",
                "Electric services",
                "Telecoms",
                "Retail trade",
                "Manufacturing",
                "Finance & insurance",
                "Services",
                "Mining"
              ]
            },
            "default": []
          },
          "states": {
            "title": "Only these states",
            "type": "array",
            "description": "Two-letter state codes of the filer's business address, e.g. `CA`, `NY`, `TX`. Leave empty for everywhere.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "userAgentContact": {
            "title": "Contact email for the SEC",
            "type": "string",
            "description": "The SEC requires every automated request to identify its sender, and blocks callers that do not. This address goes in the `User-Agent` header on requests to sec.gov and nowhere else. Put your own in — it is a condition of their access policy, not an optional courtesy.",
            "default": "medboufnouz@gmail.com"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}