Snapshot-bound, paginated StreetProof PBI city records

get/api/v1/city/{city}/index

Request

Base URL: https://streetproof.com
URL: https://streetproof.com/api/v1/city/{city}/index
Auth: none required

Path parameters

citystring required

City slug

Query parameters

industrystring

ranking_state'eligible' | 'insufficient_evidence' | 'frozen'

claim_status'claimed' | 'unclaimed'

limitinteger

cursorstring

Opaque next_cursor from the previous page. It carries the frozen query filters.

Response

One stable page from a 30-minute immutable snapshot. Only aggregate statistics expressly marked open are CC BY 4.0; entity records and PPS remain governed by the StreetProof Terms.

launch_status'launched' | 'collecting' | 'planned'

coverage_status_deprecatedtrue

coverage_status'active' | 'collecting' | 'planned'

coverage_messagestring

demandobject nullable

data_availableboolean

industrystring nullable

ranking_state'eligible' | 'insufficient_evidence' | 'frozen' | 'null' nullable

claim_status'claimed' | 'unclaimed' | 'null' nullable

licensestring

returned_countinteger

total_countinteger

countinteger

Compatibility alias for returned_count.

has_moreboolean

next_cursorstring nullable

snapshot_idstring uuid nullable

methodology_urlstring uri

data_as_ofstring date-time

Server-authoritative timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.