API Reference

Access brand data, ad creatives, and analytics programmatically. Build integrations, dashboards, or custom tools on top of Proven SaaS.

Authentication

Include your API key in requests:

x-api-key: YOUR_API_KEYor?api_key=YOUR_API_KEY

Credit costs: /brands = 1, /brands/:id = 1, /brands/:id/ads = 2, /status = 0 (free)

GET/brands

1 credit

Search and filter brands by category, technology, reach, revenue, and more.

qstringSearch query (brand name, URL, description)

categorystringParent category: b2b_saas, b2c_saas, ecommerce, agency

subcategorystringChild category: crm_sales, marketing_automation, analytics

technologystringTech stack: Next.js, React, Vue.js, Laravel

min_reachnumberMinimum total reach (default: 10000)

min_revenuenumberMinimum estimated monthly revenue USD

sortstringSort by: reach (default), ads_count, newest, oldest

limitnumberResults per page: 1-100 (default: 25)

GET/brands/:id

1 credit

Get detailed brand information including demographics, landing pages, and AI analysis.

idstringrequiredBrand page ID (from /brands response)

GET/brands/:id/ads

2 credits

Get all ads for a brand with creative URLs, copy text, and performance metrics.

idstringrequiredBrand page ID (path parameter)

statusstringFilter: active, inactive, all (default: all)

sortstringSort by: reach (default), newest, oldest

limitnumberResults per page: 1-50 (default: 20)

GET/status

0 credits

Check your API key usage, remaining credits, and reset date.

Code	Status	Description
`MISSING_API_KEY`	401	No API key provided in header or query parameter
`INVALID_API_KEY`	401	API key is invalid, expired, or deactivated
`RATE_LIMITED`	429	Monthly credit limit exceeded. Upgrade plan or wait for reset.
`NOT_FOUND`	404	Resource not found (brand or ad does not exist)
`INVALID_PARAMS`	400	Invalid query parameters provided
`SERVER_ERROR`	500	Internal server error. Contact support if persistent.

Ready to start building?