> For the complete documentation index, see [llms.txt](https://docs.pullbay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullbay.com/api-reference/apartments.md).

# Apartments

Apartments.com: properties, photos, and reviews.

## Search properties

> Search Apartments.com properties by location with optional rent/bed/bath filters. Use \`page\` (1-indexed) to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive).

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"apartments","description":"Apartments.com: properties, photos, and reviews."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApartmentsProperty":{"type":"object","description":"An Apartments.com property summary (search result entry).","properties":{"id":{"type":"string"},"name":{"type":"string"},"bedRange":{"type":"string"},"rentRange":{"type":"string"},"address":{"type":"object","additionalProperties":true}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/apartments/properties":{"get":{"operationId":"searchApartmentsProperties","summary":"Search properties","description":"Search Apartments.com properties by location with optional rent/bed/bath filters. Use `page` (1-indexed) to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive).","tags":["apartments"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":40}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["default","lastUpdated","rentHighToLow","rentLowToHigh"]}},{"name":"minRent","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":999999999}},{"name":"maxRent","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":999999999}},{"name":"minBed","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":4}},{"name":"maxBed","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":4}},{"name":"minBath","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":3}},{"name":"maxBath","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":3}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApartmentsProperty"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get a property by ID

> Returns full details for an Apartments.com property. Use the \`includeScore\`, \`includeModelDetails\`, and \`includeImages\` flags to opt into extra fields.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"apartments","description":"Apartments.com: properties, photos, and reviews."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApartmentsPropertyDetail":{"type":"object","description":"Full property detail returned by /properties/{propertyId}.","properties":{"id":{"type":"string"},"propertyName":{"type":"string"},"url":{"type":"string"},"propertyWebsite":{"type":"string"},"lastUpdated":{"type":"string"},"description":{"type":"string"},"rating":{"type":"number"},"beds":{"type":"string"},"baths":{"type":"string"},"sqft":{"type":"string"},"baseRent":{"type":"object","additionalProperties":true},"totalRent":{"type":"object","additionalProperties":true},"location":{"type":"object","additionalProperties":true},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"contact":{"type":"object","additionalProperties":true},"specials":{"type":"object","nullable":true,"additionalProperties":true},"schools":{"type":"object","additionalProperties":true},"amenities":{"type":"array","items":{"type":"object","additionalProperties":true}},"fees":{"type":"array","items":{"type":"object","additionalProperties":true}},"models":{"type":"array","items":{"type":"object","additionalProperties":true}},"rentals":{"type":"array","items":{"type":"object","additionalProperties":true}},"transportation":{"type":"array","items":{"type":"object","additionalProperties":true}},"transitAndPOI":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/apartments/properties/{propertyId}":{"get":{"operationId":"getApartmentsPropertyDetail","summary":"Get a property by ID","description":"Returns full details for an Apartments.com property. Use the `includeScore`, `includeModelDetails`, and `includeImages` flags to opt into extra fields.","tags":["apartments"],"parameters":[{"name":"propertyId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":20}},{"name":"includeScore","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"includeModelDetails","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"includeImages","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApartmentsPropertyDetail"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get images for a property

> Returns photos, floor plans, virtual tours, and extended virtual tours for a property.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"apartments","description":"Apartments.com: properties, photos, and reviews."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApartmentsPropertyImages":{"type":"object","description":"Photos, floor plans, and virtual tours for a property.","properties":{"photos":{"type":"array","items":{"type":"object","additionalProperties":true}},"floorPlans":{"type":"array","items":{"type":"object","additionalProperties":true}},"virtualTours":{"type":"array","items":{"type":"object","additionalProperties":true}},"virtualTourExtended":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/apartments/properties/{propertyId}/images":{"get":{"operationId":"getApartmentsPropertyImages","summary":"Get images for a property","description":"Returns photos, floor plans, virtual tours, and extended virtual tours for a property.","tags":["apartments"],"parameters":[{"name":"propertyId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":20}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApartmentsPropertyImages"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get reviews for a property

> Returns reviews for an Apartments.com property. Use \`page\` (1-indexed) to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive).

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"apartments","description":"Apartments.com: properties, photos, and reviews."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApartmentsPropertyReview":{"type":"object","description":"A review for an Apartments.com property.","properties":{"key":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"rating":{"type":"number"},"submissionDate":{"type":"string"},"isOwner":{"type":"boolean"},"positiveFeedbackCount":{"type":"integer"},"comments":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/apartments/properties/{propertyId}/reviews":{"get":{"operationId":"getApartmentsPropertyReviews","summary":"Get reviews for a property","description":"Returns reviews for an Apartments.com property. Use `page` (1-indexed) to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive).","tags":["apartments"],"parameters":[{"name":"propertyId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":20}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApartmentsPropertyReview"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pullbay.com/api-reference/apartments.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.