Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neariq.io/llms.txt

Use this file to discover all available pages before exploring further.

​
GET /me

Returns your business profile. 
curl https://app.neariq.io/api/v1/me \
  -H "X-NearIQ-Key: niq_your_key_here"

{
  "id": "biz_abc123",
  "name": "Joe's Pizza",
  "address": "123 Main St, New York, NY 10001",
  "rating": 4.6,
  "reviewCount": 312,
  "category": "Pizza restaurant",
  "googlePlaceId": "ChIJ...",
  "website": "https://joespizza.com",
  "phone": "+12125551234"
}

​
GET /me/snapshots

Daily rating and review count history for trend analysis. 
curl "https://app.neariq.io/api/v1/me/snapshots?limit=30" \
  -H "X-NearIQ-Key: niq_your_key_here"
Query parameters
ParameterTypeDefaultDescription
limitinteger90Number of most-recent snapshots (max 365)
fromISO date-Inclusive start date filter
toISO date-Inclusive end date filter. Date-only values include the full day.
{
  "snapshots": [
    { "checkedAt": "2026-04-27T06:00:00Z", "rating": 4.6, "reviewCount": 312 },
    { "checkedAt": "2026-04-26T06:00:00Z", "rating": 4.6, "reviewCount": 310 }
  ]
}

​
GET /me/reviews

Paginated list of your Google reviews. 
curl "https://app.neariq.io/api/v1/me/reviews?limit=20&sort=newest" \
  -H "X-NearIQ-Key: niq_your_key_here"
Query parameters
ParameterTypeDefaultDescription
limitinteger50Reviews to return (max 200)
sortstringnewestnewest, oldest, highest, or lowest
Review text is refreshed when available. If text is being refreshed, text is null and reviewTextStatus is loading; rating, author, date, and other metadata remain available. 
{
  "reviews": [
    {
      "rating": 5,
      "text": null,
      "author": "A Google user",
      "publishedAt": "2026-04-18T06:00:00Z",
      "ownerResponse": null,
      "reviewTextStatus": "loading"
    }
  ]
}

​
GET /me/gbp-health

Your Google Business Profile health score and breakdown. 
curl https://app.neariq.io/api/v1/me/gbp-health \
  -H "X-NearIQ-Key: niq_your_key_here"

{
  "score": 84,
  "maxScore": 100,
  "checks": [
    { "key": "photos", "label": "Photos on listing", "done": true, "points": 20 }
  ]
}