Stratapine
ArchitectureSign in
v1.0 · stable

API Reference

REST endpoints for accessing Stratapine's UK property intelligence — areas, scoring, watchlists, and discovery.

Base URL
https://api.stratapine.io
Authentication

All requests require a bearer token in the Authorization header.

Authorization: Bearer sk_live_***

Areas

GET/v1/areas— List areas with filters
Response 200
{
  "data": [
    { "id": "a2", "name": "Manchester Northern Quarter", "region": "Manchester",
      "yieldPct": 6.4, "investmentScore": 91, "avgPrice": 285000 }
  ],
  "page": 1, "total": 12400
}
GET/v1/areas/{id}— Get a single area profile
Response 200
{
  "id": "a2", "name": "Manchester Northern Quarter",
  "yieldPct": 6.4, "growth5y": 38, "demandScore": 88,
  "affordability": 64, "riskScore": 28, "investmentScore": 91,
  "trend": [ { "month": "Jan", "price": 281200, "rent": 1530 } ]
}
GET/v1/areas/{id}/comparables— Find similar areas by score
Response 200
{ "comparables": [ { "id": "a4", "score": 85 } ] }

Discovery

GET/v1/search— Full-text search across areas
Response 200
{ "results": [ { "id": "a1", "name": "Shoreditch" } ] }
GET/v1/discover/top— Top investment opportunities
Response 200
{ "results": [ { "id": "a2", "investmentScore": 91 } ] }

Watchlist

GET/v1/watchlist— Current user's saved areas
Response 200
{ "areaIds": ["a2", "a6"] }
POST/v1/watchlist— Add an area
Request body
{ "areaId": "a4" }
Response 200
{ "ok": true }
DELETE/v1/watchlist/{areaId}— Remove an area
Response 200
{ "ok": true }

Scoring

POST/v1/score— Compute composite investment score
Request body
{ "yieldPct": 6.4, "growth5y": 38, "demandScore": 88,
  "affordability": 64, "riskScore": 28, "liquidityScore": 75 }
Response 200
{ "investmentScore": 91 }

Admin

GET/v1/admin/users— List platform users
Response 200
{ "users": [ { "id": "u1", "role": "investor", "plan": "Free" } ] }
PATCH/v1/admin/users/{id}— Update user role/plan/status
Request body
{ "role": "pro", "plan": "Pro" }
Response 200
{ "ok": true }