SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Local searches, location pages and whether your business details agree.

Applies when people find you with local searches or your pages mark up a local business. Lists local searches, location pages and every business name, phone number and address your markup shows, with plain notes where they disagree. Spends no SoftSolz AI credits.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/local

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

appliesbooleanTrue when local search matters for this website.
local_queriesarray of objectsLocal searches, most shown first.
location_pagesarray of objectsPages about a location.
napobjectBusiness name, phone and address found in markup.
evaluated_atstring | nullWhen the pages were last read.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/local \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"applies": true,
"local_queries": [
{
"query": "boiler service near me",
"impressions": 800,
"clicks": 20,
"position": 7.1
}
],
"location_pages": [
{
"url": "https://example.com/contact",
"has_local_markup": true
}
],
"nap": {
"names": [
"Acme Heating"
],
"phones": [
"0113 496 0000"
],
"addresses": [
"1 High Street, Leeds, LS1 1AA"
],
"consistent": true,
"issues": []
},
"evaluated_at": null
}
}