@appfigures/cli

The Appfigures CLI — query app metrics, reviews, and store data from your terminal.

Try it now without installing:

npx @appfigures/cli auth login
npx @appfigures/cli apps search "youtube"

Install

npm install -g @appfigures/cli

Requires Node.js 22+. Works with pnpm and yarn too.

Built for agents

Designed to be driven by LLM agents as much as by humans.

• JSON on stdout, everything else on stderr. Every command emits a single JSON value on stdout — jq-ready, no interleaved logs, hints, or update notices.
• Auto-detected agent mode. When stdout isn't a TTY (piped, redirected, or captured by an agent harness) the CLI switches to non-interactive: no prompts, no spinners, and errors include an agent-directed NOTE: hint on stderr to steer the next action.
• Self-describing, offline. af catalog query-docs and af metrics dataset-docs print the full query grammar and dataset catalog without hitting the API — plan queries without round-trips or stale training data.
• Unattended auth. Set APPFIGURES_API_KEY in the environment; every command runs without a browser or prompt.
• Raw API escape hatch. af api <path> proxies any endpoint the first-class commands don't cover.

Quick start

appfigures auth login
appfigures --help

Also available as af alias.

Authentication

Run af auth login in an interactive terminal to sign in. Two ways:

• Browser (default): opens your browser, approve, paste the code shown back into the CLI. The resulting token is stored in your OS credential manager (macOS Keychain, Windows Credential Manager, Linux Secret Service).
• Personal access token: pick "Personal access token" at the prompt for instructions. Create a token at appfigures.com/developers/keys, then export APPFIGURES_API_KEY=<your-token>.

For CI or any non-interactive context, af auth login will not run — set APPFIGURES_API_KEY in the environment instead.

Commands

af apps — Find and identify apps.

• search — Find apps by name or publisher. Returns one row per unified app. Default returns Apple and Google listings — pass --all-stores to include other platforms. To filter apps by estimate values (e.g. apps with >100k downloads last month) use catalog find. For estimates broken down by time, country, or platform, use metrics query with datasets estimates.sales or estimates.revenue.
• mine — List apps your Appfigures account tracks (owned plus tracked competitors).
• get — Look up an app by ID. Returns identity, metadata, and (for a product ID) user_access describing what private data the current account can pull. For the full store listing (screenshots, long descriptions, release notes, ratings summaries) use store app-listing. Pass a unified app ID for the cross-platform view (all member products, no per-product access); pass a product ID for a single platform.

af catalog — Search and analyze the app catalog — 3M+ apps, 120+ queryable fields.

• find — Advanced search across the 3M-app catalog — filter and sort by any of 120+ fields (download/revenue estimates, SDK presence, demographics, ratings, ranks, pricing, release dates, ad activity). Uses a bespoke JSON query grammar. For simple name/publisher lookup, use apps search — it's cheaper and doesn't need the grammar.
• aggregate — Advanced aggregation across the 3M-app catalog — counts, averages, min/max, and histograms over any set of matching apps. Uses the same bespoke JSON query grammar as catalog find; returns aggregates, not app records. For market sizing, benchmarking, and segment analysis.
• query-docs — Describes the query grammar, queryable fields, worked examples, and pitfalls for composing catalog find / catalog aggregate queries. No API call.

af metrics — Query numeric datasets across dimensions.

• query — Query any numeric dataset for one or more apps. Optionally grouped by up to two of: product, country, date, storefront, network, unified-app — returned as a nested partition tree, not app records. Independently filterable by country, storefront, device type, and date range. Some datasets require app ownership, some work for any app.
• dataset-docs — Lists every dataset metrics query accepts, grouped by category (sales, revenue, estimates, ratings, subscriptions, usage, ads, adspend), with labels and descriptions. No API call.

af store — App store presence — listing content, category ranks, top charts, and featured placements.

• app-ranks — Rank history for one or more apps across countries, device types, subtypes, and categories. Returns time-series positions and day-over-day deltas.
• top-charts — Top apps in a category chart — for a given country and category. Returns ranked entries with current positions and day-over-day deltas.
• categories — List every store category with its ID. Use to find the numeric category IDs that store app-ranks --category-ids and store top-charts --category-id require.
• featured — Featured and editorial placement history for an app.
• app-listing — Full store listing for one platform — localized text (name, subtitle, description, release notes) plus screenshots, video, categories, monetization, supported devices, country availability, price, file size, and age rating. Takes a numeric product ID (one platform at a time; a unified app has one product per platform). One locale per request.

af reviews — App reviews — read and analyze.

• list — Search and filter reviews for one or more apps by star rating, date range, country, language, and app version.
• breakdown — Review volume breakdown for one or more apps, by star rating, date, or country.

af keywords — Organic keyword visibility and tracking.

• list — List tracked keywords with their opaque IDs.
• rankings — Current organic keyword rankings for one or more apps. Returns which keywords each app ranks for, with position, popularity, and competitiveness. Works for any app.
• results — Apps ranking for a specific keyword in organic search results. Returns the ranked list of apps appearing for that keyword, with keyword popularity and competitiveness scores.
• related — Find related and suggested keywords for ASO research.

af apple-ads — Apple Search Ads intelligence.

• keywords — Paid keyword data for one or more apps — which keywords each app has ad impressions for, with impression share and organic rank.
• advertisers — Apps advertising on a specific keyword, with impression share, organic rank, first/last seen dates, and lifetime data.

af api

• api — Make a raw API request. See the API reference at https://docs.appfigures.com.

af auth

• login — Sign in to Appfigures
• logout — Remove stored credentials
• status — Show authentication and account status

Run af <command> --help for arguments, flags, and examples.

API Reference

Every command with its full argument and flag list. For the one-line overview, see Commands above.

Global flags. All commands accept:

• -v, --verbose — Log HTTP requests to stderr. Also set via AF_VERBOSE=1.
• -V, --version — Print the CLI version and exit.
• -h, --help — Show usage for the current command.

Output format. Every command emits a single JSON value on stdout — pipe to jq for filtering. Informational messages, hints, and update notices go to stderr so pipelines stay clean.

af apps search

af apps search <query> [flags]

Find apps by name or publisher. Returns one row per unified app. Default returns Apple and Google listings — pass --all-stores to include other platforms. To filter apps by estimate values (e.g. apps with >100k downloads last month) use catalog find. For estimates broken down by time, country, or platform, use metrics query with datasets estimates.sales or estimates.revenue.

Arguments

• <query> — string, required. Search query — app name or publisher

Flags

• --all-stores — boolean. Include platforms beyond Apple and Google — Amazon, Windows, Steam, Roku, LG TV, Samsung TV, and others.
• --with-estimates — boolean. Add downloads and revenue estimate for each app. Response includes the date range the estimate covers.
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af apps mine

af apps mine [flags]

List apps your Appfigures account tracks (owned plus tracked competitors).

Flags

• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af apps get

af apps get <app-id> [flags]

Look up an app by ID. Returns identity, metadata, and (for a product ID) user_access describing what private data the current account can pull. For the full store listing (screenshots, long descriptions, release notes, ratings summaries) use store app-listing. Pass a unified app ID for the cross-platform view (all member products, no per-product access); pass a product ID for a single platform.

Arguments

• <app-id> — integer or string, required. App identifier — unified app ID or product ID

Flags

• --all-stores — boolean, default false. For a unified app ID: include member products across all platforms (Amazon, Steam, Windows, Roku, etc.). When false (the default), member_products is restricted to app-intelligence platforms (iOS + Google Play). Ignored for product IDs.

af catalog find

af catalog find <query> [flags]

Advanced search across the 3M-app catalog — filter and sort by any of 120+ fields (download/revenue estimates, SDK presence, demographics, ratings, ranks, pricing, release dates, ad activity). Uses a bespoke JSON query grammar. For simple name/publisher lookup, use apps search — it's cheaper and doesn't need the grammar.

Arguments

• <query> — array, required. Explorer query in JSON array format. Pass [] to search across all apps, or a filter like '["and",["match","storefronts","apple:ios"],["match","all_rating",["number_range",4,5]]]'.

Flags

• --fields — string[]. Field names to return (e.g. name,developer,all_rating,custom_meta.download_estimates_average_30_days)
• --sort — string. Field to sort by (e.g. all_rating). Use order to set direction.
• --order — string. Sort direction. Omit to let the API decide.
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af catalog aggregate

af catalog aggregate <fields> [flags]

Advanced aggregation across the 3M-app catalog — counts, averages, min/max, and histograms over any set of matching apps. Uses the same bespoke JSON query grammar as catalog find; returns aggregates, not app records. For market sizing, benchmarking, and segment analysis.

Arguments

• <fields> — string[], required. Field names to aggregate (e.g. all_rating,custom_meta.download_estimates_average_30_days)

Flags

• --query — array. Explorer query in JSON array format to filter which apps to aggregate. Omit to aggregate across all apps.

af catalog query-docs

af catalog query-docs

Describes the query grammar, queryable fields, worked examples, and pitfalls for composing catalog find / catalog aggregate queries. No API call.

af metrics query

af metrics query <dataset> [flags]

Query any numeric dataset for one or more apps. Optionally grouped by up to two of: product, country, date, storefront, network, unified-app — returned as a nested partition tree, not app records. Independently filterable by country, storefront, device type, and date range. Some datasets require app ownership, some work for any app.

Arguments

• <dataset> — string, required. Dataset to query (e.g. sales.combined_downloads). Run [metrics dataset-docs](#metrics-dataset-docs) for the full list.

Flags

• --app-ids — (integer or string)[]. App identifiers (unified app IDs or product IDs)
• --group-by — string[]. Dimensions to group by. Max 2: the first slot becomes the outer entity type, the second the inner series.
• --granularity — string. Time granularity when grouping by date
• --include-total — boolean. Return a single total alongside the breakdowns. Skips client-side summation for dashboard-style asks.
• --count — integer. Cap the number of rows returned. Omit to auto-paginate every page of paginated datasets — set this when you only need a preview and want to avoid pulling the full series.
• --countries — string[]. Filter to one or more ISO country codes (e.g. US, JP, GB)
• --storefronts — string[]. Filter returned data rows to one or more platforms (e.g. apple:ios, google_play).
• --device-type — string. Device type
• --all-time — boolean. Opt in to the entire history. Without this flag (and without start/end), the query defaults to the last 30 days. Mutually exclusive with start and end.
• --start — string. Start date (YYYY-MM-DD)
• --end — string. End date (YYYY-MM-DD, defaults to today)

af metrics dataset-docs

af metrics dataset-docs

Lists every dataset metrics query accepts, grouped by category (sales, revenue, estimates, ratings, subscriptions, usage, ads, adspend), with labels and descriptions. No API call.

af store app-ranks

af store app-ranks <app-ids> [flags]

Rank history for one or more apps across countries, device types, subtypes, and categories. Returns time-series positions and day-over-day deltas.

Arguments

• <app-ids> — (integer or string)[], required. App identifiers (unified app IDs or product IDs)

Flags

• --countries — string[]. Country codes to query. Defaults to every country with rank coverage.
• --granularity — string, default hourly. Sampling rate. Default hourly gives the freshest data; pass --granularity=daily for compact multi-day history.
• --device-types — string[], default ["handheld"]. Filter response rows by device type. Default: [handheld].
• --subtypes — string[], default ["free"]. Filter response rows by subtype. Default: [free].
• --category-ids — integer[]. Filter response rows by category ID. Use store categories to discover IDs.
• --start — string. Start date (YYYY-MM-DD)
• --end — string. End date (YYYY-MM-DD, defaults to today)
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af store top-charts

af store top-charts [flags]

Top apps in a category chart — for a given country and category. Returns ranked entries with current positions and day-over-day deltas.

Flags

• --country — string, required. ISO country code (e.g. US, JP, GB)
• --category-id — integer, required. Store category ID — run store categories to find one
• --subtype — string, default free. Which list within the category — free, paid, or topgrossing
• --date — string. Snapshot date (YYYY-MM-DD, defaults to current).
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af store categories

af store categories [flags]

List every store category with its ID. Use to find the numeric category IDs that store app-ranks --category-ids and store top-charts --category-id require.

Flags

• --all — boolean, default false. Include non-rank stores (roku, vizio, etc.) — they have categories but no rank data

af store featured

af store featured <app-id> [flags]

Featured and editorial placement history for an app.

Arguments

• <app-id> — integer or string, required. App identifier — unified app ID or product ID

Flags

• --start — string. Start date (YYYY-MM-DD)
• --end — string. End date (YYYY-MM-DD, defaults to today)
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af store app-listing

af store app-listing <product-id> [flags]

Full store listing for one platform — localized text (name, subtitle, description, release notes) plus screenshots, video, categories, monetization, supported devices, country availability, price, file size, and age rating. Takes a numeric product ID (one platform at a time; a unified app has one product per platform). One locale per request.

Arguments

• <product-id> — number or string, required. Numeric product ID

Flags

• --language — string. Locale (e.g. en, ja, zh-Hans) for name, subtitle, description, release notes, and screenshots. Defaults to en; falls back to the first available locale when the requested one has no metadata. The response echoes the resolved language.
• --device-type — string, default handheld. Device type for screenshots: handheld, tablet, desktop, tv, watch, headset. Defaults to handheld — iPhone / Android phone screenshots are what most agents want. Pick another type to see the corresponding set; supported_device_types in the response lists what this app has. Does not filter other fields.

af reviews list

af reviews list [flags]

Search and filter reviews for one or more apps by star rating, date range, country, language, and app version.

Flags

• --app-ids — (integer or string)[]. App identifiers (unified app IDs or product IDs)
• --stars — number[]. Filter by star rating
• --language — string. Filter by language code (e.g. en, ja)
• --version — string. Filter by app version
• --country — string. ISO country code (e.g. US, JP, GB)
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af reviews breakdown

af reviews breakdown [flags]

Review volume breakdown for one or more apps, by star rating, date, or country.

Flags

• --app-ids — (integer or string)[]. App identifiers (unified app IDs or product IDs)
• --country — string. ISO country code (e.g. US, JP, GB)
• --start — string. Start date (YYYY-MM-DD)
• --end — string. End date (YYYY-MM-DD, defaults to today)

af keywords list

af keywords list

List tracked keywords with their opaque IDs.

af keywords rankings

af keywords rankings [flags]

Current organic keyword rankings for one or more apps. Returns which keywords each app ranks for, with position, popularity, and competitiveness. Works for any app.

Flags

• --app-ids — (integer or string)[]. App identifiers (unified app IDs or product IDs)
• --country — string. ISO country code (e.g. US, JP, GB)
• --device-type — string. Device type
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af keywords results

af keywords results <keyword-name> [flags]

Apps ranking for a specific keyword in organic search results. Returns the ranked list of apps appearing for that keyword, with keyword popularity and competitiveness scores.

Arguments

• <keyword-name> — string, required. Keyword to look up

Flags

• --country — string. ISO country code (e.g. US, JP, GB)
• --storefront — string. App store platform — e.g. apple:ios, google_play, amazon_appstore, steam, windows10, apple:mac, apple:tv, apple:imessage (and others the API may add)
• --device-type — string. Device type
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af keywords related

af keywords related <keyword-name> [flags]

Find related and suggested keywords for ASO research.

Arguments

• <keyword-name> — string, required. Seed keyword to find related terms for

Flags

• --country — string. ISO country code (e.g. US, JP, GB)
• --storefront — string. App store platform — e.g. apple:ios, google_play, amazon_appstore, steam, windows10, apple:mac, apple:tv, apple:imessage (and others the API may add)
• --device-type — string. Device type

af apple-ads keywords

af apple-ads keywords <app-ids> [flags]

Paid keyword data for one or more apps — which keywords each app has ad impressions for, with impression share and organic rank.

Arguments

• <app-ids> — (integer or string)[], required. App identifiers (unified app IDs or product IDs)

Flags

• --days — integer, default 180. Lookback period in days. Common values: 7, 14, 30, 90, 180, 365.
• --country — string. ISO country code (e.g. US, JP, GB)
• --device-type — string. Device type
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af apple-ads advertisers

af apple-ads advertisers <keyword-name> [flags]

Apps advertising on a specific keyword, with impression share, organic rank, first/last seen dates, and lifetime data.

Arguments

• <keyword-name> — string, required. Keyword to look up advertisers for

Flags

• --days — integer, default 180. Lookback period in days. Common values: 7, 14, 30, 90, 180, 365.
• --country — string. ISO country code (e.g. US, JP, GB)
• --device-type — string. Device type
• --count — integer, default 10. Number of results to return
• --page — integer, default 1. Page number (1-indexed)

af api

af api <path> [flags]

Make a raw API request. See the API reference at https://docs.appfigures.com.

Arguments

• <path> — string, required. API path (e.g. /users, /products)

Flags

• --method — string, default GET. HTTP method (one of: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS)
• --body — string. Request body (JSON string)

af auth login

af auth login

Sign in to Appfigures

Opens your browser to sign in, then prompts for the code Appfigures shows after approval. Requires an interactive terminal.

For CI / agents without a user in the loop, set APPFIGURES_API_KEY in the environment instead — no browser flow needed.

af auth logout

af auth logout

Remove stored credentials

af auth status

af auth status

Show authentication and account status

Support

• Issues: github.com/appfigures/cli/issues
• API docs: docs.appfigures.com

Contributing

This package is developed in a private monorepo and published here as a mirror. To report bugs or request features, open an issue.

We're also hiring AI-native devs. If you want to help build the future of AI App Intelligence apply at appfigures.com/careers.

License

Apache 2.0