JSON POST request example
POST to https://api.litescrape.com/api/zillow/locations with Content-Type: application/json and your Authorization: Bearer header.
{
"q": "Seattle, WA",
"type": "regions",
"limit": 5
}// request reference
Zillow Locations parameters
Send query parameters with GET /api/zillow/locations. 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
Find Zillow region and address suggestions with opaque page tokens.
qCity, ZIP code, neighborhood or street address. Required on the first page; omit with page_token.
Type string · GET query or POST JSON
- Minimum characters: 1
- Maximum characters: 200
typeFind regions or addresses. Defaults to regions; omit with page_token.
Type string · GET query or POST JSON
regionsaddresses- Region suggestions include Zillow region IDs. Address suggestions return names; this route does not return property ZPIDs or coordinates.
limitSuggestions per page, from 1 to 100. Defaults to 10; omit with page_token.
Type integer · GET query or POST JSON
- Follow pagination.next or send pagination.next_page_token as page_token. Each lookup supports up to 1,000 suggestions; if pagination.possibly_truncated is true, refine q.
- Minimum: 1
- Maximum: 100
page_tokenOpaque next_page_token from the preceding response. Send it alone to continue the same lookup.
Type string · GET query or POST JSON
- Continue the same query, suggestion type and page size without repeating previously returned suggestions. If pagination.next is null while has_more is true, send page_token through POST JSON.
- Minimum characters: 1
- Maximum characters: 32768
// 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, locations, pagination, 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.
{
"search_metadata": {
"id": "zillow-locations-example",
"status": "Success",
"url": "https://api.litescrape.com/api/zillow/locations",
"total_time_taken": 0.185
},
"search_parameters": {
"q": "Seattle, WA",
"type": "regions",
"limit": 5
},
"locations": [
{
"name": "Seattle, WA",
"type": "Region",
"region_id": 16037,
"region_type": "city",
"city": "Seattle",
"state": "WA",
"county": "King County"
},
{
"name": "West Seattle, WA",
"type": "Region",
"region_id": 27881,
"region_type": "flex_region",
"city": "Seattle",
"state": "WA",
"county": "King County"
},
{
"name": "Capitol Hill, Seattle, WA",
"type": "Region",
"region_id": 250206,
"region_type": "neighborhood",
"city": "Seattle",
"state": "WA",
"county": "King County"
},
{
"name": "98103",
"type": "Region",
"region_id": 99563,
"region_type": "zipcode",
"city": "Seattle",
"state": "WA",
"county": "King County",
"zipcode": "98103"
},
{
"name": "98115",
"type": "Region",
"region_id": 99575,
"region_type": "zipcode",
"city": "Seattle",
"state": "WA",
"county": "King County",
"zipcode": "98115"
}
],
"pagination": {
"current_page": 1,
"has_more": true,
"next_page_token": "zl2.eyJ2ZXJzaW9uIjoxLCJxIjoiU2VhdHRsZSwgV0EiLCJ0eXBlIjoicmVnaW9ucyIsImxpbWl0Ijo1LCJvZmZzZXQiOjUsInNlZW4iOlsiMDFkNWE4NGFhYjIwMmNjNSIsIjU2ZWEzYzI5NTE0OGJkYzAiLCI0NjlmNmViNmFiYzE5N2U3IiwiMGU2NDlhNjE0MDk3ZjhlMCIsImViN2I3NTgwZTMzN2IyZjIiXX0",
"next": "https://api.litescrape.com/api/zillow/locations?page_token=zl2.eyJ2ZXJzaW9uIjoxLCJxIjoiU2VhdHRsZSwgV0EiLCJ0eXBlIjoicmVnaW9ucyIsImxpbWl0Ijo1LCJvZmZzZXQiOjUsInNlZW4iOlsiMDFkNWE4NGFhYjIwMmNjNSIsIjU2ZWEzYzI5NTE0OGJkYzAiLCI0NjlmNmViNmFiYzE5N2U3IiwiMGU2NDlhNjE0MDk3ZjhlMCIsImViN2I3NTgwZTMzN2IyZjIiXX0",
"possibly_truncated": false
},
"submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}