CLI Commands

The akta-pro CLI is a command-line client for the akta.pro REST API (https://api.akta.pro/api/v1).

pipx install akta-pro-cli   # or: pip install akta-pro-cli
akta-pro login              # prompts for your wk_... key

See Installation for prerequisites, updates, and troubleshooting, and Pricing for the credit cost of each command.

Authentication

Obtain an API key from playground.akta.pro under API Keys. The CLI resolves a key from three sources, in this precedence order:

# 1. Explicit flag (highest precedence)
akta-pro --api-key wk_... company search "Canva"

# 2. Environment variable
export AKTA_PRO_API_KEY=wk_...

# 3. Stored credentials
akta-pro login

Command	Notes
`akta-pro login`	validates the key and stores it; `--api-key wk_...` skips the prompt
`akta-pro whoami`	shows the active key (masked), its source, and validates it
`akta-pro logout`	removes the stored key

Account

akta-pro account   # check tier + credits

Command	Notes
`akta-pro account`	your tier + credit balance

Company

Resolve a company, then pull a concise overview or a section-by-section Markdown profile.

# Resolve a name to a uuid — run this first
akta-pro company search "Canva"

# Rendered Markdown profile
akta-pro company data canva.com -s firmographic -s technology

# Raw Markdown (pipe/save)
akta-pro company data canva.com -s firmographic --raw

# Slimmed JSON overview
akta-pro company concise canva.com

Command	Notes
`akta-pro company search <query>`	run first; returns `uuid`
`akta-pro company data <company> -s ...`	Markdown; requires ≥1 `--section`; `--markdown` renders a report
`akta-pro company concise <company>`	slimmed JSON

company data sections

Each section is billed separately: firmographic, business_model, company_assessment, trust_signal, company_hierarchy, digital_presence, financial_estimate, location, management_profile, product_offering, strategic_signal, customer_profile, industry, technology, funding_detail, and mna_and_investment.There is no "all" — choose explicitly.

Industry

Industry codes feed the --industry filter on news signals and the list filters.

akta-pro industry search "warehouse automation"

# Restrict to specific levels of the taxonomy
akta-pro industry search "warehouse automation" --level l2 --level l3

Command	Notes
`akta-pro industry search <query>`	codes feed `news signals --industry` and list filters

Flag	Behavior
`--level`	one of `l1`, `l2`, `l3`, `l4`, `all`; repeatable

Region

Region codes feed the geography filters used by list generate companies.

akta-pro region search "Europe"
akta-pro region search --level sub-region

Command	Notes
`akta-pro region search [query]`	query is optional; returns region codes

Flag	Behavior
`--level`	one of `region`, `sub-region`, `intermediate-region`

News

# Find type codes
akta-pro news types

# Product-launch news
akta-pro news signals --company canva.com -t SD01 -n 20

# Filter by free-text query, pipe as JSON
akta-pro news signals --query "crude oil prices" --json | jq '.data[].id'

# Full bodies for specific ids
akta-pro news detail 12345 12346

Command	Notes
`akta-pro news signals [filters]`	compact list with ids; every anchor is optional
`akta-pro news detail <id>...`	full bodies for ids from `signals`; max 10 per call
`akta-pro news types`	tag codes for `--type-code`; offline, no key required

news signals filters

Anchors. --company, --primary-company, --industry, --query, --title. Use --primary-company when the company must be the main subject of the article rather than merely mentioned.Classification. -t/--type-code (codes from akta-pro news types), --naics, --sic, --iptc, --iab.Scope. --country, the --entity-* family, and --blacklist to exclude terms.Paging. -n/--limit.Run akta-pro news signals --help for the full list.

Lists

Build a filtered company list. The usual sequence is to discover the available fields, look up allowed values, then generate.

# 1. Which fields --filters accepts, and which have lookup-able values
akta-pro list filters

# 2. Allowed values for one field
akta-pro list filter-options location.hq.country

# 3. Generate the list
akta-pro list generate companies --filters '{"location.hq.country":"USA"}'

Command	Notes
`akta-pro list filters`	fields `--filters` accepts, and which have lookup-able values
`akta-pro list filter-options <dropdown_type>`	allowed values for one filter field
`akta-pro list generate companies`	returns the matching companies

Flag	Applies to	Behavior
`--query`	`generate companies`	natural-language input; translated server-side
`--filters`	`generate companies`	structured JSON, inline or `@file.json`
`-s, --section`	`generate companies`	company data sections to include per result
`--sort-by`, `--sort-order`	`generate companies`	result ordering
`-n, --limit`, `--offset`	`generate companies`	paging
`--query`, `-n, --limit`, `--level`	`filter-options`	narrow the returned values

Alternative signals

Headcount, traffic, hiring, social, and review data.

akta-pro headcount canva.com

akta-pro reviews products canva.com               # list catalog + ids
akta-pro reviews products canva.com --product-id p_123 -n 50

Command	Endpoint	Notes
`akta-pro headcount <company>`	`/company/headcount-trends`	-
`akta-pro traffic <company>`	`/company/website-traffic`	-
`akta-pro jobs <company>`	`/company/jobs`	-
`akta-pro posts <company>`	`/company/posts`	-
`akta-pro reviews employees <company>`	`/company/employee-reviews`	`-n/--limit` max 100
`akta-pro reviews products <company>`	`/company/product-reviews`	catalog first, then `--product-id`; `-n/--limit` max 50 per product

Run akta-pro <command> --help for every flag.

Non-Interactive Mode

All commands support --json output and can be fully controlled via CLI arguments and flags. Default (TTY): a Rich table for list results (search, industry, region, news, lists), rendered Markdown for company data, and pretty-printed JSON for nested objects.

# Clean, unstyled JSON on stdout (valid for | jq)
akta-pro news signals --query "crude oil prices" --json | jq '.data[].id'

# Applied automatically when stdout is piped/redirected
akta-pro company search "Canva" > results.json

# For company data, --json (alias --raw) emits the raw Markdown
akta-pro company data canva.com -s firmographic --json

# Write the raw JSON/text payload to a file
akta-pro company concise canva.com -o canva.json

Flag	Behavior
`--json`	Clean, unstyled JSON on stdout. Applied automatically when stdout is piped/redirected. For company data, `--json` (alias `--raw`) emits the raw Markdown.
`-o, --output FILE`	Writes the raw JSON/text payload to a file.
`-q, --quiet`	Silences `credits_consumed`, which is otherwise printed to stderr so it never pollutes piped JSON.

Exit codes

Scripts can branch on the process exit code.

Code	Meaning
`0`	Success
`2`	Bad input
`3`	Auth failure: missing key or invalid key
`4`	Other API or network error
`5`	Timeout

Getting Started

API Products

Resources

Developer Tools

Authentication

Account

Company

Industry

Region

News

Lists

Alternative signals

Non-Interactive Mode

Exit codes

​Authentication

​Account

​Company

​Industry

​Region

​News

​Lists

​Alternative signals

​Non-Interactive Mode

​Exit codes

Authentication

Account

Company

Industry

Region

News

Lists

Alternative signals

Non-Interactive Mode

Exit codes