List local business insights
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/local \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/local"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/local', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"pagination": {
"total": 123,
"count": 123,
"limit": 123,
"offset": 123
},
"local": [
{
"id": "<string>",
"businessName": "<string>",
"category": "<string>",
"address": "<string>",
"websiteUrl": "<string>",
"position": 123,
"rating": 123,
"reviewCount": 123,
"prompt": "<string>",
"createdAt": "<string>"
}
]
}Signals
List local business insights
List local business observations extracted from stored answers.
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
local
List local business insights
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/local \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/local"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/local', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"pagination": {
"total": 123,
"count": 123,
"limit": 123,
"offset": 123
},
"local": [
{
"id": "<string>",
"businessName": "<string>",
"category": "<string>",
"address": "<string>",
"websiteUrl": "<string>",
"position": 123,
"rating": 123,
"reviewCount": 123,
"prompt": "<string>",
"createdAt": "<string>"
}
]
}Returns local business observations extracted from stored answers. Each record is an observation, not a verified recommendation or current business listing.
string
required
Bearer token. Example:
Bearer qw-api-xxxGET /api/v1/brands/{brandId}/local
Path parameters
string
required
The unique identifier of the brand
Query parameters
number
Number of days to include. If not specified, returns all data.
string
Start date in
YYYY-MM-DD. Provide it with endDate; a lone boundary is currently ignored. Choose either period or the complete date pair.string
End date in
YYYY-MM-DD. Provide it with startDate; a lone boundary is currently ignored. Do not combine the complete date pair with period.string
Filter by one or more provider aliases or model IDs, separated by commas.
string
Filter by business category (case-insensitive partial match)
number
default:"50"
Maximum number of businesses to return (max: 100)
number
default:"0"
Number of results to skip for pagination
string
default:"createdAt"
Field to sort by:
createdAt, rating, reviewCount, position, businessNamestring
default:"desc"
Sort order:
asc or descResponse
boolean
Indicates if the request was successful
object
array
Show Local business object
Show Local business object
Synthetic request
curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/local?category=restaurant&limit=10" \
-H "Authorization: Bearer qw-api-your-token-here"
Synthetic response
{
"success": true,
"pagination": {
"total": 42,
"count": 2,
"limit": 10,
"offset": 0
},
"local": [
{
"id": "loc1",
"businessName": "Northstar Café",
"category": "Café",
"address": "10 Example Street, Paris",
"websiteUrl": "https://cafe.northstar.example",
"position": 1,
"rating": 4.8,
"reviewCount": 2500,
"prompt": "Which cafés are mentioned near the example district?",
"createdAt": "2026-07-15T10:30:00Z"
},
{
"id": "loc2",
"businessName": "Orbit Bistro",
"category": "Restaurant",
"address": "20 Example Avenue, Paris",
"websiteUrl": "https://bistro.orbit.example",
"position": 2,
"rating": 4.5,
"reviewCount": 1800,
"prompt": "Which cafés are mentioned near the example district?",
"createdAt": "2026-07-15T10:30:00Z"
}
]
}
Errors
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_PARAMETER | Invalid filter, pagination, or sort value |
| 401 | gateway error | Authentication failed |
| 404 | BRAND_NOT_FOUND | Brand doesn’t exist or not accessible |
| 429 | gateway error | Rate limit exceeded; honor Retry-After |