Developer Hub

API Reference

Integrate keyword research, app analytics, rankings, and optimization workflows through the Appalize engine.

Interactive ExplorerOpenAPI Spec

REST-first integration

Connect keyword research, app analytics, competitor monitoring, and usage tracking through a single API surface.

Key-scoped access

The API is designed around scoped keys so teams can expose only the capabilities each integration actually needs.

Interactive backend explorer

The public docs page can summarize the spec, while the backend host keeps the live Swagger explorer and raw OpenAPI JSON.

Quickstart Guide

Implement in minutes.

Follow our step-by-step process to get your first request running with a scoped API key.

Need an API key first?

Generate one in the Appalize product at API Dashboard.

1

Create an API key inside the product app.

2

Use the `x-api-key` header on every request.

3

Start with keyword, app, and ranking endpoints before adding write operations.

terminal
curl -X GET \
  -H "x-api-key: YOUR_KEY" \
  "https://api.appalize.com/api/v1/keywords/search?term=fitness"
Latest surfaces

Recently updated integration paths.

These routes reflect the current public discovery, analytics ingestion, and billing-management flows now used by the product and public site.

Public discovery surfaces

Read-only endpoints powering app snapshots, search, sitemap pages, and compare routes on the public site.

GET
/api/public-apps/public
GET
/api/public-apps/search
GET
/api/public-apps/:platform/:slug
GET
/api/public-apps/compare/:platform/:pairSlug

Internal analytics ingestion

Collect client-side marketing and product events into Appalize revenue, funnel, and recent-sales dashboards.

POST
/api/analytics/events
GET
/api/google-analytics/dashboard
POST
/api/analytics/web-vitals

Billing and managed checkout

Self-serve checkout, upgrade, and billing portal flows now resolve active subscribers into a management path instead of hard failing.

POST
/api/subscription/checkout
POST
/api/subscription/upgrade
POST
/api/subscription/stripe/billing-portal
API Status & Schema

Live specification sync.

Our public surface is automatically synchronized with our internal microservices to ensure documentation never drifts from reality.

Endpoint Groups5
Operations0
Resource Groups

Explore endpoint categories.

Each group represents a specialized domain of the Appalize engine.

Keywords

3 ops

Search, suggestion, and popularity endpoints for ASO research workflows.

POST/api/v1/keywords/search
GET/api/v1/keywords/suggestions
GET/api/v1/keywords/popularity

Apps & Reviews

4 ops

App detail, analytics, review, and sentiment summary access.

GET/api/v1/apps/details
GET/api/v1/apps/analytics
GET/api/v1/apps/reviews
GET/api/v1/apps/review-summary

Rankings & Competitors

3 ops

Monitor rankings and compare competitor keyword coverage.

GET/api/v1/rankings/keyword
GET/api/v1/rankings/app
GET/api/v1/competitors/keywords

Apple Workspace

5 ops

User settings, App Store Connect metadata, pricing, and Apple Ads configuration.

GET/api/user-settings/workspace
PATCH/api/user-settings/aso-editor
PATCH/api/user-settings/apps/:appId/metadata
POST/api/user-settings/apps/:appId/pricing/apply
PATCH/api/user-settings/apple/apple-ads/config

MCP & Usage

4 ops

Registry-driven MCP discovery plus API key usage and limits.

GET/api/mcp/manifest
POST/api/mcp
GET/api/v1/usage
GET/api/v1/usage/limits
Integration Ecosystem

Extend into AI-agent workflows.

Move beyond REST calls. Connect your tools directly to Claude or Cursor through our Model Context Protocol server.

MCP DocsTalk to Support