Skip to main content

​
Base URL

https://app.neariq.io/api/v1

​
Who should use the API

The NearIQ API is designed for:
  • Agencies running GBP optimization for multiple clients who want to pull NearIQ data into their own reporting dashboards
  • Developers building tools that integrate competitive intelligence (e.g. a custom alert pipeline, CRM integration, or automated reporting)
  • Power users who want to export and analyze data beyond what the dashboard shows
The API requires a Growth plan or higher. Some provider-backed endpoints require premium API access and may have additional daily safeguards. NearIQ is not trying to replace a full sales CRM. The API, webhooks, Zapier actions, leads, conversations, review requests, and reminders are meant to connect local-marketing activity into the CRM your team already uses. NearIQ should own the local growth intelligence and automation layer; your CRM should remain the system of record for long sales pipelines, contracts, and customer lifecycle management.

​
What’s available

The API gives you read access to:
  • Your business profile and health score
  • All tracked competitors and their snapshots
  • Alerts and alert history
  • Reviews for your business and competitors
  • Products, services, pricing evidence, and competitor product gaps where stored
  • Leads, conversations, review requests, and publishing targets
  • Usage statistics and API key management
Plus webhook registration for real-time event delivery.

​
Rate limits

PlanRequests / minute
Growth30
Agency60
Enterprise120
Scale120
Unlimited300
Limits apply per API key. Plan-level key count caps still apply, so use separate keys for separate integrations and revoke leaked keys individually. All endpoints return standard HTTP status codes. See Errors for the full reference.

​
Getting your API key

  1. Go to Settings → API in the dashboard
  2. Click Generate API key
  3. Copy the key — it won’t be shown again
Keys start with niq_ and are scoped to your account. You can generate multiple keys and revoke them individually.

​
API playground

Every endpoint page in this documentation has a built-in API playground on the right side of the page. To use it:
  1. Click any endpoint in the sidebar (e.g. Your Business, Competitors)
  2. On the right side of the page, you’ll see the “Try it” panel
  3. Paste your API key in the X-NearIQ-Key field
  4. Fill in any required parameters
  5. Click Send to make a live API call and see the response
On mobile or narrow screens, the playground panel appears below the documentation content instead of on the right side. Scroll down to find it.
The playground makes real API calls to https://app.neariq.io/api/v1 — you need an active API key from a Growth plan or higher.