API Reference

The NexGeo.ai API lets you programmatically access your visibility data, trigger scans, and retrieve analytics.

Base URL

https://your-domain.com/api/v1

All API requests require an API key. Generate one from the Developers page in your dashboard.

Pass the key via the X-API-Key header:

Shell

curl https://your-domain.com/api/v1/products \
  -H "X-API-Key: apin_your_key_here"

Alternatively, use the Authorization header with a Bearer token:

Authorization: Bearer apin_your_key_here

API keys are created with specific scopes that control what operations they can perform:

Scope	Permissions
`read`	List products, scans, analytics
`write`	Trigger scans, update products
`admin`	Full access including key management

API requests are rate-limited per API key:

Errors return a JSON object with an error field:

JSON

{
  "error": "Invalid API key"
}