> ## 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.

# Quick Start

> Go from zero to your first App Store or Google Play intelligence request in under a minute

This guide walks you through registering for an API key, fetching app metadata, pulling an intelligence report, and exploring keyword data — all in five steps.

<Note>
  **Base URL** for all requests: `https://api.appeeky.com`
</Note>

<Tip>
  Examples below use the Apple App Store (the default). To query **Google Play**, add `platform=google` and use a package name as the app identifier (e.g. `com.spotify.music`). See [Platforms](/docs/platforms).
</Tip>

***

<Steps>
  <Step title="Get Your API Key">
    Create a free account on the **Appeeky Dashboard** to get your API key with **100 monthly credits**.

    <Card title="Create Your Account" icon="key" href="https://dashboard.appeeky.com">
      Sign up with email or GitHub — your API key is generated instantly.
    </Card>

    <Warning>
      Save your API key immediately — it is displayed only once. The key is stored as a SHA-256 hash and cannot be retrieved later. You can regenerate a new key from the dashboard at any time.
    </Warning>

    For the remaining steps, replace `YOUR_API_KEY` with the key you received.
  </Step>

  <Step title="Make Your First Request">
    Fetch metadata for **Block Blast!** (App ID `1617391485`). This returns the full iTunes Lookup data: title, developer, screenshots, version, ratings, and more.

    <CodeGroup>
      ```bash curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
      curl "https://api.appeeky.com/v1/apps/1617391485?country=us" \
        -H "X-API-Key: YOUR_API_KEY"
      ```

      ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
      const res = await fetch(
        "https://api.appeeky.com/v1/apps/1617391485?country=us",
        { headers: { "X-API-Key": "YOUR_API_KEY" } }
      );
      const { data } = await res.json();
      console.log(data.trackName);       // "Block Blast!"
      console.log(data.averageUserRating); // 4.7
      ```

      ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
      import requests

      res = requests.get(
          "https://api.appeeky.com/v1/apps/1617391485",
          params={"country": "us"},
          headers={"X-API-Key": "YOUR_API_KEY"},
      )
      data = res.json()["data"]
      print(data["trackName"])         # "Block Blast!"
      print(data["averageUserRating"]) # 4.7
      ```
    </CodeGroup>

    **Response (200 OK):**

    ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      "data": {
        "trackId": 1617391485,
        "trackName": "Block Blast!",
        "sellerName": "Hungry Studio",
        "bundleId": "com.hungrystudio.blockblast",
        "primaryGenreName": "Games",
        "averageUserRating": 4.7,
        "userRatingCount": 892451,
        "price": 0,
        "currentVersionReleaseDate": "2025-12-10T08:00:00Z",
        "artworkUrl512": "https://is1-ssl.mzstatic.com/image/...",
        "screenshotUrls": ["https://is1-ssl.mzstatic.com/image/..."],
        "description": "Block Blast is an addictive puzzle game..."
      }
    }
    ```

    <Tip>
      Use the `country` query parameter to get localized metadata. Default is `us`. Common values: `us`, `gb`, `de`, `jp`, `fr`, `kr`, `br`.
    </Tip>
  </Step>

  <Step title="Get an Intelligence Report">
    The intelligence endpoint returns market estimates (downloads, revenue), in-app purchases, similar apps, and sentiment analysis — all in a single call.

    <CodeGroup>
      ```bash curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
      curl "https://api.appeeky.com/v1/apps/1617391485/intelligence?country=us" \
        -H "X-API-Key: YOUR_API_KEY"
      ```

      ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
      const res = await fetch(
        "https://api.appeeky.com/v1/apps/1617391485/intelligence?country=us",
        { headers: { "X-API-Key": "YOUR_API_KEY" } }
      );
      const { data } = await res.json();
      console.log(data.marketIntelligence.estimatedDownloads);
      console.log(data.inAppPurchases);
      ```

      ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
      import requests

      res = requests.get(
          "https://api.appeeky.com/v1/apps/1617391485/intelligence",
          params={"country": "us"},
          headers={"X-API-Key": "YOUR_API_KEY"},
      )
      data = res.json()["data"]
      print(data["marketIntelligence"]["estimatedDownloads"])
      print(data["inAppPurchases"])
      ```
    </CodeGroup>

    **Response (200 OK):**

    ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      "data": {
        "trackId": 1617391485,
        "trackName": "Block Blast!",
        "marketIntelligence": {
          "estimatedDownloads": {
            "value": 4200000,
            "range": { "low": 3100000, "high": 5600000 },
            "confidence": "high",
            "period": "monthly"
          },
          "estimatedRevenue": {
            "value": 8900000,
            "range": { "low": 6200000, "high": 12000000 },
            "confidence": "high",
            "period": "monthly",
            "currency": "USD"
          }
        },
        "inAppPurchases": [
          { "name": "Remove Ads", "price": "$4.99" },
          { "name": "Weekly VIP", "price": "$7.99" },
          { "name": "1000 Coins", "price": "$1.99" }
        ],
        "similarApps": [
          { "trackId": 1580819864, "trackName": "Hexa Sort", "sellerName": "Lion Studios" },
          { "trackId": 1594113349, "trackName": "Royal Match", "sellerName": "Dream Games" },
          { "trackId": 553834731, "trackName": "Candy Crush Saga", "sellerName": "King" }
        ],
        "sentimentAnalysis": {
          "averageRating": 4.7,
          "totalReviews": 892451,
          "positivePercentage": 89.2,
          "topPositiveThemes": ["addictive gameplay", "simple controls", "relaxing"],
          "topNegativeThemes": ["too many ads", "difficulty spikes"]
        }
      }
    }
    ```

    <Tip>
      The intelligence endpoint costs **5 credits** because it aggregates data from multiple sources in parallel. Use `/v1/apps/:id` (2 credits) if you only need basic metadata.
    </Tip>
  </Step>

  <Step title="Explore Keywords">
    See which apps rank for a specific keyword, along with popularity and competitiveness scores.

    <CodeGroup>
      ```bash curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
      curl "https://api.appeeky.com/v1/keywords/ranks?keyword=puzzle+game&country=us" \
        -H "X-API-Key: YOUR_API_KEY"
      ```

      ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
      const res = await fetch(
        "https://api.appeeky.com/v1/keywords/ranks?keyword=puzzle+game&country=us",
        { headers: { "X-API-Key": "YOUR_API_KEY" } }
      );
      const { data } = await res.json();
      data.rankings.forEach((app) => {
        console.log(`#${app.rank} ${app.trackName} (${app.trackId})`);
      });
      ```

      ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
      import requests

      res = requests.get(
          "https://api.appeeky.com/v1/keywords/ranks",
          params={"keyword": "puzzle game", "country": "us"},
          headers={"X-API-Key": "YOUR_API_KEY"},
      )
      data = res.json()["data"]
      for app in data["rankings"]:
          print(f'#{app["rank"]} {app["trackName"]} ({app["trackId"]})')
      ```
    </CodeGroup>

    **Response (200 OK):**

    ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      "data": {
        "keyword": "puzzle game",
        "country": "us",
        "popularity": 62,
        "competitiveness": 78,
        "totalResults": 200,
        "rankings": [
          { "rank": 1, "trackId": 1617391485, "trackName": "Block Blast!", "sellerName": "Hungry Studio" },
          { "rank": 2, "trackId": 1594113349, "trackName": "Royal Match", "sellerName": "Dream Games" },
          { "rank": 3, "trackId": 553834731, "trackName": "Candy Crush Saga", "sellerName": "King" },
          { "rank": 4, "trackId": 913335252, "trackName": "Brilliant", "sellerName": "Brilliant.org" },
          { "rank": 5, "trackId": 1580819864, "trackName": "Hexa Sort", "sellerName": "Lion Studios" }
        ]
      }
    }
    ```
  </Step>

  <Step title="Track a Keyword">
    Add a keyword to the daily scraping pipeline so rank data stays fresh.

    <CodeGroup>
      ```bash curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
      curl -X POST https://api.appeeky.com/v1/keywords/track \
        -H "X-API-Key: YOUR_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{"keyword": "puzzle game", "country": "us"}'
      ```

      ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
      const res = await fetch("https://api.appeeky.com/v1/keywords/track", {
        method: "POST",
        headers: {
          "X-API-Key": "YOUR_API_KEY",
          "Content-Type": "application/json",
        },
        body: JSON.stringify({ keyword: "puzzle game", country: "us" }),
      });
      const { data } = await res.json();
      console.log(data.status); // "tracked"
      ```

      ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
      import requests

      res = requests.post(
          "https://api.appeeky.com/v1/keywords/track",
          headers={"X-API-Key": "YOUR_API_KEY"},
          json={"keyword": "puzzle game", "country": "us"},
      )
      data = res.json()["data"]
      print(data["status"])  # "tracked"
      ```
    </CodeGroup>

    **Response (200 OK):**

    ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
    {
      "data": {
        "keyword": "puzzle game",
        "country": "us",
        "status": "tracked",
        "message": "Keyword is now being tracked. Rankings will be updated daily."
      }
    }
    ```

    <Note>
      Tracked keywords are scraped daily. Historical rank data becomes available through the `/v1/apps/:id/keywords/trends` endpoint after the first scrape cycle.
    </Note>
  </Step>
</Steps>

***

## Next Steps

You've covered the basics. Dive deeper into specific areas:

<CardGroup cols={2}>
  <Card title="App Metadata" icon="mobile" href="/docs/get-app">
    Full app details, screenshots, and version history
  </Card>

  <Card title="Intelligence Reports" icon="chart-line" href="/docs/get-app-intelligence">
    Revenue estimates, downloads, IAPs, and competitor analysis
  </Card>

  <Card title="Keyword Rankings" icon="ranking-star" href="/docs/get-keyword-ranks">
    See which apps rank for any keyword
  </Card>

  <Card title="App Keywords" icon="key" href="/docs/get-app-keywords">
    Discover all keywords an app ranks for
  </Card>

  <Card title="ASO Tools" icon="chart-mixed" href="/docs/aso-audit">
    Audits, briefs, intent clusters, and metadata suggestions
  </Card>

  <Card title="AI Visibility" icon="sparkles" href="/docs/ai-visibility-overview">
    See how often ChatGPT, Gemini, Claude, and Perplexity recommend your app
  </Card>

  <Card title="Search Apps" icon="magnifying-glass" href="/docs/search">
    Search the App Store by keyword or ID
  </Card>

  <Card title="Category Charts" icon="trophy" href="/docs/categories">
    Top apps by category, chart type, and country
  </Card>

  <Card title="MCP Server" icon="robot" href="/docs/mcp">
    Connect Claude, Cursor, or any MCP client to App Store & Google Play intelligence
  </Card>

  <Card title="Rate Limits" icon="gauge" href="/docs/rate-limits">
    Credit costs, plans, and usage tracking
  </Card>

  <Card title="API Overview" icon="book" href="/docs/overview">
    Complete endpoint reference and error codes
  </Card>
</CardGroup>