@zactax/zactax-cli

Command-line interface for the ZacTax API. Query sales tax, property tax, and other municipal data directly from your terminal.

Installation

npm install -g @zactax/zactax-cli

Requires Node.js 20 or later.

Authentication

All data commands require a ZacTax API key. Get yours at app.zactax.com, then run:

zactax login

You'll be prompted to enter your API key. The key is validated against the API and stored securely in your system keychain.

Non-macOS authentication

On Linux and Windows, the CLI does not store your API key by default. You can use an environment variable:

export ZACTAX_API_KEY=sk-your-key

If you want to store the key in a local config file (plaintext, permissions 0o600), re-run login with:

zactax login --store-plaintext

Note: --store-plaintext is disabled on macOS.

To log out and remove your stored key:

zactax logout

Default Jurisdiction

Most commands require a jurisdiction. Rather than passing -j <slug> every time, you can set a default:

zactax config jurisdiction

This presents a searchable list of your jurisdictions. Pick one and it becomes the default for all subsequent commands. To override the default on any command, use -j:

zactax sales-tax industries -j houston-tx

To clear the default:

zactax config jurisdiction --clear

Output Formats

All data commands support these output flags:

| Flag | Description | |---|---| | --json | Output as JSON | | --csv | Output as CSV | | --yaml | Output as YAML | | --output <file> | Write output to a file | | --fields <fields> | Comma-separated list of fields to display |

The default output is a formatted table with a curated set of columns. Use --fields to customize which columns appear, or --json to get the full response.

Jurisdictions

List all jurisdictions on your account:

zactax jurisdictions
zactax jurisdictions --json

Sales Tax

Industries

List industries for your default jurisdiction:

zactax sales-tax industries

Filter by type (category, group, or code), parent ID, or search by name:

zactax sales-tax industries --type category
zactax sales-tax industries --type group --parent-id 7
zactax sales-tax industries -q "Retail"

Show a single industry with its parent and child count:

zactax sales-tax industries show <id>

List payment history for an industry (paginated):

zactax sales-tax industries payments <id>
zactax sales-tax industries payments <id> --all
zactax sales-tax industries payments <id> --per-page 50 --page 2

Taxpayers

List taxpayers, with optional search and filters:

zactax sales-tax taxpayers
zactax sales-tax taxpayers -q "Walmart"
zactax sales-tax taxpayers --is-local true
zactax sales-tax taxpayers --industry-category 7

Use --include to embed related resources in the response:

zactax sales-tax taxpayers --include industry,company --json

Available includes: outlets, industry, industryGroup, industryCategory, company.

Show a single taxpayer:

zactax sales-tax taxpayers show <id>
zactax sales-tax taxpayers show <id> --include industry,company

List payment history for a taxpayer (paginated):

zactax sales-tax taxpayers payments <id>
zactax sales-tax taxpayers payments <id> --all

List outlets for a taxpayer (paginated):

zactax sales-tax taxpayers outlets <id>
zactax sales-tax taxpayers outlets <id> --include address

Show the company associated with a taxpayer:

zactax sales-tax taxpayers company <id>

Outlets

List outlets, with optional search and filters:

zactax sales-tax outlets
zactax sales-tax outlets -q "Main St"
zactax sales-tax outlets --taxpayer-id 17593720368
zactax sales-tax outlets --active true

Show a single outlet with its taxpayer and latest payment:

zactax sales-tax outlets show <id>

Collections

List collection periods (paginated):

zactax sales-tax collections
zactax sales-tax collections --all

Show a single collection period:

zactax sales-tax collections show 2026/02
zactax sales-tax collections show 2026/02 --include components --json

List the components breakdown for a collection period:

zactax sales-tax collections components 2026/02

Payments

Query taxpayer payments in bulk with powerful filters:

zactax sales-tax payments
zactax sales-tax payments --taxpayer-id 17593720368

Filter by period range:

zactax sales-tax payments --period-gte 2025-01-01 --period-lte 2025-12-01
zactax sales-tax payments --period 2026-02-01

Filter by audit activity:

zactax sales-tax payments --has-audit true
zactax sales-tax payments --audit-amount-gte 1000

Property Tax

Properties

List properties, with optional search and filters:

zactax property-tax properties
zactax property-tax properties -q "123 Main"
zactax property-tax properties --type residential
zactax property-tax properties --neighborhood-id 100 --active true

Use --include to embed related resources:

zactax property-tax properties --include address,owners --json

Available includes: address, owners, neighborhood, useCode, schoolDistrict, exemptions, recentAppraisal.

Show a single property:

zactax property-tax properties show R12345
zactax property-tax properties show R12345 --include address,appraisals

Neighborhoods

List neighborhoods:

zactax property-tax neighborhoods
zactax property-tax neighborhoods -q "Oak"
zactax property-tax neighborhoods --include currentStatistics --json

Show a single neighborhood:

zactax property-tax neighborhoods show 100
zactax property-tax neighborhoods show 100 --include statistics --statistics-property-type residential

List statistics for a neighborhood (paginated):

zactax property-tax neighborhoods statistics 100
zactax property-tax neighborhoods statistics 100 --property-type residential
zactax property-tax neighborhoods statistics 100 --appraisal-year 2025

Appraisals

List appraisals for a given year (paginated, ordered by taxable value desc):

zactax property-tax appraisals 2025
zactax property-tax appraisals 2025 --property-type commercial
zactax property-tax appraisals 2025 --include property,property.address --json

Show appraisal statistics for a year (all property type breakdowns):

zactax property-tax appraisals statistics 2025

Geography

Regions

List regions, with optional search and filters:

zactax geo regions
zactax geo regions -q "Downtown"
zactax geo regions --layer-id 1
zactax geo regions --active true

Use --include to embed related resources:

zactax geo regions --include layer --json

Available includes: layer, polygon.

Show a single region:

zactax geo regions show <id>
zactax geo regions show <id> --include polygon --json

Economics

Profitability Studies

List profitability studies:

zactax economics studies
zactax economics studies -q "Downtown"
zactax economics studies --subject-type property-tax.neighborhood
zactax economics studies --has-been-run

Use --include to embed related resources:

zactax economics studies --include statistics,analyses --json

Available includes: statistics, analyses, percentiles, subject.

Show a single study:

zactax economics studies show <id>
zactax economics studies show <id> --include statistics,percentiles

List analyses for a study (paginated):

zactax economics studies analyses <id>
zactax economics studies analyses <id> --all

List streets for a study (paginated), with optional filters:

zactax economics studies streets <id>
zactax economics studies streets <id> --material asphalt
zactax economics studies streets <id> --type residential --feature-class local

Profitability Variables

List all profitability variables:

zactax economics variables