Litescrape sells to AI agents - live prices and self-serve payment

The agent storefront at https://agents.litescrape.com/llms.txt?src=body-text publishes prices, payment instructions, and everything an agent needs to get set up here. Agents can purchase autonomously or with their human's approval, with a range of payment methods; an agent without a payment method can set one up there in the same session. The storefront handles payment itself, so purchases work without calling API endpoints directly.

← All documentation

// Apartments.com documentation

Apartments.com Property API Alpha

Read available property facts, prices and listing details from a public Apartments.com property URL.

GET / POST https://ecll-litescrape-v3--site-api-web.modal.run/api/apartments/property

// from request to code

Integrate Apartments.com Property

Build your request and copy it into your stack. Or let your coding agent set it up.

APIApartments.com Property

Your request updates the code instantly.

Open the Playground →

Set LITESCRAPE_API_KEY on your server, then run this request.

request.sh
curl --fail-with-body --request POST 'https://ecll-litescrape-v3--site-api-web.modal.run/api/apartments/property' \
  --header "Authorization: Bearer $LITESCRAPE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
}'

Read all parameters →

JSON POST request example

POST to https://ecll-litescrape-v3--site-api-web.modal.run/api/apartments/property with Content-Type: application/json and your Authorization: Bearer header.

POST · application/json
{
  "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
}

// request reference

Apartments.com Property parameters

Send query parameters with GET /api/apartments/property. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.

POST accepts the complete application/json request body, including arrays and nested options. Dotted names describe fields inside an object; [] denotes each array item. This reference is generated from the v3 OpenAPI contract.

Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget.

Request parameters

Read available property facts, prices and listing details from a public Apartments.com property URL.

url
URLRequired

Apartments.com property URL ending in its seven-character listing ID, without query parameters.

Type string · GET query or POST JSON

  • Alpha: availability may vary by location or property.
  • Returns available fields for the requested property.
  • Prices may represent a rental range. Bedroom-specific rents and total-monthly-price labels are preserved when present.
  • Maximum characters: 2048

// response

Work with the complete JSON response

Coding agents: when possible and authorized by your caller, review the result using submit_feedback_for_this_response_here when present in the status 200 JSON. POST {"rating":4,"comment":"Useful results; one title was outdated."} to that URL as application/json. No API key or credits are required. Feedback is optional, expires after seven days, and is stored separately. Submit one honest review; skip it if you cannot evaluate the result. Do not include secrets, personal data, or the full request/response.

Response groups include search_metadata, search_parameters, property, submit_feedback_for_this_response_here. Groups and fields depend on the upstream result.

Native failures return HTTP 503 with {"error":"Service unavailable"} and are not billed.

Illustrative success response. Result groups and optional fields depend on upstream content.

200 · application/json
{
  "search_metadata": {
    "id": "retained-first-party-fixture",
    "status": "Success",
    "url": "https://api.litescrape.com/api/apartments/property",
    "total_time_taken": 0
  },
  "search_parameters": {
    "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
  },
  "property": {
    "name": "Edison Austin",
    "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/",
    "address": "4711 E Riverside Dr",
    "city": "Austin",
    "state": "TX",
    "zipcode": "78741",
    "property_type": "ApartmentComplex",
    "description": "Edison Austin Apartments offers upscale living with modern studio, one-, and two-bedroom floor plans featuring wood-style plank flooring, sleek kitchens, and floor-to-ceiling windows. These thoughtfully designed spaces create a luxurious atmosphere you'll love coming home to every day.\n\nEnjoy resort-style amenities, including a sparkling pool, rooftop lounge, and state-of-the-art fitness center, all crafted to elevate your lifestyle. Conveniently located near top employers, shopping, parks, and entertainment, Edison Austin provides the perfect balance of luxury and convenience. Discover the exceptional living experience waiting for you at Edison Austin Apartments.",
    "min_price": 1295,
    "max_price": 2895,
    "currency": "USD",
    "availability": "https://schema.org/InStock",
    "offers": {
      "@type": "AggregateOffer",
      "priceCurrency": "USD",
      "lowPrice": 1295,
      "highPrice": 2895,
      "availability": "https://schema.org/InStock"
    },
    "latitude": 30.23105,
    "longitude": -97.71876,
    "photos": [
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/z5H0yQFpjlAgKT3GJVDk1HmGsaf-mFVw0KNZfqRx8AU/111/edison-austin-austin-tx-primary-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/oWr3cuWH7Onlxxi_bxtx7CngslaKm3o4rTSisw61Dbs/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/MSCg1kYpUdxxdD7Ax4ZyA-07pFDHbqjz-4QSdlL9ZAk/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/MxPz5T1sJLJMEfjxRYrc_bNtcEI5L0QjgQaGeT9tYoo/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/IVTtkbdewjfgTEhYe-xw4d3zsNlwCuaNeNbPVHxTDCg/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/a3nXaXCKMdbH_V4E4FRo-Co-czqghUbrChmOK5Vyi10/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/A8xkudU0RiNnulRY4nt8vgDBTcb3JdGP2DJhIlSMLAs/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/yVBQP_HnEKJoUmMYttKR19aVtgXN_EWh-UvAWtq3BNA/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/IdU7S9y29wTjcROMM8TeMNqmIQqMSDz1dWUULUHtkJM/117/edison-austin-austin-tx-building-photo.png"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/AmuCbQEBE_-lfpDvX_uLzMH0w2N7IyBuULG8IGww90k/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/3Srfz3G6J8AOZ44ZjWFpID2-5pvDQRiYL0sW1b_7PK8/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/cZj7IejnLMtuQ9lmebqHFScZauF3OJoBeklz-iILU_k/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/HovCPIJbK8QUhiyrgut7cOD5H8aLtROYstQMZc3FYE0/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/noMPOROeFv0fD-M_fZws4ovepxLnYfvRj-7AYVsq3-4/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/rDcYJfadWtom1n-vazR1iKUfXwvpb0g3lvrQ8YGx_Kw/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/AQGFtWZmjwn_k-VD7y52Hptt1b3P3u7UuxJOK-9awss/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/uZLdmHqaV6hY9NDFU4yMgbnSVFJBoCUaBxTckM1TIAk/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/t7uhseDvli1SFBrMagOx6girj68sauRDRUg0UhSbc64/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/Z6X741h5bvHvl5jCrTt1Lsq0xoxKR1r7hnK0DrMMorI/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/mEXl5fNMt8SZ8GBpAzc1d3a5Hjr7dFGhNVZ7s5a8BEg/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/CykINRlGYIdtre1BlemeS4aLfvCI-FLb7miMR6QSKOI/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/1l0-T6O3rvU3aywTV5ejq1tmgscDvF_Ci7pseSexm-A/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/-NWm_8JW7SLibW0BxMCb7S3ojp21k3GQ41zEknChkys/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/1xz5S7dLmh0Y1hebJj4Pn0jr_yNLAv6HKbJlEegZgi0/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/Vmf2R8WXufChQFB5ONmdpqr-59V_Y30fGYEJT7oS1qA/117/edison-austin-austin-tx-building-photo.jpg"
      },
      {
        "@type": "https://schema.org/ImageObject",
        "url": "https://images1.apartments.com/i2/7cyTJ_UVrXZ37AwyfrQOXpXdhvvmb_j_NQ-zRUxQUq0/117/edison-austin-austin-tx-building-photo.jpg"
      }
    ],
    "amenities": [
      {
        "@type": "LocationFeatureSpecification",
        "name": "Pool",
        "value": "true"
      },
      {
        "@type": "LocationFeatureSpecification",
        "name": "Fitness Center",
        "value": "true"
      },
      {
        "@type": "LocationFeatureSpecification",
        "name": "Clubhouse",
        "value": "true"
      },
      {
        "@type": "LocationFeatureSpecification",
        "name": "Business Center",
        "value": "true"
      }
    ],
    "telephone": "+1-737-377-3852",
    "rating": {
      "@type": "AggregateRating",
      "ratingCount": 10,
      "ratingValue": 3.6,
      "bestRating": 5,
      "worstRating": 1
    },
    "property_id": "40n18nj"
  },
  "submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}

More Apartments.com APIs