{ "openapi": "3.1.0", "info": { "title": "APK API", "version": "1.0.0", "description": "Google Play data API: 4 million apps (live and removed), developers, new releases, removals and title keywords. JSON, UTF-8, CORS enabled.\n\nEvery call costs 0–3 tokens regardless of the number of rows (up to 100); /apps costs 1 token per app. Monthly free tokens are used first, then the purchased balance; if a request fails on our side, the tokens are returned. Remaining tokens are in the `_tokens` field of every response; `_credits` is a deprecated alias.\n\nDocumentation: https://apkapi.com/api-docs.php", "contact": { "url": "https://apkapi.com/api-docs.php" }, "termsOfService": "https://apkapi.com/legal/terms.php" }, "servers": [ { "url": "https://apkapi.com/api/v1" } ], "security": [ { "ApiKeyHeader": [] }, { "BearerAuth": [] } ], "tags": [ { "name": "אפליקציות" }, { "name": "מפתחים" }, { "name": "שינויים בחנות" }, { "name": "שוק" } ], "paths": { "/account": { "get": { "operationId": "account", "tags": [ "Account" ], "summary": "Your plan, token balance, the monthly reset date and the per-minute limit.", "description": "Free: no tokens are charged.", "responses": { "200": { "$ref": "#/components/responses/Ok" }, "401": { "$ref": "#/components/responses/Error" } } } }, "/app": { "get": { "operationId": "app", "tags": [ "אפליקציות" ], "summary": "כרטיס אפליקציה מלא: שם, תיאור, «מה חדש», התקנות (סף ומספר מדויק), דירוג, מספר הדירוגים והביקורות, התפלגות כוכבים, מחיר, רכישות, פרסומות, קטגוריה, סיווג גיל, גרסה, Android מינימלי, תאריכי שחרור ועדכון, סמל, צילומי מסך, וידאו, מפתח והאתר שלו. עבור אפליקציות שהוסרו — הנתונים האחרונים שנשמרו ותאריך ההיעלמות.", "description": "כרטיס אפליקציה מלא: שם, תיאור, «מה חדש», התקנות (סף ומספר מדויק), דירוג, מספר הדירוגים והביקורות, התפלגות כוכבים, מחיר, רכישות, פרסומות, קטגוריה, סיווג גיל, גרסה, Android מינימלי, תאריכי שחרור ועדכון, סמל, צילומי מסך, וידאו, מפתח והאתר שלו. עבור אפליקציות שהוסרו — הנתונים האחרונים שנשמרו ותאריך ההיעלמות.\n\nCost: 1 token per call.", "x-tokens": 1, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "שם חבילת האפליקציה", "schema": { "type": "string" }, "example": "com.whatsapp" } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/apps": { "get": { "operationId": "apps", "tags": [ "אפליקציות" ], "summary": "עד 100 כרטיסי אפליקציות בבקשה אחת: GET ?ids=a,b,c או POST עם רשימה בגוף הבקשה (אחד בכל שורה, או JSON {\"ids\": […]}). אסימון אחד לכל אפליקציה; מזהים שלא נמצאו חוזרים ב-not_found.", "description": "עד 100 כרטיסי אפליקציות בבקשה אחת: GET ?ids=a,b,c או POST עם רשימה בגוף הבקשה (אחד בכל שורה, או JSON {\"ids\": […]}). אסימון אחד לכל אפליקציה; מזהים שלא נמצאו חוזרים ב-not_found.\n\nCost: 1 token per app.", "x-tokens": 1, "parameters": [ { "name": "ids", "in": "query", "required": true, "description": "שמות חבילות מופרדים בפסיקים, עד 100", "schema": { "type": "string" }, "example": "com.whatsapp,org.telegram.messenger" } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "apps_post", "tags": [ "אפליקציות" ], "summary": "Same as GET, with package names in the request body (one per line, or JSON {\"ids\": [...]}).", "description": "עד 100 כרטיסי אפליקציות בבקשה אחת: GET ?ids=a,b,c או POST עם רשימה בגוף הבקשה (אחד בכל שורה, או JSON {\"ids\": […]}). אסימון אחד לכל אפליקציה; מזהים שלא נמצאו חוזרים ב-not_found.\n\nCost: 1 token per app.", "x-tokens": 1, "parameters": [], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } }, "requestBody": { "required": true, "content": { "text/plain": { "schema": { "type": "string" }, "example": "com.whatsapp\norg.telegram.messenger" } } } } }, "/search": { "get": { "operationId": "search", "tags": [ "אפליקציות" ], "summary": "חיפוש ומסננים על כל מסד הנתונים. נדרש לפחות מסנן אחד. ללא q המיון הוא לפי התקנות.", "description": "חיפוש ומסננים על כל מסד הנתונים. נדרש לפחות מסנן אחד. ללא q המיון הוא לפי התקנות.\n\nCost: 2 tokens per call.", "x-tokens": 2, "parameters": [ { "name": "q", "in": "query", "required": false, "description": "מילים לחיפוש בשם, בתיאור ובשם המפתח", "schema": { "type": "string" }, "example": "photo editor" }, { "name": "category", "in": "query", "required": false, "description": "מזהה קטגוריה, למשל GAME_PUZZLE (ראו /v1/categories)", "schema": { "type": "string" } }, { "name": "developer_id", "in": "query", "required": false, "description": "מזהה המפתח ב-Google Play", "schema": { "type": "string" } }, { "name": "min_installs", "in": "query", "required": false, "description": "מינימום התקנות (ספי Google Play: 1000, 10000…)", "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_installs", "in": "query", "required": false, "description": "מקסימום התקנות", "schema": { "type": "integer", "minimum": 0 } }, { "name": "min_score", "in": "query", "required": false, "description": "דירוג מינימלי, 0–5", "schema": { "type": "string" } }, { "name": "min_ratings", "in": "query", "required": false, "description": "מינימום דירוגים", "schema": { "type": "integer", "minimum": 0 } }, { "name": "free", "in": "query", "required": false, "description": "true — חינמיות בלבד, false — בתשלום בלבד", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "ads", "in": "query", "required": false, "description": "true — עם פרסומות, false — בלי", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "iap", "in": "query", "required": false, "description": "true — עם רכישות באפליקציה", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "lang", "in": "query", "required": false, "description": "שפת השם, קוד ISO: en, de, pt…", "schema": { "type": "string" } }, { "name": "released_from", "in": "query", "required": false, "description": "שוחררו מתאריך זה, YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "released_to", "in": "query", "required": false, "description": "שוחררו עד תאריך זה, כולל", "schema": { "type": "string" } }, { "name": "updated_from", "in": "query", "required": false, "description": "עודכנו מתאריך זה", "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "required": false, "description": "עודכנו עד תאריך זה, כולל", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "live (בחנות, ברירת מחדל), removed או all", "schema": { "type": "string", "enum": [ "live", "removed", "all" ] } }, { "name": "sort", "in": "query", "required": false, "description": "relevance | installs | real_installs | score | ratings | reviews | released | updated | price", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "desc | asc", "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/suggest": { "get": { "operationId": "suggest", "tags": [ "אפליקציות" ], "summary": "הצעות לפי תחילת השם: 10 ההתאמות הפופולריות ביותר. בחינם.", "description": "הצעות לפי תחילת השם: 10 ההתאמות הפופולריות ביותר. בחינם.\n\nCost: 0 tokens per call.", "x-tokens": 0, "parameters": [ { "name": "q", "in": "query", "required": true, "description": "תחילת השם, מ-2 תווים", "schema": { "type": "string" }, "example": "whats" } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/developer": { "get": { "operationId": "developer", "tags": [ "מפתחים" ], "summary": "מפתח וכל האפליקציות שלו: כמות (בחנות ושהוסרו), סך ההתקנות, דירוג ממוצע, שחרור ראשון, קטגוריות, אתר. במסלול Business — אימייל, טלפון, כתובת ושם משפטי.", "description": "מפתח וכל האפליקציות שלו: כמות (בחנות ושהוסרו), סך ההתקנות, דירוג ממוצע, שחרור ראשון, קטגוריות, אתר. במסלול Business — אימייל, טלפון, כתובת ושם משפטי.\n\nCost: 2 tokens per call.", "x-tokens": 2, "parameters": [ { "name": "id", "in": "query", "required": false, "description": "מזהה מפתח (מכרטיס האפליקציה: developer.id)", "schema": { "type": "string" }, "example": "5191370068110375942" }, { "name": "name", "in": "query", "required": false, "description": "או השם המדויק של המפתח", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "all (ברירת מחדל), live או removed", "schema": { "type": "string", "enum": [ "live", "removed", "all" ] } }, { "name": "sort", "in": "query", "required": false, "description": "relevance | installs | real_installs | score | ratings | reviews | released | updated | price", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/new": { "get": { "operationId": "new", "tags": [ "שינויים בחנות" ], "summary": "אפליקציות חדשות לפי תאריך השחרור הראשון, החדשות ביותר קודם.", "description": "אפליקציות חדשות לפי תאריך השחרור הראשון, החדשות ביותר קודם.\n\nCost: 2 tokens per call.", "x-tokens": 2, "parameters": [ { "name": "since", "in": "query", "required": false, "description": "מתאריך זה, YYYY-MM-DD (ברירת מחדל: לפני 7 ימים)", "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "description": "עד תאריך זה, כולל", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "מזהה קטגוריה, למשל GAME_PUZZLE (ראו /v1/categories)", "schema": { "type": "string" } }, { "name": "min_installs", "in": "query", "required": false, "description": "מינימום התקנות (ספי Google Play: 1000, 10000…)", "schema": { "type": "integer", "minimum": 0 } }, { "name": "lang", "in": "query", "required": false, "description": "שפת השם, קוד ISO: en, de, pt…", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "relevance | installs | real_installs | score | ratings | reviews | released | updated | price", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/removed": { "get": { "operationId": "removed", "tags": [ "שינויים בחנות" ], "summary": "אפליקציות שנעלמו מ-Google Play (אינן קיימות באף אחת מ-19 המדינות שאנחנו בודקים), לפי תאריך ההיעלמות. הכרטיס שומר את הנתונים האחרונים.", "description": "אפליקציות שנעלמו מ-Google Play (אינן קיימות באף אחת מ-19 המדינות שאנחנו בודקים), לפי תאריך ההיעלמות. הכרטיס שומר את הנתונים האחרונים.\n\nCost: 2 tokens per call.", "x-tokens": 2, "parameters": [ { "name": "since", "in": "query", "required": false, "description": "מתאריך זה, YYYY-MM-DD (ברירת מחדל: לפני 7 ימים)", "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "description": "עד תאריך זה, כולל", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "מזהה קטגוריה, למשל GAME_PUZZLE (ראו /v1/categories)", "schema": { "type": "string" } }, { "name": "min_installs", "in": "query", "required": false, "description": "מינימום התקנות (ספי Google Play: 1000, 10000…)", "schema": { "type": "integer", "minimum": 0 } }, { "name": "sort", "in": "query", "required": false, "description": "removed_at | installs | score", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/keywords": { "get": { "operationId": "keywords", "tags": [ "שוק" ], "summary": "מילים וביטויים משמות אפליקציות, בנפרד לכל שפה: כמה אפליקציות ומפתחים משתמשים בהם, כמה מהן חזקות (100 אלף התקנות ומעלה), סך ההתקנות, חלקו של המוביל וציון הזדמנות (opportunity).", "description": "מילים וביטויים משמות אפליקציות, בנפרד לכל שפה: כמה אפליקציות ומפתחים משתמשים בהם, כמה מהן חזקות (100 אלף התקנות ומעלה), סך ההתקנות, חלקו של המוביל וציון הזדמנות (opportunity).\n\nCost: 2 tokens per call.", "x-tokens": 2, "parameters": [ { "name": "lang", "in": "query", "required": false, "description": "שפה, ברירת מחדל en", "schema": { "type": "string" }, "example": "en" }, { "name": "q", "in": "query", "required": false, "description": "מילה או ביטוי", "schema": { "type": "string" }, "example": "vpn" }, { "name": "phrase", "in": "query", "required": false, "description": "true — ביטויים של שתי מילים בלבד, false — מילים בודדות בלבד", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "min_apps", "in": "query", "required": false, "description": "מינימום אפליקציות", "schema": { "type": "integer", "minimum": 0 } }, { "name": "max_apps", "in": "query", "required": false, "description": "מקסימום אפליקציות", "schema": { "type": "integer", "minimum": 0 } }, { "name": "sort", "in": "query", "required": false, "description": "opportunity | apps | installs | strong | devs | max_installs", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "desc | asc", "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/categories": { "get": { "operationId": "categories", "tags": [ "שוק" ], "summary": "כל הקטגוריות עם מספר האפליקציות וסך ההתקנות. בחינם.", "description": "כל הקטגוריות עם מספר האפליקציות וסך ההתקנות. בחינם.\n\nCost: 0 tokens per call.", "x-tokens": 0, "parameters": [ { "name": "status", "in": "query", "required": false, "description": "live (בחנות, ברירת מחדל), removed או all", "schema": { "type": "string", "enum": [ "live", "removed", "all" ] } } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/free_domains": { "get": { "operationId": "free_domains", "tags": [ "שוק" ], "summary": "אפליקציות שדומיין האתר של המפתח שלהן פנוי לרישום, יחד עם הפופולריות של האפליקציה. נפתח לאחר רכישת האסימונים הראשונה.", "description": "אפליקציות שדומיין האתר של המפתח שלהן פנוי לרישום, יחד עם הפופולריות של האפליקציה. נפתח לאחר רכישת האסימונים הראשונה.\n\nCost: 3 tokens per call. Opens after the first token purchase.", "x-tokens": 3, "parameters": [ { "name": "category", "in": "query", "required": false, "description": "מזהה קטגוריה, למשל GAME_PUZZLE (ראו /v1/categories)", "schema": { "type": "string" } }, { "name": "min_installs", "in": "query", "required": false, "description": "מינימום התקנות (ספי Google Play: 1000, 10000…)", "schema": { "type": "integer", "minimum": 0 } }, { "name": "status", "in": "query", "required": false, "description": "live (בחנות, ברירת מחדל), removed או all", "schema": { "type": "string", "enum": [ "live", "removed", "all" ] } }, { "name": "tld", "in": "query", "required": false, "description": "סיומת דומיין, למשל com", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "relevance | installs | real_installs | score | ratings | reviews | released | updated | price", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/charts": { "get": { "operationId": "charts", "tags": [ "שוק" ], "summary": "צ׳ארט עליון של Google Play למדינה וקטגוריה אחת: עד 200 מיקומים, שינוי מיקום מאז תמונת המצב הקודמת (change: בכמה מקומות עלתה, \"new\" — חדשה בצ׳ארט), סמל והתקנות.", "description": "צ׳ארט עליון של Google Play למדינה וקטגוריה אחת: עד 200 מיקומים, שינוי מיקום מאז תמונת המצב הקודמת (change: בכמה מקומות עלתה, \"new\" — חדשה בצ׳ארט), סמל והתקנות.\n\nCost: 2 tokens per call.", "x-tokens": 2, "parameters": [ { "name": "country", "in": "query", "required": true, "description": "מדינה, קוד ISO: US, DE, BR…", "schema": { "type": "string" }, "example": "US" }, { "name": "category", "in": "query", "required": true, "description": "קטגוריה, למשל GAME_PUZZLE", "schema": { "type": "string" }, "example": "GAME_PUZZLE" }, { "name": "collection", "in": "query", "required": false, "description": "free | paid | grossing", "schema": { "type": "string", "enum": [ "free", "paid", "grossing" ] } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/rankings": { "get": { "operationId": "rankings", "tags": [ "שוק" ], "summary": "כל הצ׳ארטים שהאפליקציה נמצאת בהם בתמונת המצב האחרונה: מדינה, קטגוריה, אוסף, מיקום; מספר הצ׳ארטים והמדינות והמיקום הטוב ביותר.", "description": "כל הצ׳ארטים שהאפליקציה נמצאת בהם בתמונת המצב האחרונה: מדינה, קטגוריה, אוסף, מיקום; מספר הצ׳ארטים והמדינות והמיקום הטוב ביותר.\n\nCost: 1 token per call.", "x-tokens": 1, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "שם חבילת האפליקציה", "schema": { "type": "string" }, "example": "com.whatsapp" }, { "name": "country", "in": "query", "required": false, "description": "מדינה אחת בלבד", "schema": { "type": "string" } }, { "name": "collection", "in": "query", "required": false, "description": "free | paid | grossing", "schema": { "type": "string", "enum": [ "free", "paid", "grossing" ] } } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/availability": { "get": { "operationId": "availability", "tags": [ "שוק" ], "summary": "מדינות שבהן האפליקציה זמינה ב-Google Play (לפי hreflang ב-sitemap של החנות). אם יש 190+ מדינות, מוחזר worldwide = true ללא רשימה.", "description": "מדינות שבהן האפליקציה זמינה ב-Google Play (לפי hreflang ב-sitemap של החנות). אם יש 190+ מדינות, מוחזר worldwide = true ללא רשימה.\n\nCost: 1 token per call.", "x-tokens": 1, "parameters": [ { "name": "id", "in": "query", "required": true, "description": "שם חבילת האפליקציה", "schema": { "type": "string" }, "example": "com.whatsapp" } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/markets": { "get": { "operationId": "markets", "tags": [ "שוק" ], "summary": "תחרותיות השווקים לפי צ׳ארטים חינמיים: סף הכניסה לטופ 100 ולטופ 200 (התקנות של האפליקציה במיקום הזה), חלקן של אפליקציות חדשות (ב-12 החודשים האחרונים) ומקומיות (עד 3 מדינות) בטופ, וגודל השוק המקומי. ללא פרמטרים — כל המדינות; country — הקטגוריות של מדינה אחת; category — קטגוריה אחת בכל המדינות.", "description": "תחרותיות השווקים לפי צ׳ארטים חינמיים: סף הכניסה לטופ 100 ולטופ 200 (התקנות של האפליקציה במיקום הזה), חלקן של אפליקציות חדשות (ב-12 החודשים האחרונים) ומקומיות (עד 3 מדינות) בטופ, וגודל השוק המקומי. ללא פרמטרים — כל המדינות; country — הקטגוריות של מדינה אחת; category — קטגוריה אחת בכל המדינות.\n\nCost: 1 token per call.", "x-tokens": 1, "parameters": [ { "name": "country", "in": "query", "required": false, "description": "מדינה, קוד ISO", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "מזהה קטגוריה, למשל GAME_PUZZLE (ראו /v1/categories)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "entry100 | entry200 | new_share | local_share | local_apps | local_installs | local_new", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "desc | asc", "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "name": "page", "in": "query", "required": false, "description": "עמוד, מ-1", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per", "in": "query", "required": false, "description": "שורות בעמוד, 1–100 (ברירת מחדל 20)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "example": 20 } ], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/stats": { "get": { "operationId": "stats", "tags": [ "שוק" ], "summary": "גודל מסד הנתונים: אפליקציות בחנות ואפליקציות שהוסרו, מפתחים, חדשות ושהוסרו ב-7 הימים האחרונים, מועד העדכון האחרון. בחינם.", "description": "גודל מסד הנתונים: אפליקציות בחנות ואפליקציות שהוסרו, מפתחים, חדשות ושהוסרו ב-7 הימים האחרונים, מועד העדכון האחרון. בחינם.\n\nCost: 0 tokens per call.", "x-tokens": 0, "parameters": [], "responses": { "200": { "$ref": "#/components/responses/Ok" }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "402": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "502": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" } } } }, "/health": { "get": { "operationId": "health", "tags": [ "Account" ], "summary": "Service status. No key required.", "security": [], "responses": { "200": { "$ref": "#/components/responses/Ok" } } } } }, "components": { "securitySchemes": { "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key" }, "BearerAuth": { "type": "http", "scheme": "bearer" } }, "schemas": { "Tokens": { "type": "object", "properties": { "cost": { "type": "integer", "description": "tokens this request cost" }, "remaining": { "type": "integer", "description": "tokens left (monthly + purchased)" } } }, "Ok": { "type": "object", "required": [ "ok" ], "additionalProperties": true, "properties": { "ok": { "type": "boolean", "const": true }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "total": { "type": "integer" }, "page": { "type": "integer" }, "per": { "type": "integer" }, "pages": { "type": "integer" }, "_tokens": { "$ref": "#/components/schemas/Tokens" }, "_credits": { "$ref": "#/components/schemas/Tokens", "deprecated": true } } }, "Error": { "type": "object", "required": [ "ok", "error", "code" ], "properties": { "ok": { "type": "boolean", "const": false }, "error": { "type": "string" }, "code": { "type": "string", "examples": [ "missing_api_key", "invalid_api_key", "account_blocked", "insufficient_credits", "rate_limited", "invalid_param", "invalid_request", "not_found", "upstream_error", "service_unavailable" ] } } } }, "responses": { "Ok": { "description": "Success", "headers": { "X-Cache": { "description": "HIT — served from cache, MISS — fresh query to the database", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "Error": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }