This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.
Pricing: 1 credit per 25 returned reviews. Credits are charged on actual returned results, not requested limit.
You must provide one listing identifier: cid, place_id, or fid.
Body parameters
cid· optionalstring
Optional Google CID.
place_id· optionalstring
Optional Google place ID.
fid· optionalstring
Optional provider listing ID.
sort_by· optionalstring
Review ordering. Default: newest.
limit· optionalinteger
Maximum reviews to return. Default: 25. Range: 1–100.
country· optionalstring
Country code. Default: us.
language· optionalstring
Language code. Default: en.
next_page_token· optionalstring
Optional provider continuation token.
page· optionalinteger
Page number. Default: 1; must be at least 1.
| Name | Type | Description |
|---|---|---|
| cid | string | Optional Google CID. |
| place_id | string | Optional Google place ID. |
| fid | string | Optional provider listing ID. |
| sort_by | string | Review ordering. Default: newest. |
| limit | integer | Maximum reviews to return. Default: 25. Range: 1–100. |
| country | string | Country code. Default: us. |
| language | string | Language code. Default: en. |
| next_page_token | string | Optional provider continuation token. |
| page | integer | Page number. Default: 1; must be at least 1. |
Errors
| Status | Meaning |
|---|---|
| 400 | The search/provider rejected the request. |
| 422 | At least one of cid, place_id, or fid is required; typed range validation failed. |
| 401 | Invalid API key or missing auth. |
| 403 | Missing search:run scope. |
