Skip to main content
The NearIQ REST API lets you pull competitor data, alerts, snapshots, and reviews directly into your own tools. To authenticate API requests you need an API key, which you create from your account settings.
API access is available on Growth and above. The number of keys you can create depends on your plan:
PlanAPI keys
Growth1 key
Agency5 keys
Enterprise10 keys
ScaleUnlimited
UnlimitedUnlimited
If you are on the Starter plan or free trial, upgrade to Growth or higher to enable API access.

​
Create an API key

1

Open Settings

Go to neariq.io/settings and select API from the left sidebar. This opens the API keys section.
2

Create a new key

Click Create key (or the + button if you already have keys). Give your key a name that identifies where it will be used — for example, Production app or Analytics pipeline. Then click Create.NearIQ will display the full key once immediately after creation. Copy it and store it somewhere safe — you will not be able to view the key value again after leaving this screen.
3

Copy and store the key

Your API key will look like this:
niq_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Store it in an environment variable or secrets manager. Do not commit it to version control.

​
Authenticate requests

You can authenticate API requests using either of these methods: 
curl https://neariq.io/api/v1/me \
  -H "X-NearIQ-Key: niq_live_YOUR_KEY"
Both methods are equivalent. The X-NearIQ-Key header is the recommended approach and what the official SDK uses by default.

​
Verify your key

Use the /me endpoint to confirm your key is working. A successful response returns your business profile: 
curl https://neariq.io/api/v1/me \
  -H "X-NearIQ-Key: niq_live_YOUR_KEY"
A 200 OK response confirms your key is valid and your account is active.

​
Manage your keys

From Settings → API you can:
  • Rename a key — update the label to reflect where the key is being used
  • See last used — NearIQ shows the last time each key was used to make a request, which helps you identify stale or unused keys
  • Revoke a key — click the revoke button next to any key to permanently disable it; requests using that key will immediately start returning 401 Unauthorized
Revoking a key is permanent. Any application or integration using the key will stop working immediately. Create a replacement key before revoking if you need to rotate credentials without downtime.

​
Keep your keys secure

Treat your API keys like passwords. Never commit them to version control, include them in client-side code, or share them in public channels.
Best practices for keeping your keys safe:
  • Store keys in environment variables (NEARIQ_API_KEY) rather than hardcoding them
  • Use a secrets manager (AWS Secrets Manager, HashiCorp Vault, Doppler, etc.) in production environments
  • Create separate keys for separate environments — for example, one key for production and one for staging
  • Revoke any key you suspect has been exposed and create a replacement immediately

​
Next steps

API reference

Full documentation for every REST endpoint, including parameters, response shapes, and examples.

JavaScript SDK

Use the official @neariq/sdk package to interact with the API from Node.js or browser environments.