Estimate a list
estimate_listRows, cost in credits and balance after, for a list of N rows of a search (up to 50,000). Tell the user the cost, then send "cost" as maxCredits to create_list with the same search, rows and withEmail. In a rarely searched area it returns kind "zone": the list fills itself after creation (create_list with maxCredits ≥ zoneEstimate.creditCap).
Free.
Same call as POST /api/v1/search/estimate of the REST API.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"search": "<search>"
},
"name": "estimate_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | Rows wanted in the list (default 500, at most 50000). | |
| search | Yes | The search, as returned by POST /categories/suggest (field "search"). Send it back as is, edited if needed. The "search" object returned by suggest_categories (target, area, filters, sort), sent as is or edited; its full schema is the "search" input of count_search. An invalid search is refused with invalid_request and the fields to fix. | |
| withEmail | No | True: a list of places WITH an email address (found addresses first, then guessed and checked ones, each address checked at 1 credit). False: the email filter is removed. Absent: the search as is. |