GETapi.synup.com/api/v4/local-post-ideas/scraped-context
Local scraped context
Returns the context scraped from the location's website that grounds post-idea generation — business name/description, services, products, pricing, brand colors/logo, tone, and target customers.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | required | Relay-encoded location ID. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Synup-Version | string | required | API version date (YYYY-MM-DD). |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/local-post-ideas/scraped-context?locationId=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/local-post-ideas/scraped-context?locationId=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/local-post-ideas/scraped-context?locationId=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/local-post-ideas/scraped-context?locationId=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successful response |
401 | Unauthorized - Invalid or missing API key |
Example response (generated from the schema)
{
"data": {
"localScrapedContext": {
"id": "string",
"locationId": 0,
"businessName": "string",
"category": "string",
"businessDescription": "string",
"location": "string",
"services": {},
"products": {},
"subcategories": {},
"pricing": {},
"availability": {},
"uniqueSellingPoints": {},
"tone": "string",
"targetCustomers": "string",
"scrapedImages": {},
"insights": {},
"brandPrimaryColor": "string",
"brandSecondaryColor": "string",
"brandLogoUrl": "string",
"scrapedContext": "string",
"visualContext": {}
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.localScrapedContext | object | optional | |
data.localScrapedContext.id | string | optional | |
data.localScrapedContext.locationId | integer | optional | |
data.localScrapedContext.businessName | string | optional | |
data.localScrapedContext.category | string | optional | |
data.localScrapedContext.businessDescription | string | optional | |
data.localScrapedContext.location | string | optional | |
data.localScrapedContext.services | object | optional | Free-form JSON. |
data.localScrapedContext.products | object | optional | Free-form JSON. |
data.localScrapedContext.subcategories | object | optional | Free-form JSON. |
data.localScrapedContext.pricing | object | optional | Free-form JSON. |
data.localScrapedContext.availability | object | optional | Free-form JSON. |
data.localScrapedContext.uniqueSellingPoints | object | optional | Free-form JSON. |
data.localScrapedContext.tone | string | optional | |
data.localScrapedContext.targetCustomers | string | optional | |
data.localScrapedContext.scrapedImages | object | optional | Free-form JSON. |
data.localScrapedContext.insights | object | optional | Free-form JSON. |
data.localScrapedContext.brandPrimaryColor | string | optional | |
data.localScrapedContext.brandSecondaryColor | string | optional | |
data.localScrapedContext.brandLogoUrl | string | optional | |
data.localScrapedContext.scrapedContext | string | optional | |
data.localScrapedContext.visualContext | object | optional | Free-form JSON. |