JavaScript / TypeScript

npm install @neariq/sdk

import { NearIQ } from '@neariq/sdk'

const client = new NearIQ({ apiKey: process.env.NEARIQ_API_KEY! })

// Get your business profile
const biz = await client.me.get()
console.log(biz.name, biz.rating)

// List tracked competitors
const { data, count } = await client.me.competitors({ limit: 10 })
console.log(`Tracking ${count} competitors`)

// Check AI search visibility
const vis = await client.aiVisibility({ days: 30 })
console.log(`AI visibility: ${vis.score}%`)

// Get competitive gap analysis
const gaps = await client.gapAnalysis()
console.log(gaps.analysis)

const me = await client.me.get()
const competitors = await client.me.competitors({ limit: 20, offset: 0 })
const alerts = await client.me.alerts({ severity: 'warning', limit: 10 })
const snapshots = await client.me.snapshots({ days: 90 })
const reviews = await client.me.reviews()
const health = await client.me.gbpHealth()

const detail = await client.competitors.get('competitor-uuid')
const history = await client.competitors.snapshots('competitor-uuid', { days: 30 })
const reviews = await client.competitors.reviews('competitor-uuid')

const visibility = await client.aiVisibility({ days: 30 })
const signals = await client.behavioralSignals()
const gaps = await client.gapAnalysis()
const insights = await client.gbpInsights({ days: 30 })
const ranks = await client.rankChecks({ keyword: 'pizza', limit: 10 })
const citations = await client.citations()
const trends = await client.market({ period: 'last_30_days' })
const leaders = await client.leaderboard({ city: 'Austin', sort: 'rating' })

const content = await client.content({ limit: 10, type: 'faq' })
const agents = await client.agents.list()

const list = await client.webhooks.list()
const created = await client.webhooks.create({
  url: 'https://example.com/webhook',
  events: ['competitor.rating_change', 'own.rating_change']
})
await client.webhooks.update(created.id, { active: false })
await client.webhooks.delete(created.id)

const usage = await client.usage()
const exported = await client.export({ include: 'business,competitors,alerts' })

import { NearIQ, type NearIQError } from '@neariq/sdk'

try {
  await client.me.get()
} catch (err) {
  const e = err as NearIQError
  if (e.status === 401) console.log('Invalid API key')
  if (e.status === 403) console.log('Plan upgrade required')
  if (e.status === 429) console.log('Rate limited — slow down')
}

const res = await fetch('https://neariq.io/api/v1/me', {
  headers: { 'X-NearIQ-Key': process.env.NEARIQ_API_KEY! }
})
const data = await res.json()