{
  "openapi": "3.0.1",
  "info": {
    "title": "Building Permits API: SF, Seattle, Austin & more (open data)",
    "description": "Roofing, solar, HVAC, pool permit leads from five US cities, with contractor company where published, optional scope fields and lead score, and SF soft-story retrofit buildings. Stale city feeds are flagged and not charged. No owner, applicant or private individual contact names, phones or emails.",
    "version": "1.1",
    "x-build-id": "RRVZui3ZVky8Z28aM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/gapforge~building-permit-feed/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-gapforge-building-permit-feed",
        "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/gapforge~building-permit-feed/runs": {
      "post": {
        "operationId": "runs-sync-gapforge-building-permit-feed",
        "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/gapforge~building-permit-feed/run-sync": {
      "post": {
        "operationId": "run-sync-gapforge-building-permit-feed",
        "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": [
          "cities"
        ],
        "properties": {
          "cities": {
            "title": "Cities",
            "minItems": 1,
            "maxItems": 5,
            "uniqueItems": true,
            "type": "array",
            "description": "The cities to read. Each one is an official city open-data feed whose own metadata states a public-domain or open licence.",
            "items": {
              "type": "string",
              "enum": [
                "san-francisco",
                "seattle",
                "austin",
                "cambridge-ma",
                "cincinnati"
              ],
              "enumTitles": [
                "San Francisco, CA",
                "Seattle, WA",
                "Austin, TX",
                "Cambridge, MA",
                "Cincinnati, OH"
              ]
            }
          },
          "issuedAfter": {
            "title": "Issued on or after",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "maxLength": 10,
            "type": "string",
            "description": "Earliest issue date (YYYY-MM-DD). Empty means 30 days before \"Issued on or before\"."
          },
          "issuedBefore": {
            "title": "Issued on or before",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "maxLength": 10,
            "type": "string",
            "description": "Latest issue date (YYYY-MM-DD), included. Empty means today (UTC)."
          },
          "permitTypes": {
            "title": "Permit types",
            "maxItems": 9,
            "uniqueItems": true,
            "type": "array",
            "description": "Keep only these types. Empty keeps every type. Solar and roof also match when the city's own work description names solar panels or roofing (the description itself is not output).",
            "items": {
              "type": "string",
              "enum": [
                "new_construction",
                "alteration",
                "demolition",
                "electrical",
                "plumbing",
                "mechanical",
                "roof",
                "solar",
                "other"
              ],
              "enumTitles": [
                "New construction",
                "Alteration, addition or repair",
                "Demolition",
                "Electrical",
                "Plumbing",
                "Mechanical",
                "Roof",
                "Solar",
                "Other"
              ]
            }
          },
          "minEstimatedCost": {
            "title": "Minimum estimated cost (USD)",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only permits whose city-published estimated cost is at least this amount. A permit without a cost is left out, and a city that publishes no cost column is skipped and named in the run status."
          },
          "onlyNewSinceLastRun": {
            "title": "Only new since last run",
            "type": "boolean",
            "description": "Deliver (and charge for) only permits that earlier runs with the same state key have not delivered, plus permits whose facts changed. Made for scheduled runs.",
            "default": false
          },
          "maxPermitsPerCity": {
            "title": "Maximum permits per city",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Deliver at most this many permits from each city, newest issue date first. You pay per permit delivered, so this also caps the cost.",
            "default": 100
          },
          "stateKey": {
            "title": "State key",
            "pattern": "^[A-Za-z0-9_-]+$",
            "minLength": 1,
            "maxLength": 40,
            "type": "string",
            "description": "Name of the memory used by \"Only new since last run\". Use a different key for each schedule. Letters, digits, dashes and underscores.",
            "default": "default"
          },
          "socrataAppToken": {
            "title": "Your Socrata app token (optional)",
            "type": "string",
            "description": "City portals may slow down requests without a token. You can create a free app token with the portal and paste it here; it is sent only to the city portals this tool reads and is never logged or stored in the output."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}