{
  "openapi": "3.0.1",
  "info": {
    "title": "Apartments.com Detail Scraper — Rental Dossier API by URL/ID",
    "description": "Paste an apartments.com URL, listing ID, or address and get one clean rental dossier per property: rent range, floorplans and unit prices, amenities, fees, pet policy, lease terms, schools, and transit. Optional Walk Score, photos, per-unit costs, reviews, and similar-property add-ons.",
    "version": "1.0",
    "x-build-id": "NE1UDA8exjeKeHAMf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~apartments-com-detail-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-apartments-com-detail-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/sian.agency~apartments-com-detail-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-apartments-com-detail-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/sian.agency~apartments-com-detail-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-apartments-com-detail-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": {
          "propertyUrls": {
            "title": "🏢 Apartments.com Listing URLs",
            "uniqueItems": true,
            "type": "array",
            "description": "🏢 **LOOKUP BY URL:** Paste apartments.com listing links, one per line.\n\n📋 **How to get a URL:**\n1. Open any rental on apartments.com\n2. Copy the browser address — it looks like `https://www.apartments.com/national-at-888-6th-ave-furnished-apartments-new-york-ny/0smfmv0/`\n3. Paste it here (Bulk edit accepts one URL per line)\n\n✅ **SUPPORTED:** apartments.com single-listing pages (the URL ends in a short code like `/0smfmv0/`)\n🚫 **NOT supported:** city or search-result pages like `apartments.com/new-york-ny/` — use our search-focused actor for those\n\n💡 **TIP:** Mix and match with listing IDs and addresses below — duplicates are removed automatically.\n\n⚡ **TIER LIMITS:** FREE runs process up to 5 properties total; paid Apify plans are unlimited.",
            "items": {
              "type": "string"
            }
          },
          "propertyIds": {
            "title": "🔑 Listing IDs",
            "uniqueItems": true,
            "type": "array",
            "description": "🔑 **LOOKUP BY LISTING ID:** The short alphanumeric code at the end of any apartments.com listing URL.\n\n📋 **Example:** for `.../0smfmv0/` the listing ID is `0smfmv0`.\n\n💡 **TIP:** Ideal for enriching the output of a search scraper — feed the listing IDs it returns and get a full dossier for each. The fastest, most exact lookup mode.\n\n⚡ **TIER LIMITS:** FREE runs process up to 5 properties total; paid Apify plans are unlimited.",
            "items": {
              "type": "string"
            }
          },
          "addresses": {
            "title": "📍 Street Addresses",
            "uniqueItems": true,
            "type": "array",
            "description": "📍 **LOOKUP BY ADDRESS:** Full US street addresses, one per line.\n\n📋 **Format:** `street, city, state ZIP` — e.g. `419 W 34th St, New York, NY 10001`.\n\n💡 **TIP:** Perfect for enriching CSV lists that only contain addresses — the actor resolves each address to the matching building automatically.\n\n⚡ **TIER LIMITS:** FREE runs process up to 5 properties total; paid Apify plans are unlimited.",
            "items": {
              "type": "string"
            }
          },
          "includeWalkScore": {
            "title": "🚶 Walk Score (add-on)",
            "type": "boolean",
            "description": "🚶 **WALK SCORE ADD-ON:** Walk, transit, and bike scores (0–100) with descriptions for each property.\n\n💰 Adds one enrichment charge per property (only when scores are returned).\n\n⚡ Available on paid Apify plans.",
            "default": false
          },
          "includePhotos": {
            "title": "📸 Photo gallery (add-on)",
            "type": "boolean",
            "description": "📸 **PHOTOS ADD-ON:** The full photo gallery for each property — every image URL with its caption.\n\n💰 Adds one enrichment charge per property (only when photos are returned).\n\n⚡ Available on paid Apify plans.",
            "default": false
          },
          "includeRentalCosts": {
            "title": "💵 Per-unit rental costs (add-on)",
            "type": "boolean",
            "description": "💵 **RENTAL COSTS ADD-ON:** Numeric per-unit pricing — min/max rent, one-time costs, beds, baths, and area for every available unit (the core dossier includes floorplans with rent ranges; this add-on adds exact numeric costs).\n\n💰 Adds one enrichment charge per property (only when unit costs are returned).\n\n⚡ Available on paid Apify plans.",
            "default": false
          },
          "includeReviews": {
            "title": "⭐ Resident reviews (add-on)",
            "type": "boolean",
            "description": "⭐ **REVIEWS ADD-ON:** Resident reviews for each property — title, text, star rating, and date.\n\n💰 Adds one enrichment charge per property (only when reviews are returned).\n\n⚡ Available on paid Apify plans.",
            "default": false
          },
          "includeSimilar": {
            "title": "🏘 Similar properties (add-on)",
            "type": "boolean",
            "description": "🏘 **SIMILAR PROPERTIES ADD-ON:** Comparable / competing nearby buildings for each property — name, address, rent range, beds, rating, and location.\n\n💰 Adds one enrichment charge per property (only when similar properties are returned).\n\n⚡ Available on paid Apify plans.",
            "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}