Developer API

The ce command-line tool

Query community associations, vendors, and statutes, and bulk-export licensed datasets to CSV, straight from your terminal. The CLI is a thin wrapper over the same REST API, with the same key, scopes, and quota.

Install

npm install -g @common-elements/cli

# or run it without installing
npx @common-elements/cli --help

Authenticate

Create a key on the data hub, then set it in your environment. You can also pass --api-key on any command.

export CE_API_KEY=ce_live_your_key

Commands

# Look up associations
ce associations search --state FL --query "sunset" --limit 5
ce associations get <id>

# Vendors and statutes
ce vendors search --state FL --category roofing
ce statutes search "reserve study" --state FL

# Bulk export to CSV (Growth plan or above)
ce export associations --state FL --out fl-associations.csv
ce export vendors --state FL --category roofing > vendors.csv

# Filter and shape the export: a slice, chosen columns, as JSON
ce export associations --state FL --subtype condo --unit-min 100 \
  --columns name,unit_count,city --out fl-large-condos.csv
ce export associations --state FL --format json | jq '.[].name'

Run ce --help for the full option list.

Command reference

Command	What it does
ce associations search	Search associations by name, state, county, and type.
ce associations get <id>	Fetch a single association by id.
ce vendors search	Search the verified vendor directory.
ce statutes search <query>	Full-text search the indexed statutes.
ce export <resource>	Stream a whole resource to CSV (Growth plan or above).

Export resources: associations, vendors, statutes.

Option	Description
--api-key <key>	API key. Overrides CE_API_KEY.
--state <XX>	Two-letter state code, e.g. FL.
--county <name>	County name.
--subtype <t>	Association type: condo, hoa, or coop.
--category <slug>	Vendor category slug, e.g. roofing.
--query <text>	Free-text query (name match on export).
--limit <n>	Maximum results for a search.
-h, --help	Show help.
-v, --version	Show the version.

Export options

Narrow, shape, and format a bulk export.

Option	Description
--columns <keys>	Comma-separated columns to include (default: all).
--format <fmt>	csv (default) or json.
--unit-min <n>	Minimum unit count (associations).
--unit-max <n>	Maximum unit count (associations).
--year-min <yyyy>	Earliest formation year (associations).
--year-max <yyyy>	Latest formation year (associations).
--claimed <bool>	true or false — only claimed / unclaimed (associations).
--mgmt <name>	Management-company name match (associations).
--chapter <n>	Statute chapter number (statutes).
--topic <slug>	Statute topic (statutes).
--out <file>	Write the export to a file instead of stdout.

Output and scripting

Search and lookup print JSON to stdout, so they compose with tools like jq. Exports write to stdout or to a file with --out, as CSV by default or as JSON with --format json (so exports pipe into jq too). The CLI exits 0 on success and 1 on any error, printing the message to stderr.

# Names of the 10 largest condos in Florida
ce associations search --state FL --subtype condo --limit 10 \
  | jq -r '.data[].name'

# Pipe a filtered export straight into another tool
ce export vendors --state FL --category roofing | wc -l

Plans and limits

Search and lookup work on any plan, including the free tier. Bulk exportneeds the Growth plan or above and returns up to your tier’s row cap. One export counts as one request against your monthly quota, not one per row. Compare plans.