{
  "openapi": "3.0.1",
  "info": {
    "title": "Chicago New Business License Radar",
    "description": "New Chicago business licenses as opening leads, refreshed daily from the City's official dataset: restaurants, liquor, retail, salons, and auto. Grouped by category and classified as new business, new location, or relocation. Businesses only - individuals are excluded. No account or API key needed.",
    "version": "0.1",
    "x-build-id": "ooUcibzvK5P3NPeBV"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lukehunter~chicago-new-business-license-radar/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lukehunter-chicago-new-business-license-radar",
        "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/lukehunter~chicago-new-business-license-radar/runs": {
      "post": {
        "operationId": "runs-sync-lukehunter-chicago-new-business-license-radar",
        "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/lukehunter~chicago-new-business-license-radar/run-sync": {
      "post": {
        "operationId": "run-sync-lukehunter-chicago-new-business-license-radar",
        "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": {
          "sinceDays": {
            "title": "Issued in the last (days)",
            "minimum": 1,
            "maximum": 90,
            "type": "integer",
            "description": "Return licenses the City issued in this many days (1-90). The City publishes with a lag of about 1-2 business days.",
            "default": 14
          },
          "categoryGroups": {
            "title": "Category groups",
            "type": "array",
            "description": "Only these kinds of business. Leave empty for all. EVENT = special-event food/liquor, pop-up retail and raffles (temporary).",
            "items": {
              "type": "string",
              "enum": [
                "FOOD",
                "LIQUOR",
                "RETAIL",
                "PERSONAL_SERVICES",
                "AUTO",
                "EVENT",
                "OTHER"
              ],
              "enumTitles": [
                "Food (restaurants, cafes, grocery, shared kitchens, wholesale food)",
                "Liquor (taverns, package goods, consumption on premises, patios)",
                "Retail (shops, tobacco, secondhand)",
                "Personal services (hair, nails, skincare, massage, tattoo, fitness)",
                "Auto (repair, fuel, towing, garages, valet)",
                "Temporary events and pop-ups",
                "Other (offices, services, manufacturing, childcare, amusement)"
              ]
            },
            "default": []
          },
          "openingTypes": {
            "title": "Opening types",
            "type": "array",
            "description": "Only these kinds of opening. Leave empty for all. NEW_BUSINESS = the account's first-ever Chicago license was issued within 90 days of this one. NEW_LOCATION = an established business's first license at this site. EXISTING_LOCATION = an extra license at a site that already had one. RELOCATION needs 'Include change of location' on.",
            "items": {
              "type": "string",
              "enum": [
                "NEW_BUSINESS",
                "NEW_LOCATION",
                "EXISTING_LOCATION",
                "RELOCATION",
                "TEMPORARY_EVENT"
              ],
              "enumTitles": [
                "New business",
                "Established business, new location",
                "Existing location, extra license",
                "Relocation (change of location)",
                "Temporary event / pop-up"
              ]
            },
            "default": []
          },
          "includeChangeOfLocation": {
            "title": "Include change of location (relocations)",
            "type": "boolean",
            "description": "Also return licenses re-issued because a business moved to a new address (application type C_LOC).",
            "default": false
          },
          "communityAreas": {
            "title": "Community areas",
            "type": "array",
            "description": "Only these Chicago community areas, by name (e.g. WEST TOWN, LOOP) or number (e.g. 24, 32). Leave empty for the whole city. Rows without a community area are excluded when this is set.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "zipCodes": {
            "title": "ZIP codes",
            "type": "array",
            "description": "Only these 5-digit ZIP codes. Leave empty for all.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Maximum licenses",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Hard cap on licenses delivered (and charged) per run, 1-5000, default 500. Newest first.",
            "default": 500
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}