{
  "openapi": "3.0.1",
  "info": {
    "title": "Litigation Signals API — Lawsuits, Settlements & Investigations",
    "description": "Who is being sued, settling or investigated: one row per legal matter per public company, from SEC 10-K, 10-Q and 8-K disclosures, press wires and SEC, FTC, CFPB and DOJ notices, with type, status, court, case number and amount. Individuals redacted. No key.",
    "version": "0.1",
    "x-build-id": "xnRNewGbZaG2usbcj"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/insight.solutions~litigation-signals-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-insight.solutions-litigation-signals-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/insight.solutions~litigation-signals-api/runs": {
      "post": {
        "operationId": "runs-sync-insight.solutions-litigation-signals-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/insight.solutions~litigation-signals-api/run-sync": {
      "post": {
        "operationId": "run-sync-insight.solutions-litigation-signals-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",
        "properties": {
          "mode": {
            "title": "What to look for",
            "enum": [
              "companies",
              "market"
            ],
            "type": "string",
            "description": "**companies** reads the companies in the list below: their latest 10-K and 10-Qs, their litigation 8-Ks, press-wire releases and regulator notices that name them. **market** needs no list: it runs EDGAR full-text searches over recent filings (see *Market mode*) and reads the press wires and regulator feeds for new litigation of any company.",
            "default": "companies"
          },
          "companies": {
            "title": "Companies",
            "type": "array",
            "description": "Public companies, one per line: a name (`Tesla`, `Johnson & Johnson`), a ticker (`TSLA`) or an SEC CIK (`1318605`). A name or ticker is resolved through SEC's own ticker file; one that SEC does not list (a private company) is still searched on the press wires and in regulator notices by the name as typed. A company listed twice — by name and by ticker — is read once.",
            "items": {
              "type": "string"
            }
          },
          "months": {
            "title": "Look back (months)",
            "minimum": 1,
            "maximum": 36,
            "type": "integer",
            "description": "How far back 8-Ks, press releases and regulator notices are read, and what counts as `new` in a 10-K or 10-Q (a matter first filed inside this window). 1–36.",
            "default": 12
          },
          "filingsPerCompany": {
            "title": "Periodic filings per company",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "How many periodic reports are read per company: the latest 10-K, plus the newest 10-Qs filed after it, up to this many in all (newest first). The same matter in a 10-K and its 10-Qs is one signal, carrying the newest text and every filing it appears in.",
            "default": 2
          },
          "includeFilings": {
            "title": "Read SEC filings",
            "type": "boolean",
            "description": "10-K Item 3 and 10-Q Part II Item 1 (Legal Proceedings) with the litigation note they point to, and 8-Ks found by EDGAR full-text search. Direct from sec.gov, never through a proxy.",
            "default": true
          },
          "includePressReleases": {
            "title": "Read press wires",
            "type": "boolean",
            "description": "GlobeNewswire and PR Newswire keyword search — `<company> class action`, `<company> lawsuit`, `<company> settlement` — keeping releases whose headline or teaser names the company and is about litigation, including plaintiffs' firms announcing class actions on behalf of a company's investors. Only the listing is read, never the release body.",
            "default": true
          },
          "includeRegulators": {
            "title": "Read regulator notices",
            "type": "boolean",
            "description": "The SEC's, the FTC's and the CFPB's press-release feeds and the Department of Justice's press-release API (paged back through the look-back window, at most 10 pages of 50), filtered to notices that name your companies (market mode: every notice whose headline is enforcement, in the window). Notices about an individual — a person charged, sentenced or pleading — are never returned.",
            "default": true
          },
          "types": {
            "title": "Only these signal types",
            "type": "array",
            "description": "Optional filter: return only signals carrying at least one of these types. Documents are still read and returned, so coverage stays visible. Leave empty for every type.",
            "items": {
              "type": "string",
              "enum": [
                "lawsuit",
                "class-action",
                "securities",
                "settlement",
                "judgment",
                "dismissal",
                "appeal",
                "investigation",
                "regulatory",
                "antitrust",
                "patent",
                "employment",
                "product-liability",
                "environmental",
                "arbitration",
                "bankruptcy"
              ]
            },
            "default": []
          },
          "queries": {
            "title": "Market mode: full-text queries",
            "type": "array",
            "description": "EDGAR full-text search phrases for market mode, one per line, in EDGAR's syntax (quotes for a phrase, `OR` between alternatives). Empty: `\"class action\" OR \"settlement agreement\" OR \"legal proceedings\"`.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "forms": {
            "title": "Market mode: forms",
            "type": "array",
            "description": "Which filings market mode searches: `8-K`, `10-Q`, `10-K`.",
            "items": {
              "type": "string",
              "enum": [
                "8-K",
                "10-Q",
                "10-K"
              ]
            },
            "default": [
              "8-K",
              "10-Q",
              "10-K"
            ]
          },
          "maxFilings": {
            "title": "Market mode: maximum documents",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "How many SEC documents market mode reads, at most (each read document is one `document` row). 1–500.",
            "default": 50
          },
          "marketDays": {
            "title": "Market mode: days back",
            "minimum": 1,
            "maximum": 90,
            "type": "integer",
            "description": "Market mode's window, in days, for full-text search, press releases and regulator notices. 1–90.",
            "default": 7
          },
          "userAgentContact": {
            "title": "SEC User-Agent contact (required)",
            "type": "string",
            "description": "Your organisation and a working contact address, e.g. 'Acme Research data@acme.com'. The SEC requires every automated request to declare who is making it and how to reach them (sec.gov/os/accessing-edgar-data), and answers HTTP 403 without it. The pre-filled value is the publisher's own contact so the example run works out of the box; please replace it with yours for real use, so the SEC reaches you, not us, about your traffic. An empty value is not replaced by a shared identity: the run stops and says so."
          },
          "maxConcurrency": {
            "title": "Companies in parallel",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "How many companies are read at once. Every SEC request in the run shares one limit of 8 per second whatever this is set to.",
            "default": 2
          },
          "maxRunSecs": {
            "title": "Maximum run time (seconds)",
            "minimum": 30,
            "maximum": 3600,
            "type": "integer",
            "description": "Wall-clock budget for the whole run. When it is reached the Actor stops reading, keeps — and bills — every row it already wrote, and files a free `timeout` row for what it never reached.",
            "default": 240
          },
          "proxyConfiguration": {
            "title": "Proxy configuration (press wires only)",
            "type": "object",
            "description": "Used for the GlobeNewswire and PR Newswire searches only. SEC and the regulator feeds are always read directly, never through a proxy: SEC counts requests per requester, and a shared exit is the worst address to be counted against.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}