1. Sign up for an API key
Magic-link signup at permitcore.io/signup. No credit card required for the free tier. After signing in, your API key lives at Account → API Keys. Keys can be created and rotated via either the account dashboard or the programmatic key endpoints.2. Set up your environment
Export your key. Never commit it — treat it like a database password.3. Make your first request
Your first call is/v1/permits — the core listing endpoint. Fetch recent New
York City permits. (To filter to a buyer segment, use the
/v1/permits/target endpoint with
&target_segment=<segment> — /v1/permits itself has no cohort query
parameter.)
4. Read the response
You’ll get back a page of permits initems, plus pagination:
cohort, work_class, permit_type_normalized), scope,
valuation, contractor, dates, data-quality flags, and enrichment. See
GET /v1/permits for the full field list and every
query parameter. To filter to a buyer segment, call
GET /v1/permits/target?jurisdiction=nyc&target_segment=<segment>;
paginate either endpoint with &page= (or, on /v1/permits, an opaque
&cursor= for deep paging).
Want the per-segment counts for a jurisdiction instead of the permit rows? Use
GET /v1/jurisdictions//cohorts/distribution.
5. What next
Cohort taxonomy
The canonical 23 segments + what each one covers.
Authentication
Key formats, header conventions, security best practices.
Rate limits
Per-tier quotas + how to handle 429 responses.
Data licensing
Commercial-use terms + attribution for paid tiers.
API reference
Full endpoint catalog with request/response shapes.
Need help
- Open the API reference for endpoint shapes + the errors page for retry semantics.
- For account, billing, or integration support, email
kian@permitcore.io — include
your key prefix (first 12 characters) and the
x-request-idfrom the failing response for fastest triage.