For the complete documentation index, see llms.txt. This page is also available as Markdown.

Apartments

Apartments.com: properties, photos, and reviews.

Search properties

get

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).

Price: $0.0003 per item

Minimum charge: $0.003 per request (10 items)

Your current plan discount applies to the total. The minimum applies once per request, even when fewer items are returned. maxItems limits requested results; it does not lower the minimum billable count.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
locationstring · min: 2 · max: 40RequiredExample: Seattle, WA
sortstring · enumOptionalPossible values:
minRentnumber · max: 999999999Optional
maxRentnumber · max: 999999999Optional
minBednumber · max: 4Optional
maxBednumber · max: 4Optional
minBathnumber · max: 3Optional
maxBathnumber · max: 3Optional
maxItemsinteger · min: 1 · max: 200Optional
pageinteger · min: 1 · max: 100Optional
Responses
200

Successful request

application/json
requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24
statusintegerOptionalExample: 200
messagestringOptionalExample: OK
successbooleanOptionalExample: true
get/apartments/properties
GET /apartments/properties?location=text HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "id": "swv1xf7",
      "name": "110 Roy Apartments",
      "bedRange": "Studio - 2 Beds",
      "rentRange": "$1,500 - $3,500",
      "address": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "hasNextPage": null,
    "cursor": null,
    "offset": null
  },
  "pricing": {
    "currency": "USD",
    "amountCharged": "0.003000",
    "billableItems": 10
  }
}

Get a property by ID

get

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

Price: $0.0015 per item

Minimum charge: $0.0015 per request (1 item)

Your current plan discount applies to the total. The minimum applies once per request, even when fewer items are returned. maxItems limits requested results; it does not lower the minimum billable count.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
propertyIdstring · min: 1 · max: 20RequiredExample: swv1xf7
Query parameters
includeScorestring · enumOptionalPossible values:
includeModelDetailsstring · enumOptionalPossible values:
includeImagesstring · enumOptionalPossible values:
Responses
200

Successful request

application/json
requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24
statusintegerOptionalExample: 200
messagestringOptionalExample: OK
successbooleanOptionalExample: true
get/apartments/properties/{propertyId}
GET /apartments/properties/{propertyId} HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "id": "swv1xf7",
      "propertyName": "110 Roy Apartments",
      "url": "https://www.apartments.com/110-roy-apartments-seattle-wa/swv1xf7/",
      "propertyWebsite": "https://www.110royapts.example/",
      "lastUpdated": "2026-04-30T10:00:00.000Z",
      "description": "Modern apartments in the heart of Queen Anne.",
      "rating": 4.2,
      "beds": "Studio - 2 Beds",
      "baths": "1 - 2 Baths",
      "sqft": "500 - 1,200 sq ft",
      "baseRent": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "totalRent": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "coordinates": {
        "latitude": 47.6262,
        "longitude": -122.3521
      },
      "contact": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "specials": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "schools": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "amenities": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "fees": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "models": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "rentals": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "transportation": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "transitAndPOI": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "pricing": {
    "currency": "USD",
    "amountCharged": "0.001500",
    "billableItems": 1
  }
}

Get images for a property

get

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

Price: $0.0003 per item

Minimum charge: $0.003 per request (10 items)

Your current plan discount applies to the total. The minimum applies once per request, even when fewer items are returned. maxItems limits requested results; it does not lower the minimum billable count.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
propertyIdstring · min: 1 · max: 20RequiredExample: swv1xf7
Responses
200

Successful request

application/json
requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24
statusintegerOptionalExample: 200
messagestringOptionalExample: OK
successbooleanOptionalExample: true
get/apartments/properties/{propertyId}/images
GET /apartments/properties/{propertyId}/images HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "photos": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "floorPlans": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "virtualTours": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "virtualTourExtended": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "pricing": {
    "currency": "USD",
    "amountCharged": "0.003000",
    "billableItems": 10
  }
}

Get reviews for a property

get

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

Price: $0.0003 per item

Minimum charge: $0.003 per request (10 items)

Your current plan discount applies to the total. The minimum applies once per request, even when fewer items are returned. maxItems limits requested results; it does not lower the minimum billable count.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
propertyIdstring · min: 1 · max: 20RequiredExample: 7s2qyhy
Query parameters
maxItemsinteger · min: 1 · max: 200Optional
pageinteger · min: 1 · max: 100Optional
Responses
200

Successful request

application/json
requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24
statusintegerOptionalExample: 200
messagestringOptionalExample: OK
successbooleanOptionalExample: true
get/apartments/properties/{propertyId}/reviews
GET /apartments/properties/{propertyId}/reviews HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "key": "r-12345",
      "title": "Loved living here",
      "text": "Great staff and amenities. Highly recommend!",
      "rating": 4.5,
      "submissionDate": "Apr 30, 2026",
      "isOwner": false,
      "positiveFeedbackCount": 3,
      "comments": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "hasNextPage": null,
    "cursor": null,
    "offset": null
  },
  "pricing": {
    "currency": "USD",
    "amountCharged": "0.003000",
    "billableItems": 10
  }
}

Last updated