API Reference
Access brand data, ad creatives, and analytics programmatically. Build integrations, dashboards, or custom tools on top of Proven SaaS.
Go to API DashboardAuthentication
Include your API key in requests:
x-api-key: YOUR_API_KEYor?api_key=YOUR_API_KEYPlans
| Plan | Credits/month | Price |
|---|---|---|
| Starter | 100 | $0/mo |
| Growth | 1,000 | $97/mo |
| Scale | 10,000 | $497/mo |
| Enterprise | Custom | Contact |
Credit costs: /brands = 1, /brands/:id = 1, /brands/:id/ads = 2, /status = 0 (free)
Endpoints
GET
1 credit/brandsSearch and filter brands by category, technology, reach, revenue, platform type, and more.
Parameters
qstringSearch query (brand name, URL, description)categorystringParent category: b2b_saas, b2c_saas, ecommerce, agency, etc.subcategorystringChild category: crm_sales, marketing_automation, analytics, etc.technologystringTech stack: Next.js, React, Vue.js, Laravel, etc.countrystringTarget country: United States, United Kingdom, etc.app_typestringPlatform: web (web apps only), mobile (app store apps only)min_reachnumberMinimum total reach (default: 10000)max_reachnumberMaximum total reachmin_spendnumberMinimum estimated lifetime ad spend USDmax_spendnumberMaximum estimated lifetime ad spend USDmin_daily_spendnumberMinimum current daily ad spend USDmin_adsnumberMinimum number of adssortstringSort by: reach (default), ads_count, newest, oldest, daily_spendlimitnumberResults per page: 1-100 (default: 25)offsetnumberPagination offset (default: 0)GET
1 credit/brands/:idGet detailed brand information including demographics, landing pages, and AI analysis.
Parameters
idstringrequiredBrand page ID (from /brands response)GET
2 credits/brands/:id/adsGet all ads for a brand with creative URLs, copy text, and performance metrics.
Parameters
idstringrequiredBrand page ID (path parameter)statusstringFilter: active, inactive, all (default: all)sortstringSort by: reach (default), newest, oldestlimitnumberResults per page: 1-50 (default: 20)offsetnumberPagination offset (default: 0)GET
0 credits/statusCheck your API key usage, remaining credits, and reset date.
Errors
| 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?
Get your API key