apartment-fax-cli
v0.1.0
Published
Official command-line tool for the Apartment Fax public API.
Maintainers
Readme
Apartment Fax CLI
The official command-line tool for Apartment Fax's public API. It prints JSON for NYC address normalization, public apartment previews, and service health.
- Product: apartmentfaxnyc.com
- Developer resources: apartmentfaxnyc.com/developers
- Source: Potarix/apartment-fax
Run
npx apartment-fax-cli resolve "117 West 13 Street" --unit 45
npx apartment-fax-cli preview 213-e-10th-st-apt-4r
npx apartment-fax-cli healthInstall it globally to use the shorter command:
npm install --global apartment-fax-cli
apartment-fax --helpNode.js 18 or newer is required.
Scope
The CLI uses Apartment Fax's public, read-only endpoints. It cannot create orders, submit payments, collect email addresses, or retrieve paid customer reports.
