Documentation Index
Fetch the complete documentation index at: https://docs.appeeky.com/llms.txt
Use this file to discover all available pages before exploring further.
Track competitor apps against each of your tracked apps. Competitors are displayed on the Competitors tab in the appeeky.com dashboard.
All Competitor endpoints cost 0 credits and require the apps:read scope for reads and apps:write for writes.
List Competitors
GET /v1/user/apps/:appId/competitors
Returns all competitor apps tracked for a given app.
Path Parameters:
| Name | Type | Description |
|---|
appId | number | Numeric App Store ID of your tracked app |
curl "https://api.appeeky.com/v1/user/apps/6443843426/competitors" \
-H "X-API-Key: YOUR_API_KEY"
Response (200 OK):
{
"data": [
{
"id": "a4b1d302-...",
"competitor_app_id": 1547223625,
"competitor_name": "Voice Tape Record",
"competitor_icon_url": "https://...",
"created_at": "2026-03-19T15:47:06.270736+00:00"
}
]
}
Add a Competitor
POST /v1/user/apps/:appId/competitors
Add a competitor app by its numeric App Store ID.
Path Parameters:
| Name | Type | Description |
|---|
appId | number | Numeric App Store ID of your tracked app |
Request Body:
| Field | Type | Required | Description |
|---|
competitorAppId | number | Yes | Numeric App Store ID of the competitor |
competitorName | string | No | Display name for the competitor |
curl -X POST "https://api.appeeky.com/v1/user/apps/6443843426/competitors" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"competitorAppId": 1547223625, "competitorName": "Sensor Tower"}'
Response (201 Created): Returns the created competitor row.
Remove a Competitor
DELETE /v1/user/apps/:appId/competitors/:competitorAppId
Remove a competitor from a tracked app.
Path Parameters:
| Name | Type | Description |
|---|
appId | number | Numeric App Store ID of your tracked app |
competitorAppId | number | Numeric App Store ID of the competitor to remove |
curl -X DELETE "https://api.appeeky.com/v1/user/apps/6443843426/competitors/1547223625" \
-H "X-API-Key: YOUR_API_KEY"
Response (200 OK):
{ "data": { "success": true } }
Errors
| Status | Code | When |
|---|
| 400 | BAD_REQUEST | appId or competitorAppId is not a number |
| 403 | FORBIDDEN | Key scope does not allow this operation |
| 404 | USER_APP_NOT_FOUND | appId is not in your tracked list |
| 404 | NOT_FOUND | Competitor not found |
| 409 | DUPLICATE | Competitor already tracked for this app |