{
  "openapi": "3.0.1",
  "info": {
    "title": "US Business Entity Search & New Business Filings",
    "description": "Search official US state business registries by company name, or pull newly registered companies by date, from the states' own open-data APIs (NY, CO, CT, OR, PA, TX). Company records only: no officer, owner or agent-person names. Every row names its source dataset. Pay per record found.",
    "version": "0.1",
    "x-build-id": "y0KSZiJvYHQeMB1J9"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/enisbodlli~us-business-registry-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-enisbodlli-us-business-registry-search",
        "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/enisbodlli~us-business-registry-search/runs": {
      "post": {
        "operationId": "runs-sync-enisbodlli-us-business-registry-search",
        "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/enisbodlli~us-business-registry-search/run-sync": {
      "post": {
        "operationId": "run-sync-enisbodlli-us-business-registry-search",
        "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": [
          "states"
        ],
        "properties": {
          "states": {
            "title": "States",
            "minItems": 1,
            "maxItems": 6,
            "uniqueItems": true,
            "type": "array",
            "description": "The state registers to read. These six publish their business register through an official open-data API: New York, Colorado, Connecticut, Oregon, Pennsylvania and Texas (Texas: the Comptroller's roll of franchise taxpayers). Other states are not covered.",
            "items": {
              "type": "string",
              "enum": [
                "NY",
                "CO",
                "CT",
                "OR",
                "PA",
                "TX"
              ],
              "enumTitles": [
                "New York",
                "Colorado",
                "Connecticut",
                "Oregon",
                "Pennsylvania",
                "Texas (franchise taxpayers)"
              ]
            }
          },
          "nameQueries": {
            "title": "Company names",
            "maxItems": 500,
            "uniqueItems": true,
            "type": "array",
            "description": "Company names to look up, one per line. Each name is searched in every chosen state, in the company-name column only. Upper and lower case do not matter. Leave empty to list companies by registration date instead. Up to 500 names per run, 2 to 200 characters each.",
            "items": {
              "type": "string",
              "minLength": 2,
              "maxLength": 200
            }
          },
          "nameQuery": {
            "title": "Single company name",
            "minLength": 2,
            "maxLength": 200,
            "type": "string",
            "description": "One company name, for callers that send a single name. It is searched together with the names in \"Company names\"."
          },
          "matchMode": {
            "title": "Name match",
            "enum": [
              "contains",
              "exact",
              "startsWith"
            ],
            "type": "string",
            "description": "How a company name is compared with the register. \"contains\": the register's name holds the text anywhere; the exact name comes first, then names that begin with it. \"exact\": the whole name is equal, punctuation included, so \"Tesla, Inc.\" does not match \"Tesla Inc\". \"startsWith\": the register's name begins with the text.",
            "default": "contains"
          },
          "registeredWithinDays": {
            "title": "Registered within the last days",
            "minimum": 1,
            "maximum": 36500,
            "type": "integer",
            "description": "Only companies registered or formed in the last N days, counted back from today (UTC). Use this for a scheduled feed of new business filings. Do not combine it with the two date fields below."
          },
          "registeredAfter": {
            "title": "Registered on or after",
            "type": "string",
            "description": "Only companies registered or formed on or after this date, written as YYYY-MM-DD."
          },
          "registeredBefore": {
            "title": "Registered on or before",
            "type": "string",
            "description": "Only companies registered or formed on or before this date, written as YYYY-MM-DD."
          },
          "entityTypes": {
            "title": "Entity types",
            "maxItems": 5,
            "uniqueItems": true,
            "type": "array",
            "description": "Only these kinds of entity. Each register's own wording is sorted into five groups: limited liability companies, corporations, nonprofit corporations, partnerships (LP, LLP, LLLP, general) and everything else (trusts, cooperatives, associations, assumed names and so on). Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "llc",
                "corporation",
                "nonprofit",
                "partnership",
                "other"
              ],
              "enumTitles": [
                "LLC",
                "Corporation",
                "Nonprofit",
                "Partnership",
                "Other"
              ]
            }
          },
          "status": {
            "title": "Status",
            "enum": [
              "any",
              "active",
              "inactive"
            ],
            "type": "string",
            "description": "\"active\": only entities the register shows as existing and entitled to do business. \"inactive\": only dissolved, withdrawn, revoked, merged, delinquent or forfeited entities. Colorado, Connecticut and Texas publish a status. New York, Oregon and Pennsylvania publish active entities only, so \"inactive\" returns nothing from them.",
            "default": "any"
          },
          "city": {
            "title": "City",
            "maxLength": 100,
            "type": "string",
            "description": "Only companies whose address is in this city, compared with the whole city name without regard to case. The address is the principal one where the register has it (Colorado, Connecticut, Oregon, Pennsylvania), the mailing address in Texas, and the location or service-of-process address in New York."
          },
          "zip": {
            "title": "ZIP code",
            "pattern": "^\\d{3,5}$",
            "type": "string",
            "description": "Only companies whose ZIP code begins with these digits: a full 5-digit ZIP or the first 3 or 4 digits of an area. The same address is used as for \"City\"."
          },
          "maxResults": {
            "title": "Maximum records",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "The run stops after this many company records. You pay per record, so this is also the cap on the cost of the run. Several states share it: each gets an equal part first, and what one state does not use goes to the others. Use \"Maximum records per state\" for a fixed cap per state.",
            "default": 1000
          },
          "maxResultsPerState": {
            "title": "Maximum records per state",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "At most this many records from each state, and for each company name when names are searched. 0 means no cap per state.",
            "default": 0
          },
          "onlyNew": {
            "title": "Only records not returned before",
            "type": "boolean",
            "description": "Return only companies that an earlier run of the same saved task has not returned. Use it with a schedule to get each new registration once. The memory is kept per task and state for 400 days; runs started without a task share memory per identical search.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}