CLI reference¶
Auto-generated from the sjvair command-line application.
sjvair¶
SJVAir data download CLI.
Usage:
sjvair [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--base-url TEXT Override API base URL.
--api-key TEXT API key for authenticated requests.
--timeout INTEGER Request timeout in seconds.
--quiet Suppress informational output.
--force Overwrite existing output file.
-h, --help Show this message and exit.
calenviroscreen¶
CalEnviroScreen 4.0 census tract scores.
Usage:
sjvair calenviroscreen [OPTIONS]
Options:
--year INTEGER [required]
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
ceidars¶
CEIDARS facility emissions data.
Usage:
sjvair ceidars [OPTIONS]
Options:
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
hms¶
NOAA Hazard Mapping System smoke and fire data.
Usage:
sjvair hms [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
fire¶
Download HMS fire point records.
Usage:
sjvair hms fire [OPTIONS]
Options:
--date TEXT YYYY-MM-DD; defaults to today.
--county TEXT Filter by county name.
--city TEXT Filter by city name.
--zip TEXT Filter by ZIP code.
--tract TEXT Filter by census tract FIPS code.
--urban TEXT Filter by urban area name.
--region-id TEXT Filter by region sqid.
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
smoke¶
Download HMS smoke plume records.
Usage:
sjvair hms smoke [OPTIONS]
Options:
--date TEXT YYYY-MM-DD; defaults to today.
--county TEXT Filter by county name.
--city TEXT Filter by city name.
--zip TEXT Filter by ZIP code.
--tract TEXT Filter by census tract FIPS code.
--urban TEXT Filter by urban area name.
--region-id TEXT Filter by region sqid.
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
monitors¶
Monitor data commands.
Usage:
sjvair monitors [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
closest¶
Up to 3 nearest active monitors with distance and latest entry.
Usage:
sjvair monitors closest [OPTIONS]
Options:
--type TEXT [required]
--lat FLOAT [required]
--lon FLOAT [required]
--output PATH
-h, --help Show this message and exit.
current¶
All active monitors with latest entry for the given type.
Usage:
sjvair monitors current [OPTIONS]
Options:
--type TEXT [required]
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
entries¶
Download monitor entries (bulk export).
Usage:
sjvair monitors entries [OPTIONS]
Options:
--start-date TEXT [required]
--end-date TEXT [required]
--monitor-id TEXT
--from-csv PATH
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--is-sjvair
--scope [resolved|expanded]
--period-months INTEGER
--workers INTEGER
--dry-run
--output PATH [required]
--format [csv|json|yaml]
-h, --help Show this message and exit.
get¶
Get a single monitor by ID.
Usage:
sjvair monitors get [OPTIONS] MONITOR_ID
Options:
-h, --help Show this message and exit.
list¶
List monitors.
Usage:
sjvair monitors list [OPTIONS]
Options:
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--is-sjvair
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
summaries¶
Download monitor summaries.
Usage:
sjvair monitors summaries [OPTIONS]
Options:
--type TEXT [required]
--resolution [hourly|daily|monthly|quarterly|seasonal|yearly]
[required]
--start-date TEXT [required]
--end-date TEXT [required]
--monitor-id TEXT
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--is-sjvair
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
pesticides¶
Pesticide use, notice, and chemical data.
Usage:
sjvair pesticides [OPTIONS]
Options:
--type [use|notice|chemicals|commodities|products|region-use|region-notice|region-summary]
[required]
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
regions¶
Region data commands.
Usage:
sjvair regions [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
get¶
Get a region by ID.
Usage:
sjvair regions get [OPTIONS] REGION_ID
Options:
-h, --help Show this message and exit.
list¶
List regions of a given type.
Usage:
sjvair regions list [OPTIONS]
Options:
--type TEXT [required]
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.
summaries¶
Download region summaries.
Usage:
sjvair regions summaries [OPTIONS]
Options:
--type TEXT [required]
--resolution [hourly|daily|monthly|quarterly|seasonal|yearly]
[required]
--start-date TEXT [required]
--end-date TEXT [required]
--county TEXT
--city TEXT
--zip TEXT
--tract TEXT
--urban TEXT
--region-id TEXT
--output PATH
--format [csv|json|yaml]
-h, --help Show this message and exit.