Create customer building scorecard

Score a building/landlord lead from PLUTO / ACRIS / HPD attributes. Pass attrs to score what you have; leave fetchFromPluto on (default) to backfill missing attributes from NYC Open Data PLUTO + HPD registrations first. Writes score/tier/XRF eligibility onto the customer and a building_scorecard memory fact.

POST/workspaces/{organizationId}/customers/{id}/building-scorecard

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

attrsobject

Show properties

bblstring | null

binstring | null

addressstring | null

boroughstring | null

zipcodestring | null

unitsResnumber | null

unitsTotalnumber | null

buildingSqftnumber | null

assessedTotalDollarsnumber | null

yearBuiltnumber | null

lastSalePriceDollarsnumber | null

lastSaleDatestring | null

hpdRegistrationIdstring | null

hpdManagingAgentstring | null

hpdOwnerNamestring | null

openViolationsCountnumber | null

fetchFromPlutoboolean

Responses

200

Building scorecard breakdown applied to the customer

customerIdstringrequired

attributesobjectrequired

Show properties

bblstring | null

binstring | null

addressstring | null

boroughstring | null

zipcodestring | null

unitsResnumber | null

unitsTotalnumber | null

buildingSqftnumber | null

assessedTotalDollarsnumber | null

yearBuiltnumber | null

lastSalePriceDollarsnumber | null

lastSaleDatestring | null

hpdRegistrationIdstring | null

hpdManagingAgentstring | null

hpdOwnerNamestring | null

openViolationsCountnumber | null

breakdownobjectrequired

Show properties

scorenumberrequired

tierstringrequired

Allowed:ABCD

xrfLeadPaintEligiblebooleanrequired

portfolioScalestringrequired

Allowed:large_multifamilymid_multifamilysmall_multifamilysingle_or_commercial

whyNowstringrequired

factorsobject[]required

Show properties

Array of object

keystringrequired

labelstringrequired

pointsnumberrequired

detailstringrequired

404

Customer not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*idpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/string/building-scorecard' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "attrs": {
    "bbl": "string",
    "bin": "string",
    "address": "string",
    "borough": "string",
    "zipcode": "string",
    "unitsRes": 0,
    "unitsTotal": 0,
    "buildingSqft": 0,
    "assessedTotalDollars": 0,
    "yearBuilt": 0,
    "lastSalePriceDollars": 0,
    "lastSaleDate": "string",
    "hpdRegistrationId": "string",
    "hpdManagingAgent": "string",
    "hpdOwnerName": "string",
    "openViolationsCount": 0
  },
  "fetchFromPluto": true
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/string/building-scorecard", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"attrs\": {\n    \"bbl\": \"string\",\n    \"bin\": \"string\",\n    \"address\": \"string\",\n    \"borough\": \"string\",\n    \"zipcode\": \"string\",\n    \"unitsRes\": 0,\n    \"unitsTotal\": 0,\n    \"buildingSqft\": 0,\n    \"assessedTotalDollars\": 0,\n    \"yearBuilt\": 0,\n    \"lastSalePriceDollars\": 0,\n    \"lastSaleDate\": \"string\",\n    \"hpdRegistrationId\": \"string\",\n    \"hpdManagingAgent\": \"string\",\n    \"hpdOwnerName\": \"string\",\n    \"openViolationsCount\": 0\n  },\n  \"fetchFromPluto\": true\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/string/building-scorecard",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"attrs\": {\n    \"bbl\": \"string\",\n    \"bin\": \"string\",\n    \"address\": \"string\",\n    \"borough\": \"string\",\n    \"zipcode\": \"string\",\n    \"unitsRes\": 0,\n    \"unitsTotal\": 0,\n    \"buildingSqft\": 0,\n    \"assessedTotalDollars\": 0,\n    \"yearBuilt\": 0,\n    \"lastSalePriceDollars\": 0,\n    \"lastSaleDate\": \"string\",\n    \"hpdRegistrationId\": \"string\",\n    \"hpdManagingAgent\": \"string\",\n    \"hpdOwnerName\": \"string\",\n    \"openViolationsCount\": 0\n  },\n  \"fetchFromPluto\": true\n}",
)

Response

{
  "customerId": "string",
  "attributes": {
    "bbl": "string",
    "bin": "string",
    "address": "string",
    "borough": "string",
    "zipcode": "string",
    "unitsRes": 0,
    "unitsTotal": 0,
    "buildingSqft": 0,
    "assessedTotalDollars": 0,
    "yearBuilt": 0,
    "lastSalePriceDollars": 0,
    "lastSaleDate": "string",
    "hpdRegistrationId": "string",
    "hpdManagingAgent": "string",
    "hpdOwnerName": "string",
    "openViolationsCount": 0
  },
  "breakdown": {
    "score": 0,
    "tier": "A",
    "xrfLeadPaintEligible": true,
    "portfolioScale": "large_multifamily",
    "whyNow": "string",
    "factors": [
      {
        "key": "string",
        "label": "string",
        "points": 0,
        "detail": "string"
      }
    ]
  }
}