POST/v1/squids/{squid_hash}

Update Settings

Configure Bien'Ici Search Export scraper settings

Configure your Bien'Ici Search Export squid settings. Control pagination limits, filter by posting date, and manage sponsored listings collection.

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	Yes

Scraper Parameters

max_results

Type:

integer

Default:

Description:

Maximum number of results to collect per search URL (max: 2400)

max_pages

Type:

integer

Default:

100

Description:

Last page the crawler will visit during a run

max_unique_results_per_run

Type:

integer

Default:

null

Description:

Maximum unique results retrieved across all tasks in a run. Leave empty for unlimited

hours_back

Type:

integer

Default:

null

Description:

Only collect ads modified within the last N hours. Uses the modification_date field

collect_ads

Type:

boolean

Default:

false

Description:

If false, will NOT collect sponsored listings

Squid Settings

name

Type:

string

Description:

Display name for your squid configuration

concurrency

Type:

integer

Description:

Number of parallel scraping threads (default: 1, max: 20)

export_unique_results

Type:

boolean

Description:

Export only unique results (deduplicated)

to_complete

Type:

boolean

Description:

Run until all tasks complete

no_line_breaks

Type:

boolean

Description:

Remove line breaks from results

Pro Tip

Use `hours_back` to only collect recently modified listings - perfect for monitoring new properties in your target area.

Warning

Setting `max_results` too high may increase run time and credit usage. Start with smaller values and increase as needed.

Note

The `collect_ads` parameter controls whether sponsored/promoted listings are included in results. Set to `true` if you want to analyze advertising patterns.

Pro Tip

Enable `export_unique_results` to automatically deduplicate listings that appear in multiple search results.