{
  "openapi": "3.0.1",
  "info": {
    "title": "US Federal Court Corporate Parties & Law Firm Finder",
    "description": "Find corporate parties in GovInfo federal opinions. Firm matching supports unambiguous singular captions in the Federal and Sixth Circuits, with a legal-form marker or explicit law-firm wording. Export case metadata and source evidence at $0.006 per case, including cases without firm matches.",
    "version": "0.2",
    "x-build-id": "kp9nSMXyfYJo7hfNw"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/afkdigital~newapi09-federal-litigation-firm-finder/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-afkdigital-newapi09-federal-litigation-firm-finder",
        "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/afkdigital~newapi09-federal-litigation-firm-finder/runs": {
      "post": {
        "operationId": "runs-sync-afkdigital-newapi09-federal-litigation-firm-finder",
        "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/afkdigital~newapi09-federal-litigation-firm-finder/run-sync": {
      "post": {
        "operationId": "run-sync-afkdigital-newapi09-federal-litigation-firm-finder",
        "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": {
          "sourceMode": {
            "title": "Discovery mode",
            "enum": [
              "sitemap",
              "packages"
            ],
            "type": "string",
            "description": "Use sitemap to discover case packages in the selected court and publication-year partitions. Use packages to inspect explicit GovInfo case-package IDs. All output must still match the opinion-date, court (when supplied), and Nature of Suit filters.",
            "default": "sitemap"
          },
          "court": {
            "title": "GovInfo court code",
            "pattern": "^([A-Za-z][A-Za-z0-9]{1,31})?$",
            "type": "string",
            "description": "GovInfo federal court code, such as ca13 for the Federal Circuit. Required and nonblank in sitemap mode. In packages mode, an empty string permits any supported federal court; a supplied code is checked against source metadata. Automatic firm extraction supports only recognized Federal and Sixth Circuit singular-caption layouts; other courts return corporate-case metadata with empty firm arrays.",
            "default": "ca13"
          },
          "nature_of_suit": {
            "title": "Nature of Suit code",
            "pattern": "^([0-9]{3})?$",
            "type": "string",
            "description": "Three-digit federal Nature of Suit code; 830 is Patent. An empty string accepts any Nature of Suit. The Actor checks GovInfo metadata and its code-to-label mapping; it does not submit numeric codes as GovInfo text-search queries.",
            "default": "830"
          },
          "sitemapYears": {
            "title": "Publication-year sitemap partitions",
            "minItems": 1,
            "maxItems": 3,
            "uniqueItems": true,
            "type": "array",
            "description": "One to three integer years to discover in sitemap mode. These are GovInfo publication-year partitions, not case filing years. Matching opinion dates are checked again in package metadata. Not used to discover packages in packages mode.",
            "items": {
              "type": "integer"
            },
            "default": [
              2024
            ]
          },
          "opinion_date_from": {
            "title": "Opinion date on or after",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$",
            "type": "string",
            "description": "Inclusive beginning of the opinion-date range in YYYY-MM-DD format. This is an opinion date, not a docket filing date. Must be a real calendar date no later than opinion_date_to.",
            "default": "2024-01-01"
          },
          "opinion_date_to": {
            "title": "Opinion date on or before",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$",
            "type": "string",
            "description": "Inclusive end of the opinion-date range in YYYY-MM-DD format. Only matching opinions are eligible for bounded inspection within each case package. Must be no earlier than opinion_date_from.",
            "default": "2024-01-31"
          },
          "packageIds": {
            "title": "GovInfo case-package IDs",
            "type": "array",
            "description": "Required and nonempty when sourceMode is packages. Supply case IDs such as USCOURTS-ca13-23-01048, not individual opinion IDs, PDF URLs, or CourtListener docket IDs. Duplicate case IDs do not create extra result rows.",
            "items": {
              "type": "string",
              "pattern": "^USCOURTS-[A-Za-z0-9]+-[0-9][A-Za-z0-9_-]{1,100}$"
            },
            "default": []
          },
          "maxResults": {
            "title": "Maximum unique case packages",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum dataset rows for this run. One row represents one unique GovInfo case package and aggregates the bounded matching opinions inspected for it. Valid corporate-case records count and are billed even if their firm arrays are empty. Source coverage and the other budgets can yield fewer results.",
            "default": 3
          },
          "maxCostUsd": {
            "title": "Result-charge ceiling (USD)",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Application ceiling at $0.006 per unique case package. Zero allows no output rows. Apify also has a separate maximum run charge; the lower applicable budget limits results. Three rows cost at most $0.018 in result events.",
            "default": 0.018
          },
          "maxSourceRequests": {
            "title": "Maximum source requests",
            "minimum": 1,
            "maximum": 3000,
            "type": "integer",
            "description": "Maximum GovInfo requests, including discovery, metadata, document downloads, and retries. A case may require several requests. Reaching this limit can leave discovery or opinion inspection incomplete.",
            "default": 60
          },
          "maxRunSeconds": {
            "title": "Maximum processing time",
            "minimum": 30,
            "maximum": 3600,
            "type": "integer",
            "description": "Same-run wall-clock deadline in seconds, including downloads, PDF processing, retries and interruption time. Resuming the same run does not reset this deadline. Partial progress is saved when a limit is reached.",
            "default": 240
          },
          "requestIntervalSeconds": {
            "title": "Minimum source request interval",
            "minimum": 1,
            "maximum": 60,
            "type": "number",
            "description": "Minimum spacing between requests to GovInfo. Any longer server-requested Retry-After delay takes precedence. The default is one second.",
            "default": 1
          },
          "maxOpinionsPerDocket": {
            "title": "Maximum matching opinions per case",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum matching opinions selected per case package. The first three PDF pages of each are inspected. Firm matches require recognized Federal or Sixth Circuit singular captions and a legal-form marker or explicit law-firm designation. Other courts and unsupported layouts can return metadata with empty firm arrays. This is not complete representation history.",
            "default": 3
          },
          "maxPdfBytes": {
            "title": "Maximum PDF download size",
            "minimum": 1048576,
            "maximum": 16777216,
            "type": "integer",
            "description": "Maximum bytes for each PDF download. Default 8 MiB; allowed range 1–16 MiB. Larger or unreadable documents may leave firm arrays empty while usable corporate metadata still produces a billed case record. No OCR or LLM inference is used.",
            "default": 8388608
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}