🗄️ API Documentation

NYC Property Scraper API Reference

Property Endpoints

POST /api/property
Create or update a property
GET /api/property/:bbl
Get property details with all documents
GET /api/properties
List all properties (supports ?borough=, ?status=, ?minScore=)
POST /api/property/:bbl/extract
Extract ACRIS documents for a property
POST /api/property/:bbl/extract-all
Full extraction (ACRIS, comparables, violations)
GET /api/property/:bbl/matches
Find matching buyers for a property

Crawl Management Endpoints

GET /api/crawl/targets
List crawl targets (supports ?status=, ?borough=, ?limit=)
GET /api/crawl/next
Get next pending URL to crawl
POST /api/crawl/add
Add single URL to crawl queue
POST /api/crawl/add-bulk
Bulk import URLs (JSON array)
PUT /api/crawl/target/:id
Update crawl target status
GET /crawl/stats
Get crawl statistics (JSON)

Buyer Endpoints

POST /api/buyer
Create or update buyer profile

Dashboard & UI

GET /api/dashboard
Property dashboard (HTML)
GET /crawl
Crawl manager dashboard (HTML)
GET /scrape-url
URL scraper tool (HTML)
GET /analyze
Property investment analyzer (HTML)
POST /api/property/analyze-address
Analyze property by address (JSON)