# NearIQ

## Docs

- [Account setup: create and manage your NearIQ API keys](https://docs.neariq.io/account-setup.md): Create a NearIQ API key, authenticate REST API requests using your key or a Bearer token, and manage or revoke keys from the Settings page.
- [GET /api/v1/me/alerts — query and filter NearIQ alerts](https://docs.neariq.io/api/alerts.md): Query NearIQ alerts for rating drops, review surges, and hours changes. Filter by severity, type, or read status. Each alert may include an AI recommendation.
- [Authenticate NearIQ API requests with your API key](https://docs.neariq.io/api/authentication.md): Pass your NearIQ API key via the X-NearIQ-Key header or Authorization Bearer scheme. Every request to the API requires a valid key.
- [Competitor endpoints: profiles, snapshots, reviews](https://docs.neariq.io/api/competitors.md): Fetch full competitor profiles, historical rating snapshots, and Google reviews with AI sentiment for any competitor you track in NearIQ.
- [NearIQ REST API error responses and HTTP status codes](https://docs.neariq.io/api/errors.md): Every NearIQ API error returns JSON with an error field. Learn what each HTTP status code means and how to handle auth failures and validation errors.
- [Export and usage endpoints — bulk data and API stats](https://docs.neariq.io/api/export.md): Bulk-export your NearIQ account data as JSON and retrieve API usage statistics including your plan, competitor count, alert volume, and API key activity.
- [My business endpoints: profile, alerts, and reviews](https://docs.neariq.io/api/me.md): Retrieve your business profile, tracked competitors, alerts, rating snapshots, Google reviews, and GBP health score via the NearIQ REST API.
- [Webhook endpoints: register, update, and delete via API](https://docs.neariq.io/api/webhooks.md): Register HTTP endpoints to receive real-time NearIQ event payloads. Manage webhooks via the API and verify incoming deliveries with HMAC-SHA256 signatures.
- [Plans & pricing](https://docs.neariq.io/billing/plans.md): Compare NearIQ plans — from solo businesses to enterprise agencies. Every plan starts with a 7-day free trial.
- [Team workspaces: share competitor data with your team](https://docs.neariq.io/billing/team-workspaces.md): Create a shared NearIQ competitor workspace, invite teammates by email, assign roles and permissions, and run multiple workspaces on Scale and Unlimited plans.
- [Changelog](https://docs.neariq.io/changelog.md): What's new in NearIQ — features, improvements, and fixes.
- [Alerts: track competitor rating, review, and listing changes](https://docs.neariq.io/dashboard/alerts.md): NearIQ automatically detects rating drops, review surges, hours changes, and more. Learn how alerts are generated, what each type means, and how to act on them.
- [Track and analyze local competitors on Google Maps](https://docs.neariq.io/dashboard/competitors.md): Add competitors manually or with Find Nearby, explore per-competitor data including ratings, review velocity, health scores, and detailed history charts.
- [Map and market intelligence: leaderboard and trends](https://docs.neariq.io/dashboard/market-intelligence.md): View tracked competitors on an interactive map, explore area-wide leaderboards, market trends, and competitor density in your industry category.
- [NearIQ dashboard overview: tabs, sidebar, and layout](https://docs.neariq.io/dashboard/overview.md): A tour of the NearIQ dashboard — sidebar navigation, all eleven tabs, the health score, theme toggle, multi-location switcher, and the ⌘K search palette.
- [Rank Tracker: monitor your local Google Maps position](https://docs.neariq.io/dashboard/rank-tracker.md): Track where your business ranks on Google Maps for any keyword across a geographic grid. Run checks, compare results over time, and identify coverage gaps.
- [Reviews: analyse and respond to your Google reviews](https://docs.neariq.io/dashboard/reviews.md): Browse your own Google reviews, view AI sentiment analysis and rating distribution, track your response rate, and draft replies — all from the Reviews tab.
- [Introduction to NearIQ: local competitor monitoring](https://docs.neariq.io/introduction.md): NearIQ tracks your Google Maps competitors and alerts you when ratings, reviews, hours, or listings change — so you know what your competitors are up to.
- [Configure NearIQ email alerts and digest notifications](https://docs.neariq.io/notifications/email-alerts.md): Set up NearIQ email alerts for competitor changes. Choose real-time or digest delivery, set a severity threshold, and pick which alert types to receive.
- [Deliver NearIQ alerts to Slack, Discord, or Microsoft Teams](https://docs.neariq.io/notifications/slack-discord.md): Send NearIQ competitor alerts to Slack, Discord, or Microsoft Teams channels. Configure per-channel alert filters and digest schedules for each destination.
- [NearIQ webhooks: receive real-time competitor events](https://docs.neariq.io/notifications/webhooks.md): Register HTTP endpoints to receive real-time NearIQ event payloads. Use webhooks to trigger automations, push data to a CRM, or connect Zapier workflows.
- [Quickstart: track your first competitor in under 5 min](https://docs.neariq.io/quickstart.md): Sign up for NearIQ, enter your business details, link your Google Maps listing, and start monitoring your first competitor — all in under five minutes.
- [Install and initialize the @neariq/sdk JavaScript package](https://docs.neariq.io/sdk/installation.md): Install @neariq/sdk via npm, yarn, or pnpm, initialize the NearIQ client with your API key, and handle errors with the built-in NearIQError type.
- [NearIQ JavaScript SDK: full method reference and types](https://docs.neariq.io/sdk/reference.md): Full TypeScript method signatures and working code examples for every NearIQ SDK method: me, competitors, webhooks, export, usage, and all exported types.