{
  "openapi": "3.0.1",
  "info": {
    "title": "U.S. Company Filings and UK Records, one schema",
    "description": "Search company names across U.S. public company filings (including Form D raises), UK Companies House and U.S. federal contract notices (SAM.gov, bring your own key). One normalized schema, organisation records only, with cross-source entity matching.",
    "version": "0.1",
    "x-build-id": "Ar95UaOZ95iHE8xh4"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/neatline~public-records-bundle/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-neatline-public-records-bundle",
        "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/neatline~public-records-bundle/runs": {
      "post": {
        "operationId": "runs-sync-neatline-public-records-bundle",
        "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/neatline~public-records-bundle/run-sync": {
      "post": {
        "operationId": "run-sync-neatline-public-records-bundle",
        "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": "Mode",
            "enum": [
              "search",
              "recentFormD",
              "canary"
            ],
            "type": "string",
            "description": "Search: look up the queries below. Recent Form D: list the newest SEC Form D private-placement filings (no query needed). Canary: health check used by the publisher's schedule.",
            "default": "search"
          },
          "queries": {
            "title": "Company names or keywords",
            "type": "array",
            "description": "Up to 10. Used as a company name for U.S. filings and Companies House, and as a title keyword for SAM.gov (leave empty with SAM.gov only to list all recent notices).",
            "items": {
              "type": "string"
            }
          },
          "sources": {
            "title": "Sources",
            "type": "array",
            "description": "Which registries to query.",
            "items": {
              "type": "string",
              "enum": [
                "sec_edgar",
                "companies_house",
                "sam_gov"
              ],
              "enumTitles": [
                "U.S. public company filings (SEC EDGAR data)",
                "UK Companies House",
                "SAM.gov (U.S. federal contract notices, needs your own key)"
              ]
            },
            "default": [
              "sec_edgar",
              "companies_house"
            ]
          },
          "maxResultsPerSource": {
            "title": "Max records per source",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "You are charged per record returned, so this caps your cost.",
            "default": 25
          },
          "matchEntities": {
            "title": "Match entities across sources",
            "type": "boolean",
            "description": "Group records that refer to the same organization (by normalized name) and report cross-source groups. Each cross-source group is a separate billable event. Name matching is a lead, not proof.",
            "default": true
          },
          "secForms": {
            "title": "SEC form types",
            "type": "array",
            "description": "Form types to return for each company, e.g. D, 10-K, 10-Q, 8-K, S-1, 4. Form D covers D and D/A.",
            "default": [
              "D"
            ],
            "items": {
              "type": "string"
            }
          },
          "secIncludeFormDDetails": {
            "title": "Parse Form D details",
            "type": "boolean",
            "description": "Fetch each Form D to add offering amount, amount sold, investor count and exemptions. Organisation facts only; people named on the form are never read.",
            "default": true
          },
          "secBroadEntitySearch": {
            "title": "Broad SEC name search",
            "type": "boolean",
            "description": "Off: only entities whose name equals the query (or the single best hit). On: up to 5 similarly named SEC filers.",
            "default": false
          },
          "secRecentDays": {
            "title": "Recent Form D window (days)",
            "minimum": 1,
            "maximum": 31,
            "type": "integer",
            "description": "Used by mode 'Newest SEC Form D filings'.",
            "default": 7
          },
          "chActiveOnly": {
            "title": "Companies House: active companies only",
            "type": "boolean",
            "description": "Return only companies whose status is active.",
            "default": false
          },
          "samGovApiKey": {
            "title": "SAM.gov API key (required for SAM.gov)",
            "type": "string",
            "description": "Your own SAM.gov public API key (sam.gov > sign in > Account Details). SAM.gov forbids sharing a key between users, so this Actor never supplies one. WARNING: a personal key with no entity role is limited to 10 requests per 24 hours; keys tied to an entity role get 1,000 per day. Stored encrypted."
          },
          "samPostedDaysBack": {
            "title": "SAM.gov: posted in the last N days",
            "minimum": 1,
            "maximum": 364,
            "type": "integer",
            "description": "SAM.gov: posted in the last N days",
            "default": 30
          },
          "samNoticeTypes": {
            "title": "SAM.gov: notice types",
            "type": "array",
            "description": "Procurement type codes: o solicitation, k combined synopsis/solicitation, p presolicitation, r sources sought, s special notice, a award notice, u justification, g surplus sale. Empty = all.",
            "default": [],
            "items": {
              "type": "string"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}