Skip to main content
The /me family of endpoints gives you programmatic access to everything NearIQ knows about your own business: your Google Business Profile data, tracked competitors, alert history, rating snapshots, reviews, and profile health score.

​
GET /api/v1/me

Returns your business profile, including your Google listing details, current rating, review count, and account plan. 
curl https://neariq.io/api/v1/me \
  -H "X-NearIQ-Key: niq_live_..."

​
Response fields

​
id
string
required
Unique identifier for your business record.
​
name
string
required
Your business name.
​
category
string
Primary Google Business Profile category (e.g., "Pizza restaurant").
​
address
string
Street address as stored on your Google listing.
​
website
string
Website URL from your Google listing.
​
phone
string
Phone number from your Google listing.
​
googlePlaceId
string
Your Google Maps Place ID (e.g., "ChIJN1t_tDeuEmsRUsoyG83frY4").
​
rating
number
Current Google rating (1.0–5.0).
​
reviewCount
number
Total number of Google reviews.
​
plan
string
Your NearIQ subscription plan (e.g., "growth", "trial", "expired").
​
createdAt
string
required
ISO 8601 timestamp of when your account was created.
​
updatedAt
string
ISO 8601 timestamp of the last profile update.

​
GET /api/v1/me/competitors

Returns your list of tracked competitors, sorted by health score by default. 
curl "https://neariq.io/api/v1/me/competitors?sort=rating_desc" \
  -H "X-NearIQ-Key: niq_live_..."

​
Request parameters

​
sort
string
default:"score_desc"
Sort order. One of score_desc, score_asc, name, or rating_desc.

​
Response fields

​
count
number
required
Total number of tracked competitors returned.
​
competitors
object[]
required

​
GET /api/v1/me/alerts

Returns recent alerts for your account, such as rating drops, review spikes, and competitor changes. 
curl "https://neariq.io/api/v1/me/alerts?unread=true&limit=20" \
  -H "X-NearIQ-Key: niq_live_..."

​
Request parameters

​
limit
number
default:"50"
Maximum number of alerts to return. Maximum value is 200.
​
unread
boolean
default:"false"
When true, returns only alerts that have not been read.
​
type
string
Filter by alert type, for example rating_drop or hours_change. See the Alerts reference for all types.

​
Response fields

​
count
number
required
Number of alerts returned.
​
alerts
object[]
required

​
GET /api/v1/me/snapshots

Returns historical rating and review-count snapshots for your business. Each snapshot is a point-in-time data capture by NearIQ. 
curl "https://neariq.io/api/v1/me/snapshots?limit=30" \
  -H "X-NearIQ-Key: niq_live_..."

​
Request parameters

​
limit
number
default:"90"
Number of most-recent snapshots to return. Maximum is 365.
​
from
string
Inclusive start date filter. ISO date string (e.g., 2025-01-01).
​
to
string
Inclusive end date filter. ISO date string (e.g., 2025-03-31).

​
Response fields

​
business
object
required
​
count
number
required
Number of snapshots returned.
​
snapshots
object[]
required

​
GET /api/v1/me/reviews

Returns your Google reviews along with AI sentiment analysis, rating distribution, and owner response rate. Reviews are served from NearIQ’s cache. 
curl https://neariq.io/api/v1/me/reviews \
  -H "X-NearIQ-Key: niq_live_..."

​
Response fields

​
reviews
object[]
required
​
sentiment
object
AI-generated sentiment analysis. null if not available or plan does not support it.
​
ratingDistribution
object
Map of star rating (1–5) to review count. null if unavailable.
​
ownerResponseRate
number
Fraction of reviews with an owner response (0.0–1.0). null if unavailable.
​
source
string
Data source used: serp, places, or cache.
​
fromCache
boolean
true when the response was served from NearIQ’s local cache.

​
GET /api/v1/me/gbp-health

Returns a completeness score and pass/fail checklist for your Google Business Profile. 
curl https://neariq.io/api/v1/me/gbp-health \
  -H "X-NearIQ-Key: niq_live_..."

​
Response fields

​
score
number
required
Overall health score from 0 to 100.
​
checks
object[]
required