Introduction

Build custom dashboards, integrate with your marketing stack, or create automated reports using your GEO (Generative Engine Optimization) data.

The API is available for Growth, Business, and Enterprise plans. Upgrade your plan to get access.

Base URL

All API endpoints are relative to:

https://www.qwairy.co/api/v1

The API provides access to all your GEO monitoring data:

Resource	Description
Brands	List all brands in your account
Performance	Get performance snapshots (Audit FLASH format)
Competitors	Track competitor mentions and share of voice
Source Domains	Monitor domains cited by AI platforms
Source URLs	Track individual pages cited in AI responses
Prompts	Access your monitored prompts/queries
Answers	Retrieve AI-generated responses
Search	Discover web queries AI models trigger before responding

Get your API token

Go to Team Settings → Integrations → API Access and create a new API token.

Make your first request

curl -X GET "https://www.qwairy.co/api/v1/brands" \
  -H "Authorization: Bearer qw-api-your-token-here"

Explore your data

Use the brand ID to access performance metrics, competitors, sources, and more.

All responses are JSON formatted with a consistent structure:

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 10,
    "limit": 10,
    "offset": 0
  },
  "prompts": [ ... ]
}

List endpoints include a pagination object with:

See Entities for detailed data structures. Error responses include machine-readable codes:

{
  "error": {
    "code": "BRAND_NOT_FOUND",
    "message": "Brand not found or not accessible"
  }
}

See Error Codes for the complete list.