Apartments.com Property
Retrieve property with the Apartments.com API. Supply a URL. Sample fields include addresses and currency codes. Use it for property research or listing comparisons. The POST request schema also lists timeout.
- Selected price
- $0.00015 / callPublished pricing
- Sellers / implementations
- 1 / 1
- Requests · 30d
- —Loading...
- Success rate · 30d
- —Loading...
| Seller | Pricing | Requests · 30d | Performance | Access |
|---|---|---|---|---|
litescrapeCurrent Apartments.com Property · POST | $0.00015 / call | — | —successP50— |
Run sends a real API request. Charges follow the published API contract.
Response structure
propertyobjectaddressstringamenitiesobject[]@typestringnamestringvaluestring
availabilitystringcitystringcurrencystringdescriptionstringlatitudenumberlongitudenumbermax_priceintegermin_priceintegernamestringoffersobject@typestringavailabilitystringhighPriceintegerlowPriceintegerpriceCurrencystring
photosobject[]@typestringurlstring
property_idstringproperty_typestringratingobject@typestringbestRatingintegerratingCountintegerratingValuenumberworstRatinginteger
statestringtelephonestringurlstringzipcodestring
search_metadataobjectidstringstatusstringtotal_time_takenintegerurlstring
search_parametersobjecturlstring
submit_feedback_for_this_response_herestring
// Inferred from response examples. Fields are optional and other fields may be returned.
export type ApiResponse = {
property?: {
address?: string;
amenities?: Array<{
"@type"?: string;
name?: string;
value?: string;
}>;
availability?: string;
city?: string;
currency?: string;
description?: string;
latitude?: number;
longitude?: number;
max_price?: number;
min_price?: number;
name?: string;
offers?: {
"@type"?: string;
availability?: string;
highPrice?: number;
lowPrice?: number;
priceCurrency?: string;
};
photos?: Array<{
"@type"?: string;
url?: string;
}>;
property_id?: string;
property_type?: string;
rating?: {
"@type"?: string;
bestRating?: number;
ratingCount?: number;
ratingValue?: number;
worstRating?: number;
};
state?: string;
telephone?: string;
url?: string;
zipcode?: string;
};
search_metadata?: {
id?: string;
status?: string;
total_time_taken?: number;
url?: string;
};
search_parameters?: {
url?: string;
};
submit_feedback_for_this_response_here?: string;
};- Method
- POST
- Endpoint
https://api.openany.si/v1/agent-apis/litescrape/api/apartments/property- Content type
- application/json
- Authentication
Authorization: Bearer $OPENANY_API_KEY
curl \
'https://api.openany.si/v1/agent-apis/litescrape/api/apartments/property' \
-X POST \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
}'Input parameters
Fields in this listing; additional options and input encoding can vary by provider.
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
timeout | URL query parametersquery | number | No | 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. maximum: 90 |
url | JSON request bodybody | string | Yes | Apartments.com property URL ending in its seven-character listing ID, without query parameters.
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. maxLength: 2048 |
Required markers inside a nested object or variant apply when that object or variant is used.
Sample response
Sample response · Documented HTTP 200 Example from the provider's documentation. Field values in your results will differ.
{
"property": {
"address": "4711 E Riverside Dr",
"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"
}
],
"availability": "https://schema.org/InStock",
"city": "Austin",
"currency": "USD",
"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.",
"latitude": 30.23105,
"longitude": -97.71876,
"max_price": 2895,
"min_price": 1295,
"name": "Edison Austin",
"offers": {
"@type": "AggregateOffer",
"availability": "https://schema.org/InStock",
"highPrice": 2895,
"lowPrice": 1295,
"priceCurrency": "USD"
},
"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"
}
],
"property_id": "40n18nj",
"property_type": "ApartmentComplex",
"rating": {
"@type": "AggregateRating",
"bestRating": 5,
"ratingCount": 10,
"ratingValue": 3.6,
"worstRating": 1
},
"state": "TX",
"telephone": "+1-737-377-3852",
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/",
"zipcode": "78741"
},
"search_metadata": {
"id": "retained-first-party-fixture",
"status": "Success",
"total_time_taken": 0,
"url": "https://api.litescrape.com/api/apartments/property"
},
"search_parameters": {
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
},
"submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}Agent integration
Copy the resource contract without sharing an API key.
View API Markdown
# Apartments.com Property
Retrieve property with the Apartments.com API. Supply a URL. Sample fields include addresses and currency codes. Use it for property research or listing comparisons. The POST request schema also lists timeout.
## Available implementations
litescrape · Apartments.com Property: https://openany.si/markets/apis/capabilities/apartments-com-property?offering=43ec5dea-fd61-4ffd-a259-afd7d627c4a8 · $0.00015 / call
## Selected API contract
Documentation: https://openany.si/markets/apis/capabilities/apartments-com-property
Method: POST
Endpoint: https://api.openany.si/v1/agent-apis/litescrape/api/apartments/property
Price: $0.00015 / call
Provider: litescrape
Contract revision: 3
Price source: OpenAny public API contract and documented provider unit rates. Price update time: not supplied.
Use OPENANY_API_KEY from the environment. API Key calls use your shared balance.
## Prepared request
```bash
curl \
'https://api.openany.si/v1/agent-apis/litescrape/api/apartments/property' \
-X POST \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
}'
```
## API contract
```json
{
"resource_type": "api",
"name": "Apartments.com Property",
"endpoint": "https://api.openany.si/v1/agent-apis/litescrape/api/apartments/property",
"method": "POST",
"content_type": "application/json",
"execution_mode": "sync",
"authentication": {
"type": "bearer",
"environment_variable": "OPENANY_API_KEY"
},
"inputs": [
{
"description": "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.",
"location": "query",
"maximum": "90",
"name": "timeout",
"nullable": false,
"required": false,
"type": "number"
},
{
"description": "Get an Apartments.com property by URL.",
"json_schema": {
"additionalProperties": false,
"examples": [
{
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
}
],
"properties": {
"url": {
"description": "Apartments.com property URL ending in its seven-character listing ID, without query parameters.\n\nAlpha: 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.",
"maxLength": 2048,
"title": "Url",
"type": "string",
"x-litescrape": {
"formGroup": 0,
"group": 0,
"label": "URL",
"notes": [
"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."
],
"summary": "Apartments.com property URL ending in its seven-character listing ID, without query parameters."
}
}
},
"required": [
"url"
],
"title": "Request",
"type": "object"
},
"location": "body",
"name": "body",
"nullable": false,
"pointer": "",
"required": true,
"type": "object"
}
],
"billing": {
"currency": "USD",
"mode": "fixed",
"priceMicroUsd": "150",
"rounding": null,
"unit": "call",
"unitQuantity": null
},
"examples": [
{
"http_status": 200,
"name": "Official example",
"request": {
"body": {
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
},
"headers": {},
"path": {},
"query": {}
},
"response_body": {
"property": {
"address": "4711 E Riverside Dr",
"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"
}
],
"availability": "https://schema.org/InStock",
"city": "Austin",
"currency": "USD",
"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.",
"latitude": 30.23105,
"longitude": -97.71876,
"max_price": 2895,
"min_price": 1295,
"name": "Edison Austin",
"offers": {
"@type": "AggregateOffer",
"availability": "https://schema.org/InStock",
"highPrice": 2895,
"lowPrice": 1295,
"priceCurrency": "USD"
},
"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"
}
],
"property_id": "40n18nj",
"property_type": "ApartmentComplex",
"rating": {
"@type": "AggregateRating",
"bestRating": 5,
"ratingCount": 10,
"ratingValue": 3.6,
"worstRating": 1
},
"state": "TX",
"telephone": "+1-737-377-3852",
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/",
"zipcode": "78741"
},
"search_metadata": {
"id": "retained-first-party-fixture",
"status": "Success",
"total_time_taken": 0,
"url": "https://api.litescrape.com/api/apartments/property"
},
"search_parameters": {
"url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
},
"submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}
}
]
}
```Error handling
| Status | Next step |
|---|---|
400 | Check the offering and request fields. |
401 / 403 | Verify your credentials and access permissions. |
402 | Inspect the selected access mode and returned payment requirements. |
429 | Respect the returned rate limit and retry guidance. |
5xx | Inspect the error and usage record before retrying a paid operation. |
Official example
Example from the provider's documentation. Field values in your results will differ.
Prepare your environment
Use a terminal with cURL installed.
Use an OpenAny API key with shared-balance access. Confirm availability and price before running; a call may charge your balance.
Set the key in your terminal using the hidden prompt below. Keep its value out of source files and logs.
Terminal · macOS / Linuxprintf 'OpenAny API key: ' read -r -s OPENANY_API_KEY export OPENANY_API_KEY printf '\n'Run the request
Paste the complete command below into your terminal.
Values to replace before running 2
Review these request fields before running. Keep the published provider and request method unchanged.
timeout- 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.
body- Get an Apartments.com property by URL.
Terminal · cURLcurl \ 'https://api.openany.si/v1/agent-apis/litescrape/api/apartments/property' \ -X POST \ -H "Authorization: Bearer $OPENANY_API_KEY" \ -H 'Content-Type: application/json' \ --data-raw '{ "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/" }'Check the response
Sample response · Documented HTTP 200
Sample response{ "property": { "address": "4711 E Riverside Dr", "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" } ], "availability": "https://schema.org/InStock", "city": "Austin", "currency": "USD", "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.", "latitude": 30.23105, "longitude": -97.71876, "max_price": 2895, "min_price": 1295, "name": "Edison Austin", "offers": { "@type": "AggregateOffer", "availability": "https://schema.org/InStock", "highPrice": 2895, "lowPrice": 1295, "priceCurrency": "USD" }, "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" } ], "property_id": "40n18nj", "property_type": "ApartmentComplex", "rating": { "@type": "AggregateRating", "bestRating": 5, "ratingCount": 10, "ratingValue": 3.6, "worstRating": 1 }, "state": "TX", "telephone": "+1-737-377-3852", "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/", "zipcode": "78741" }, "search_metadata": { "id": "retained-first-party-fixture", "status": "Success", "total_time_taken": 0, "url": "https://api.litescrape.com/api/apartments/property" }, "search_parameters": { "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/" }, "submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token" }
Common questions
Do I need a separate key for every provider?
Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.
Are these providers interchangeable?
No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.
How is this API billed?
API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.
Where do the price and contract come from?
The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.
How do OpenAny Balance and x402 differ?
OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.
Does Playground send a paid request?
Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.
Use Apartments.com Property with your agent
Inspect endpoint contracts and confirm availability and pricing before a paid call.