# Auction.com \[Only 💰$1 ] Search and Details Scraper (`memo23/auction-com-scraper`) Actor
\[💰$1 per 1,000] No limits, no quotas, unlimited extraction. Auction.com scraper that extracts structured property listings from search URLs and filters. Get listing URLs, photos, address data, beds, baths, sqft, lot size, year built, bids, sale type, auction dates, occupancy, and property status
- **URL**: https://apify.com/memo23/auction-com-scraper.md
- **Developed by:** [Muhamed Didovic](https://apify.com/memo23) (community)
- **Categories:** Real estate, Automation, Lead generation
- **Stats:** 14 total users, 13 monthly users, 61.5% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet
## Pricing
from $1.00 / 1,000 results
This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).
If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# README
## Auction.com Scraper
**Unlock the Full Power of Auction.com Property Data** - Track, analyze, and monitor Auction.com listings with a scraper built for search result pages, URL-based filters, and structured real-estate output. Whether you are following bank-owned inventory, foreclosure activity, nearby search results, or pricing and occupancy trends, this actor turns Auction.com listing data into a usable dataset for research, lead generation, and market analysis.
*"From active online auctions to filtered foreclosure and bank-owned inventory, we turn Auction.com's listing data into your competitive advantage."*
### Overview
The Auction.com Scraper extracts structured property listing data from Auction.com URLs. It supports search result URLs, direct property detail URLs, and internally built search URLs based on Auction.com path filters. The actor maps Auction.com URL segments to the GraphQL payloads used by the site and returns flattened records ready for export to JSON or CSV.
### What does Auction.com Scraper do?
The Auction.com Scraper is a powerful tool that enables you to:
#### Comprehensive Data Collection
- **Property Listings**
- Extract listing IDs, listing URLs, address data, photos, auction dates, and sale type
- Capture property characteristics such as beds, baths, square footage, lot size, and year built
- Gather auction signals like opening bid, starting bid, online vs live auction, and reserve visibility
- Track listing features such as buyer premium availability, occupancy status, financing availability, broker coop, and first look flags
- Collect property value fields such as estimated resale value when available
- **Search Context**
- Parse Auction.com URL filters into structured GraphQL filters
- Preserve listing state across online auction, foreclosure, bank-owned, and coming soon inventory
- Support real-estate filter dimensions such as property type, occupancy, beds, baths, sqft, price, sale format, and market-insight tags
#### Advanced Scraping Capabilities
- **URL-to-GraphQL Mapping**: Converts Auction.com search URLs into the GraphQL filters used by the site
- **Pagination Handling**: Automatically follows additional result pages when the GraphQL search reports more pages
- **Efficient Processing**: Processes only new or unseen listings in monitoring mode
- **Flexible Filtering**: Supports hardcoded mapping for many Auction.com filter suffixes used in real search URLs
- **Structured Output**: Returns flattened, competitor-style listing records for easy downstream use
#### Flexible Scraping Options
- **Search Results**: Scrape all property listings from an Auction.com search URL
- Example: `https://www.auction.com/residential/IL/Chicago_ct/active_lt/online,in_person,remote_bid,offer_af`
- **Filtered Searches**: Apply Auction.com path filters directly in the start URL
- Example: `https://www.auction.com/residential/IL/Chicago_ct/active_lt/offer,direct_offer,remote_bid,in_person,online_af/auction_date_order,resi_sort_v2_st/y_fa/y_nbs/100_nsr`
- **Direct Property Details**: Scrape a single Auction.com property detail URL directly
- Example: `https://www.auction.com/details/638-e-91st-st-chicago-il-2037268`
- **Built Search URLs**: Build one search URL from state, city, listing type, and sale format inputs when `startUrls` is empty
This tool is ideal for:
- Auction inventory research and monitoring
- Tracking bank-owned and foreclosure property trends
- Building structured property datasets for analysis or resale
- Monitoring new or changed inventory over time
- Supporting lead generation, acquisitions, and market intelligence workflows
### Features
- **Comprehensive Data Extraction**: Detailed property listing, auction, and search-filter data
- **GraphQL-Based Collection**:
- **Search Results**: Scrape all listings from Auction.com search results (e.g., `https://www.auction.com/residential/IL/Chicago_ct/active_lt/online,in_person,remote_bid,offer_af`)
- **Direct Detail URLs**: Scrape an individual property from a detail page URL (e.g., `https://www.auction.com/details/638-e-91st-st-chicago-il-2037268`)
- **Flattened Output**: Return a normalized record per property instead of raw nested GraphQL payloads
- **Flexible Input**: Supports multiple input formats:
- Search result URLs copied directly from Auction.com
- Direct property detail URLs copied from Auction.com
- Built search URLs from Auction.com path inputs
- Advanced Auction.com filter URLs with many supported path suffixes
- **Automatic Pagination**: Handles multi-page GraphQL result sets automatically
- **Efficient Processing**: Concurrent scraping with configurable concurrency settings
- **Reliable Performance**: Built-in retry mechanisms and proxy support
- **Structured Data Export**: Download property listing data in JSON or CSV format for analysis
### How to Use
#### Scraping Property Listings
To scrape Auction.com property listings:
1. **Set Up**: Ensure you have an Apify account and access to the Apify platform.
2. **Configure Input**: Provide one or more Auction.com search URLs, direct property detail URLs, or build one search URL using state/city inputs:
- `https://www.auction.com/residential/IL/Chicago_ct/active_lt/online,in_person,remote_bid,offer_af`
- `https://www.auction.com/residential/IL/Chicago_ct/active_lt/offer,direct_offer,remote_bid,in_person,online_af/auction_date_order,resi_sort_v2_st/y_fa/y_nbs/100_nsr`
- `https://www.auction.com/details/638-e-91st-st-chicago-il-2037268`
3. **Adjust Settings**: Configure options like max items, monitoring mode, and proxy settings as needed.
4. **Run the Scraper**: Execute the scraper on the Apify platform.
5. **Data Collection**: The scraper will output flattened Auction.com property records.
### Input Configuration
Here's an example of how to set up the input for the Auction.com Scraper:
```json
{
"startUrls": [
"https://www.auction.com/residential/IL/Chicago_ct/active_lt/offer,direct_offer,remote_bid,in_person,online_af/auction_date_order,resi_sort_v2_st/y_fa/y_nbs/100_nsr",
"https://www.auction.com/details/638-e-91st-st-chicago-il-2037268"
],
"searchLimit": 500,
"sort": "auction_date_order,resi_sort_v2",
"nearbySearch": true,
"nearbySearchRadius": 50,
"requiresAggregation": true,
"maxItems": 1000,
"monitoringMode": false,
"maxConcurrency": 5,
"minConcurrency": 1,
"maxRequestRetries": 5,
"proxy": {
"useApifyProxy": true
}
}
````
#### Input Fields Explanation
- `startUrls`: Array of Auction.com URLs. Supported values include search URLs and direct property detail URLs. If provided, these URLs are used as-is.
- `propertyCategory`: Category used when building a search URL internally (for example, `residential`).
- `propertyState`: State code used when building a search URL (for example, `IL`).
- `propertyCity`: City used when building a search URL (for example, `Chicago`).
- `listingType`: Listing type used when building a search URL (for example, `active`).
- `assetEventTypes`: Sale format values used when building a search URL.
- `searchLimit`: Number of records requested per GraphQL search request.
- `sort`: Sort string sent to the GraphQL filters.
- `nearbySearch`: Controls the default GraphQL `nearby_search` value.
- `nearbySearchRadius`: Default nearby-search radius when the URL does not override it.
- `requiresAggregation`: Whether to request the aggregation block in the search response.
- `maxItems`: Maximum number of listings to emit.
- `monitoringMode`: When enabled, only emits listings not seen in previous runs.
- `maxConcurrency`: Maximum number of requests processed simultaneously.
- `minConcurrency`: Minimum number of requests processed simultaneously.
- `maxRequestRetries`: Number of retries for failed requests.
- `proxy`: Proxy settings for enhanced scraping reliability.
### Monitoring Mode
When `monitoringMode` is enabled, the scraper will only collect new listings that haven't been seen in previous runs. This is useful for:
- Tracking newly published or newly discovered property listings
- Building a historical archive of Auction.com inventory
- Monitoring cities or filter combinations without duplicating already-seen listings
#### How Monitoring Mode Works
1. The scraper maintains a record of previously scraped Auction.com listing IDs
2. On subsequent runs with `monitoringMode: true`, it checks each listing against this record
3. Only unseen listings are processed and added to the output
4. The record is updated with any new listing IDs found
### Output Structure
The scraper provides flattened Auction.com property listing records. The output includes listing identity, property attributes, auction timing, sale metadata, and useful booleans for filtering and analysis.
#### Sample JSON Output
```json
{
"id": "2037268",
"url": "https://www.auction.com/details/638-e-91st-st-chicago-il-2037268",
"primary_photo_url": "https://adc-tenbox-prod.imgix.net/resi/propertyImages/755499/755499_ext_1.v1.jpeg?auto=compress,format",
"address": "638 E 91ST ST, CHICAGO, IL 60619, COOK COUNTY",
"country_primary_subdivision": "IL",
"country_secondary_subdivision": "COOK",
"municipality": "CHICAGO",
"postal_code": "60619",
"street_description": "638 E 91ST ST",
"beds": 2,
"baths": 1,
"sqft": 846,
"lot_sqft": 0.07,
"year_built": 1922,
"property_type": "SINGLE_FAMILY_HOME",
"property_type_group": "SINGLE_FAMILY",
"opening_bid": 35000,
"est_resale_value": null,
"starting_bid_amount": 35000,
"auction_start_date": "2026-04-14T12:00:00Z",
"auction_end_date": "2026-04-16T14:10:30Z",
"saleType": "Bank Owned",
"auctionDate": "2026-04-14",
"auctionTime": "12:00",
"auctionLocation": "Online Auction",
"status": "Apr 14 - Apr 16, 2026",
"listing_photos_count": 5,
"is_third_party_online": null,
"is_reserve_displayed": null,
"broker_commission": null,
"financing_available": null,
"buyer_premium_available": false,
"interior_access_allowed": false,
"occupancy_status": "OCCUPIED",
"is_first_look_enabled": false,
"is_direct_offer_enabled": false,
"scrapedTimestamp": "2026-04-14T21:35:29.932Z"
}
```
### Output Fields Explanation
This section provides a detailed breakdown of all fields in the JSON output from the Auction.com Scraper. The output is a single flattened record per listing.
#### Listing Details
- `id` (String): Auction.com listing ID. Example: `"2037268"`.
- `url` (String): Full Auction.com detail page URL for the listing.
- `primary_photo_url` (String): Main listing photo URL.
- `address` (String): Combined one-line address including street, city, state, postal code, and county when available.
- `country_primary_subdivision` (String): State or primary subdivision code. Example: `"IL"`.
- `country_secondary_subdivision` (String): County name without the word `COUNTY`. Example: `"COOK"`.
- `municipality` (String): City/municipality in uppercase. Example: `"CHICAGO"`.
- `postal_code` (String): ZIP/postal code for the property.
- `street_description` (String): Street line of the property address in uppercase.
#### Property Attributes
- `beds` (Number|null): Number of bedrooms.
- `baths` (Number|null): Number of bathrooms. Can be an integer or decimal such as `1.5` or `2.5`.
- `sqft` (Number|null): Interior square footage.
- `lot_sqft` (Number|null): Lot size value as returned by Auction.com.
- `year_built` (Number|null): Year the property was built.
- `property_type` (String|null): Detailed structure type code such as `SINGLE_FAMILY_HOME`, `DUPLEX_BUILDING`, or `MULTI_UNIT_BUILDING`.
- `property_type_group` (String|null): Broader structure grouping such as `SINGLE_FAMILY` or `MULTI_FAMILY`.
#### Pricing And Valuation
- `opening_bid` (Number|null): Opening bid value from the listing auction block.
- `est_resale_value` (Number|null): Estimated resale/composite valuation when available.
- `starting_bid_amount` (Number|null): Starting bid amount, including online segment fallback when present.
#### Auction Timing
- `auction_start_date` (ISO 8601|null): Auction start timestamp in UTC.
- `auction_end_date` (ISO 8601|null): Auction end timestamp in UTC when available.
- `auctionDate` (String|null): Date portion derived from `auction_start_date` in `YYYY-MM-DD` format.
- `auctionTime` (String|null): Time portion derived from `auction_start_date` in `HH:MM` format.
- `auctionLocation` (String|null): Human-readable auction location, usually `Online Auction` or `Live Auction`.
- `status` (String|null): Auction.com status label shown in search results, for example `Apr 14 - Apr 16, 2026`, `Apr 28`, or `Coming Soon`.
#### Sale Classification
- `saleType` (String|null): Human-readable sale classification derived from Auction.com listing fields, for example `Bank Owned`, `Foreclosure`, or `Private Seller`.
#### Listing Configuration Flags
- `listing_photos_count` (Number|null): Number of photos available for the listing.
- `is_third_party_online` (Boolean|null): Whether the listing is handled as a third-party online sale.
- `is_reserve_displayed` (Boolean|null): Whether reserve information is displayed.
- `broker_commission` (Number|null): Broker commission amount or value when returned.
- `financing_available` (Boolean|null): Whether financing is available for the property.
- `buyer_premium_available` (Boolean|null): Whether a buyer premium applies.
- `interior_access_allowed` (Boolean|null): Whether interior access is allowed.
- `occupancy_status` (String|null): Occupancy state such as `OCCUPIED` or `VACANT`.
- `is_first_look_enabled` (Boolean|null): Whether first-look access is enabled.
- `is_direct_offer_enabled` (Boolean|null): Whether direct offers are enabled.
#### Scrape Metadata
- `scrapedTimestamp` (ISO 8601): Timestamp for when the actor produced the output row.
***
### Explore More Scrapers
If you found this Auction.com Scraper useful, be sure to check out our other scrapers and actors at [memo23's Apify profile](https://apify.com/memo23). We offer a wide range of tools to support web scraping, data collection, and automation across multiple sites and use cases.
### Support
- For issues or feature requests, please use the [Issues](https://console.apify.com/actors/7Fw4OYjfMapM6l49D/issues) section of this actor.
- If you need customization or have questions, feel free to contact the author:
- Author's website:
- Email:
### Additional Services
- Request customization or whole dataset:
- If you need anything else scraped, or this actor customized, email:
- For API services of this scraper (no Apify fee, just usage fee for the API), contact:
- Email: muhamed.didovic@gmail.com
# Actor input Schema
## `startUrls` (type: `array`):
Full Auction.com search URLs copied from your browser.
## `propertyCategory` (type: `string`):
Path segment before state, for example `residential`.
## `propertyState` (type: `string`):
Two-letter state code such as `IL`.
## `propertyCity` (type: `string`):
City name used in the URL and GraphQL filters, for example `Chicago`.
## `listingType` (type: `string`):
Listing type slug before `_lt`, for example `active`.
## `assetEventTypes` (type: `array`):
Auction modalities used in the final path segment. `offer` is automatically converted to `offer_af` in the URL.
## `searchLimit` (type: `integer`):
Number of results requested per GraphQL search call.
## `sort` (type: `string`):
GraphQL sort string used in the search request.
## `nearbySearch` (type: `boolean`):
Maps to the GraphQL `nearby_search` filter.
## `nearbySearchRadius` (type: `integer`):
Radius used when nearby search is enabled.
## `requiresAggregation` (type: `boolean`):
Include the aggregation block in the search GraphQL response.
## `maxItems` (type: `integer`):
Maximum number of listings that will be emitted.
## `monitoringMode` (type: `boolean`):
When enabled, only listings not seen in previous runs for the same user are emitted.
## `maxConcurrency` (type: `integer`):
Maximum number of requests processed at the same time.
## `minConcurrency` (type: `integer`):
Minimum number of requests processed at the same time.
## `maxRequestRetries` (type: `integer`):
Number of retries before a request is considered failed.
## `proxy` (type: `object`):
Specifies proxy servers that will be used by the scraper.
## Actor input object example
```json
{
"startUrls": [
"https://www.auction.com/residential/IL/Chicago_ct/active_lt/online,in_person,remote_bid,offer_af"
],
"propertyCategory": "residential",
"propertyState": "IL",
"propertyCity": "Chicago",
"listingType": "active",
"assetEventTypes": [
"online",
"in_person",
"remote_bid",
"offer"
],
"searchLimit": 500,
"sort": "auction_date_order,resi_sort_v2",
"nearbySearch": true,
"nearbySearchRadius": 50,
"requiresAggregation": true,
"maxItems": 1000,
"monitoringMode": false,
"maxConcurrency": 5,
"minConcurrency": 1,
"maxRequestRetries": 5,
"proxy": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
```
# API
You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.
## JavaScript example
```javascript
import { ApifyClient } from 'apify-client';
// Initialize the ApifyClient with your Apify API token
// Replace the '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"startUrls": [
"https://www.auction.com/residential/IL/Chicago_ct/active_lt/online,in_person,remote_bid,offer_af"
],
"propertyCategory": "residential",
"propertyState": "IL",
"propertyCity": "Chicago",
"listingType": "active",
"assetEventTypes": [
"online",
"in_person",
"remote_bid",
"offer"
],
"sort": "auction_date_order,resi_sort_v2",
"proxy": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
};
// Run the Actor and wait for it to finish
const run = await client.actor("memo23/auction-com-scraper").call(input);
// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
console.dir(item);
});
// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs
```
## Python example
```python
from apify_client import ApifyClient
# Initialize the ApifyClient with your Apify API token
# Replace '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = {
"startUrls": ["https://www.auction.com/residential/IL/Chicago_ct/active_lt/online,in_person,remote_bid,offer_af"],
"propertyCategory": "residential",
"propertyState": "IL",
"propertyCity": "Chicago",
"listingType": "active",
"assetEventTypes": [
"online",
"in_person",
"remote_bid",
"offer",
],
"sort": "auction_date_order,resi_sort_v2",
"proxy": {
"useApifyProxy": True,
"apifyProxyGroups": ["RESIDENTIAL"],
},
}
# Run the Actor and wait for it to finish
run = client.actor("memo23/auction-com-scraper").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
print(item)
# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"startUrls": [
"https://www.auction.com/residential/IL/Chicago_ct/active_lt/online,in_person,remote_bid,offer_af"
],
"propertyCategory": "residential",
"propertyState": "IL",
"propertyCity": "Chicago",
"listingType": "active",
"assetEventTypes": [
"online",
"in_person",
"remote_bid",
"offer"
],
"sort": "auction_date_order,resi_sort_v2",
"proxy": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}' |
apify call memo23/auction-com-scraper --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=memo23/auction-com-scraper",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "Auction.com [Only 💰$1 ] Search and Details Scraper",
"description": "[💰$1 per 1,000] No limits, no quotas, unlimited extraction. Auction.com scraper that extracts structured property listings from search URLs and filters. Get listing URLs, photos, address data, beds, baths, sqft, lot size, year built, bids, sale type, auction dates, occupancy, and property status",
"version": "0.0",
"x-build-id": "RCnPCU3iSc4cerVHQ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/memo23~auction-com-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-memo23-auction-com-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/memo23~auction-com-scraper/runs": {
"post": {
"operationId": "runs-sync-memo23-auction-com-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/memo23~auction-com-scraper/run-sync": {
"post": {
"operationId": "run-sync-memo23-auction-com-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": {
"startUrls": {
"title": "Auction.com search URLs",
"type": "array",
"description": "Full Auction.com search URLs copied from your browser.",
"items": {
"type": "string"
}
},
"propertyCategory": {
"title": "Property category",
"type": "string",
"description": "Path segment before state, for example `residential`."
},
"propertyState": {
"title": "Property state",
"type": "string",
"description": "Two-letter state code such as `IL`."
},
"propertyCity": {
"title": "Property city",
"type": "string",
"description": "City name used in the URL and GraphQL filters, for example `Chicago`."
},
"listingType": {
"title": "Listing type",
"type": "string",
"description": "Listing type slug before `_lt`, for example `active`."
},
"assetEventTypes": {
"title": "Asset event types",
"type": "array",
"description": "Auction modalities used in the final path segment. `offer` is automatically converted to `offer_af` in the URL.",
"items": {
"type": "string"
}
},
"searchLimit": {
"title": "GraphQL search limit",
"minimum": 1,
"type": "integer",
"description": "Number of results requested per GraphQL search call.",
"default": 500
},
"sort": {
"title": "Sort",
"type": "string",
"description": "GraphQL sort string used in the search request."
},
"nearbySearch": {
"title": "Enable nearby search",
"type": "boolean",
"description": "Maps to the GraphQL `nearby_search` filter.",
"default": true
},
"nearbySearchRadius": {
"title": "Nearby search radius",
"minimum": 1,
"type": "integer",
"description": "Radius used when nearby search is enabled.",
"default": 50
},
"requiresAggregation": {
"title": "Request aggregations",
"type": "boolean",
"description": "Include the aggregation block in the search GraphQL response.",
"default": true
},
"maxItems": {
"title": "Maximum items",
"minimum": 1,
"type": "integer",
"description": "Maximum number of listings that will be emitted.",
"default": 1000
},
"monitoringMode": {
"title": "Monitoring mode",
"type": "boolean",
"description": "When enabled, only listings not seen in previous runs for the same user are emitted.",
"default": false
},
"maxConcurrency": {
"title": "Max concurrency",
"type": "integer",
"description": "Maximum number of requests processed at the same time.",
"default": 5
},
"minConcurrency": {
"title": "Min concurrency",
"type": "integer",
"description": "Minimum number of requests processed at the same time.",
"default": 1
},
"maxRequestRetries": {
"title": "Max request retries",
"type": "integer",
"description": "Number of retries before a request is considered failed.",
"default": 5
},
"proxy": {
"title": "Proxy configuration",
"type": "object",
"description": "Specifies proxy servers that will be used by the scraper.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}
```