Skip to content
Docs

StreetEasy building

url is one building link, /building/<slug> (for example /building/solace), as on a listing's building. An unknown building is HTTP 404 and is not charged. A block is HTTP 503 with Retry-After and is not charged.

POST/v1/streeteasy/building
2 creditsTry itStreetEasy API overview →2 (an unknown building and failed requests are free)

Everything StreetEasy publishes about one building.

Address and area, year built, floors and unit count, description, amenities, policies (including pets), rental and sale availability by bedroom count, and nearby schools. An unknown building is a 404 and is not charged.

Request

POSThttps://api.scrapercompany.com/v1/streeteasy/building

Authenticate with your API key in the x-api-key header (see Authentication).

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

  • urlstringrequiredmax length 500

    A StreetEasy building link (/building/<building>), as in a listing's building.

Example request

curl -X POST "https://api.scrapercompany.com/v1/streeteasy/building" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://streeteasy.com/building/solace"
  }'

Response

200 — One building in full. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response
{
  "search_parameters": {
    "engine": "streeteasy_building",
    "url": "https://streeteasy.com/building/solace"
  },
  "id": "6617761",
  "slug": "solace",
  "name": "Solace",
  "url": "https://streeteasy.com/building/solace",
  "type": "Rental building",
  "description": "<p>Solace — 74 St Marks Brooklyn</p>",
  "address": {
    "street": "74 Saint Marks Place",
    "city": "BROOKLYN",
    "state": "NY",
    "zip_code": "11217"
  },
  "area_name": "Park Slope",
  "latitude": 40.681538,
  "longitude": -73.97985,
  "year_built": 2026,
  "floor_count": 18,
  "unit_count": 247,
  "amenities": [
    "DOORMAN",
    "ELEVATOR"
  ],
  "policies": [
    "PETS_ALLOWED",
    "SMOKE_FREE"
  ],
  "pets": {
    "cats_allowed": true,
    "dogs_allowed": true
  },
  "documents_url": "https://streeteasy.com/building/solace/documents",
  "rental_inventory": [
    {
      "bedrooms": "1",
      "available_count": 4,
      "available_min_price": 3550,
      "available_max_price": 4800
    }
  ],
  "sale_inventory": [],
  "schools": [
    {
      "name": "P.S. 282 Park Slope",
      "district": "13",
      "grades": [
        "PK",
        "0K"
      ]
    }
  ],
  "meta": {
    "source": "streeteasy",
    "elapsed_s": 0.5
  }
}
Arrays are shortened to their first items.

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}
No, fix the request
402Payment Required

Not enough credits for this request: the account's credits mode is enforce (mode in GET /v1/billing) and the request costs more than the available credits. Nothing is run or charged.

{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}
No, fix the request
404Not Found

The property, stay, job or record was not found.

{"detail":"job not found"}
No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}
No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (in enforce credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}
Yes, with backoff
503Service Unavailable

Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later.

{"detail":"database unavailable: OperationalError"}
Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

  1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
  2. Copy the cURL example above and run it in a terminal.

Credits

2 credits per successful call (2 (an unknown building and failed requests are free)). Failed, blocked and empty results are free.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support