Developer tool

Command-line interface

Query the world from your terminal, upload local spatial files, and return readable output or exact JSON.

Setup

Terminal

npm install
export OUTERVIEW_API_KEY="YOUR_OUTERVIEW_API_KEY"

Run a query

The CLI provides one command: discover. Use it to explore, test, and export without writing integration code.

Examples

npm run cli -- discover "coffee shops near parks in Toronto" --limit 100
npm run cli -- discover "Find stop signs near my buildings" --file ./buildings.csv --json
npm run cli -- discover "bike parking in Montreal" --no-answer

Options

Run npm run cli -- --help for the complete option list.

--base-url URLURL

Override the API root; defaults to https://api.outerview.ai.

--api-key KEYstring

Supply a key without OUTERVIEW_API_KEY.

--limit N1–2000

Set the maximum number of returned GeoJSON features.

--no-answerflag

Skip answer generation and return results only.

--file PATHrepeatable

Upload a CSV or GeoJSON file.

--area-id UUIDUUID

Constrain discovery to a public Outerview area.

--h3-ids IDSstring

Constrain discovery to one or more H3 cells.

--search-id UUIDUUID

Continue a prior query.

--timeout-ms MSinteger

Set the synchronous request timeout.

--jsonflag

Print the exact API response.