{
  "openapi": "3.0.1",
  "info": {
    "title": "PropertyShark NYC Commercial Transactions Scraper",
    "description": "Scrapes PropertyShark NYC commercial market pages: significant sales with address, sale date, price, sqft and price/sqft, plus borough and submarket stats and quarterly history back to 2016.",
    "version": "0.0",
    "x-build-id": "rsnSr2OjWv562C0Wo"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/parseforge~commercial-property-transactions-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-parseforge-commercial-property-transactions-scraper",
        "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/parseforge~commercial-property-transactions-scraper/runs": {
      "post": {
        "operationId": "runs-sync-parseforge-commercial-property-transactions-scraper",
        "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/parseforge~commercial-property-transactions-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-parseforge-commercial-property-transactions-scraper",
        "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": {
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Which commercial market to read. PropertyShark publishes a separate market-trends page per property type per borough.",
            "items": {
              "type": "string",
              "enum": [
                "commercial",
                "office",
                "retail",
                "industrial",
                "multifamily"
              ],
              "enumTitles": [
                "Commercial (all)",
                "Office",
                "Retail",
                "Industrial",
                "Multifamily"
              ]
            }
          },
          "boroughs": {
            "title": "Boroughs",
            "type": "array",
            "description": "New York City boroughs to cover. PropertyShark publishes commercial market trends for the five boroughs only.",
            "items": {
              "type": "string",
              "enum": [
                "manhattan",
                "brooklyn",
                "queens",
                "bronx",
                "staten-island"
              ],
              "enumTitles": [
                "Manhattan",
                "Brooklyn",
                "Queens",
                "Bronx",
                "Staten Island"
              ]
            }
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "How many rows to return in total, across every enabled output. Free users: limited to 10 items (preview). Paid users: up to 1,000,000."
          },
          "minSalePrice": {
            "title": "Min sale price ($)",
            "minimum": 0,
            "type": "integer",
            "description": "Drop significant sales that closed below this price."
          },
          "maxSalePrice": {
            "title": "Max sale price ($)",
            "minimum": 0,
            "type": "integer",
            "description": "Drop significant sales that closed above this price."
          },
          "minBuildingSqft": {
            "title": "Min building sqft",
            "minimum": 0,
            "type": "integer",
            "description": "Drop significant sales of buildings smaller than this."
          },
          "maxBuildingSqft": {
            "title": "Max building sqft",
            "minimum": 0,
            "type": "integer",
            "description": "Drop significant sales of buildings larger than this."
          },
          "saleDateFrom": {
            "title": "Sale date from (YYYY-MM-DD)",
            "type": "string",
            "description": "Drop significant sales that closed before this date."
          },
          "saleDateTo": {
            "title": "Sale date to (YYYY-MM-DD)",
            "type": "string",
            "description": "Drop significant sales that closed after this date."
          },
          "includeMarketOverview": {
            "title": "Include market overview",
            "type": "boolean",
            "description": "Add one row per market with the current period headline stats: median price/sqft, sales volume, transaction count, total sqft, and the year-over-year change for each.",
            "default": false
          },
          "includeSubmarketStats": {
            "title": "Include submarket breakdown",
            "type": "boolean",
            "description": "Add one row per submarket with its median price/sqft, transaction count, sales volume and total sqft for the current period.",
            "default": false
          },
          "includeMetricHistory": {
            "title": "Include quarterly history",
            "type": "boolean",
            "description": "Add one row per market, metric and quarter of the published history (median price/sqft, transactions, sales volume, total sqft) back to 2016. This is the high-volume block: roughly 170 rows per market.",
            "default": false
          },
          "includeVolumeByPropertyType": {
            "title": "Include sales volume split by property type",
            "type": "boolean",
            "description": "Add the share of sales volume by property type. PropertyShark publishes this split on the Commercial (all) pages only.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional proxy. The source is anonymous and normally needs none; switch on Apify Proxy if your runs start seeing Cloudflare challenges.",
            "default": {
              "useApifyProxy": false
            }
          },
          "state": {
            "title": "State (legacy)",
            "type": "string",
            "description": "Kept so saved tasks from the older location-slug input keep running. Use the Boroughs field instead; a legacy city of manhattan, brooklyn, queens, bronx or staten-island is mapped onto it."
          },
          "county": {
            "title": "County (legacy)",
            "type": "string",
            "description": "Kept so saved tasks from the older location-slug input keep running. Use the Boroughs field instead; a legacy city of manhattan, brooklyn, queens, bronx or staten-island is mapped onto it."
          },
          "city": {
            "title": "City (legacy)",
            "type": "string",
            "description": "Kept so saved tasks from the older location-slug input keep running. Use the Boroughs field instead; a legacy city of manhattan, brooklyn, queens, bronx or staten-island is mapped onto it."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}