NYC and US property records: owners, LLC officers, mortgages, pre-foreclosures and investors.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Buy a credit pack with a machine payment (Stripe MPP: card through a shared payment token, or stablecoin). No account or sign-in needed. Packs: starter_80 = 80 credits for $9.99; pack_200 = 200 credits for $24.99; pack_550 = 550 credits for $59.99; pack_1500 = 1500 credits for $149.99. Pay by card (Stripe Link shared payment token, the default) or by stablecoin (USDC on Tempo): set method. The first call returns a payment challenge (JSON-RPC error -32042). Pay it and call again with the credential in _meta. With no API key, a new workspace is created and its API key is returned once: store it and send it as Authorization: Bearer <key>. With an API key or a signed-in account, the credits are added to that workspace. The first card or Link purchase from each payer gets 50% bonus credits.
Which pack to buy: starter_80 (80 credits, $9.99), pack_200 (200 credits, $24.99), pack_550 (550 credits, $59.99), pack_1500 (1500 credits, $149.99).
How to pay: card (Stripe Link shared payment token, the default) or stablecoin (USDC on Tempo).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Buy a credit pack with a machine payment (Stripe MPP: card through a shared payment token, or stablecoin). No account or sign-in needed. Packs: starter_80 = 80 credits for $9.99; pack_200 = 200 credits for $24.99; pack_550 = 550 credits for $59.99; pack_1500 = 1500 credits for $149.99. Pay by card (Stripe Link shared payment token, the default) or by stablecoin (USDC on Tempo): set method. The first call returns a payment challenge (JSON-RPC error -32042). Pay it and call again with the credential in _meta. With no API key, a new workspace is created and its API key is returned once: store it and send it as Authorization: Bearer <key>. With an API key or a signed-in account, the credits are added to that workspace. The first card or Link purchase from each payer gets 50% bonus credits.
| Argument | Type | Description |
|---|---|---|
| pack* | string | Which pack to buy: starter_80 (80 credits, $9.99), pack_200 (200 credits, $24.99), pack_550 (550 credits, $59.99), pack_1500 (1500 credits, $149.99). |
| method | string | How to pay: card (Stripe Link shared payment token, the default) or stablecoin (USDC on Tempo). |
{
"type": "object",
"required": [
"pack"
],
"properties": {
"pack": {
"type": "string",
"description": "Which pack to buy: starter_80 (80 credits, $9.99), pack_200 (200 credits, $24.99), pack_550 (550 credits, $59.99), pack_1500 (1500 credits, $149.99)."
},
"method": {
"enum": [
"card",
"stablecoin"
],
"type": "string",
"default": "card",
"description": "How to pay: card (Stripe Link shared payment token, the default) or stablecoin (USDC on Tempo)."
}
}
}Free. Finds New York City tax lots by address, e.g. "40 Water Street Manhattan". Returns each match's BBL for get_nyc_property. NYC only; for other US properties use the national property tools.
| Argument | Type | Description |
|---|---|---|
| query* | string | An NYC street address. |
{
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"maxLength": 120,
"minLength": 3,
"description": "An NYC street address."
}
}
}Shows the credit balance of the user's workspace, credits spent today, and recent charges. Free; never spends credits. Use it when the user asks about credits, or before a search that would cost more than the balance.
No arguments.
{
"type": "object",
"properties": {}
}Free, no sign-in. Describes Hercules: what it covers (every NYC tax lot, NYC pre-foreclosures, nationwide US property records, LLC owners and investors), every tool and whether it spends credits, plan and credit prices, and how to connect an account. Call it first when the user asks what Hercules can do or what it costs.
No arguments.
{
"type": "object",
"properties": {}
}Free. Lists the NYC buildings linked to a person from search_nyc_owners, and whether each is held as the owner of record or through a company. The full list is on the Platinum plan; other plans see the first few buildings.
| Argument | Type | Description |
|---|---|---|
| cursor | any | |
| personKey* | string |
{
"type": "object",
"required": [
"personKey"
],
"properties": {
"cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
],
"default": null
},
"personKey": {
"type": "string",
"pattern": "^[a-z]+\\|[a-z]+$",
"maxLength": 120,
"minLength": 3
}
}
}Spends 1 credit, unless this workspace already pulled the record, then free. Returns the full record for one NYC preforeclosure: case and index number, stage, lender, amounts owed and due, mortgage, owner of record and building facts. NYC preforeclosures only; take the id from search_nyc_preforeclosures. Tell the user it costs 1 credit before calling.
| Argument | Type | Description |
|---|---|---|
| id* | string | The id of a row from search_nyc_preforeclosures. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The id of a row from search_nyc_preforeclosures."
}
}
}Free. Returns the public facts for one NYC lot (building, lot, units, year built, last sale) and the owner of record from the city lot file. Also says whether the full report is already unlocked for this workspace and what unlock_nyc_property_report and unlock_nyc_owner_contacts cost. When the report is already unlocked it is returned in full.
| Argument | Type | Description |
|---|---|---|
| bbl* | string | The 10-digit NYC borough-block-lot id, e.g. "1000300034". Get it from find_nyc_property. |
{
"type": "object",
"required": [
"bbl"
],
"properties": {
"bbl": {
"type": "string",
"pattern": "^[1-5][0-9]{9}$",
"description": "The 10-digit NYC borough-block-lot id, e.g. \"1000300034\". Get it from find_nyc_property."
}
}
}Free. Reads one unit inside an NYC building: a condominium unit (its own tax lot) or a co-op apartment (shares, valued here by an estimate from recent sales in its line). Pass the building lot from find_nyc_property and the unit as the person wrote it, e.g. "14E", "Apt 1C" or "#PH-A". Use it whenever the person names a unit, apartment or penthouse; the building lot alone describes the whole building, not the unit.
| Argument | Type | Description |
|---|---|---|
| bbl* | string | The building's 10-digit lot (BBL) from find_nyc_property. |
| unit | string | Leave out to list the building's units. |
{
"type": "object",
"required": [
"bbl"
],
"properties": {
"bbl": {
"type": "string",
"pattern": "^[1-5]\\d{9}$",
"description": "The building's 10-digit lot (BBL) from find_nyc_property."
},
"unit": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Leave out to list the building's units."
}
}
}Spends 2 credits, unless this workspace pulled the same property in the last 7 days, then free. Returns the full record for one property from a national search: owners of record, building and lot, value and equity, open mortgages and lenders, foreclosure filings and last sale. Take property_id (it starts with "prop_") from run_national_property_search or run_active_investor_search. Tell the user it costs 2 credits and get their go-ahead before calling. For NYC preforeclosures use get_nyc_preforeclosure_detail instead.
| Argument | Type | Description |
|---|---|---|
| property_id* | string | A property id from a national search result, e.g. prop_123456. |
{
"type": "object",
"required": [
"property_id"
],
"properties": {
"property_id": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "A property id from a national search result, e.g. prop_123456."
}
}
}Finds who is actively buying in an area: properties in a zip, city or county owned by investors, grouped by owner when run. By default it looks for owners of 2+ properties who bought in this area in the last 12 months. Options: minPurchasesLast12Months keeps owners who bought at least N properties in the last 12 months. That count covers the owner's whole portfolio, not only this area, so it is the closest available measure of 'bought N+ here'; boughtWithinMonths keeps it to owners who bought here recently. corporateOnly keeps companies and LLCs. cashInvestorOnly keeps properties bought with cash by an absentee investor. outOfStateOnly keeps owners who live in another state. Each property record costs credits, the same as a national property search. Never spends credits: it counts the matches and prices one batch. Always quote first. Then tell the user the credit cost, the batch size and their balance after. Records this workspace already pulled in the last 24 hours are free. For large searches, prefer a smaller batch (limit) or narrower filters, such as a zip instead of a county. One run returns at most 250 records; page with offset. Quotes expire after 10 minutes. Call run_active_investor_search with the quote_id only after the user agrees to the credit cost.
| Argument | Type | Description |
|---|---|---|
| zip | any | Five-digit zip code. The narrowest and cheapest place filter. |
| city | any | City name. |
| limit | any | Records to price in this batch (max 250). Leave empty to let the quote pick a safe batch size. |
| state* | string | Two-letter state code, e.g. TX. Required. |
Use to find real estate investor and lender firms in a state or city: hard-money lenders, private money lenders, note buyers, fix-and-flip investors, investment funds, cash home buyers and wholesalers. Returns firms with business phones, business emails, website and key people (name and title only). Free: this tool only returns a quote and never spends credits. The quote states the cost per firm returned; firms not found cost nothing. Tell the user the cost and ask. Only after the user agrees, call run_investor_firm_search with the quote_id. To find who is actively buying properties in an area, use quote_active_investor_search instead.
| Argument | Type | Description |
|---|---|---|
| city | string | City to search in. Leave out to search the whole state. |
| state* | string | Two-letter US state, e.g. TX. |
| maxResults | integer | Most firms to return, 1-25. Default 10. |
| investorType* | string | The kind of firm: hard_money_lender (hard-money lenders), private_lender (private money lenders), note_buyer (mortgage note buyers), fix_and_flip (fix-and-flip investors), real_estate_fund (real estate investment funds), cash_home_buyer (cash home buyers), wholesaler (real estate wholesalers). |
{
"type": "object",
"required": [
"investorType",
"state"
],
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "City to search in. Leave out to search the whole state."
},
"state": {
"enum": [
"AL",
"AK",
"AZ",
"AR",
"CA",
"CO",
"CT",
"DE",
"FL",
"GA",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VA",
"WA",
"WV",
"WI",
"WY",
"DC",
"PR"
],
"type": "string",
"description": "Two-letter US state, e.g. TX."
},
"maxResults": {
"type": "integer",
"maximum": 25,
"minimum": 1,
"description": "Most firms to return, 1-25. Default 10."
},
"investorType": {
"enum": [
"hard_money_lender",
"private_lender",
"note_buyer",
"fix_and_flip",
"real_estate_fund",
"cash_home_buyer",
"wholesaler"
],
"type": "string",
"description": "The kind of firm: hard_money_lender (hard-money lenders), private_lender (private money lenders), note_buyer (mortgage note buyers), fix_and_flip (fix-and-flip investors), real_estate_fund (real estate investment funds), cash_home_buyer (cash home buyers), wholesaler (real estate wholesalers)."
}
}
}Use to find who is behind an LLC or company, for example the LLC that owns a property: its officers or managers, registered agent and formation details from public business records. Free: this tool only returns a quote and never spends credits. The quote states the credit cost (charged only if the company is found) and what that state's public records show; some states list the company but not its officers. Tell the user the cost and that note, and ask. Only after the user agrees, call run_llc_owner_lookup with the quote_id. Pass the company's exact registered name and the state where it is registered.
| Argument | Type | Description |
|---|---|---|
| state* | string | Two-letter US state where the company is registered, e.g. FL. Often the state of the property. |
| entityName* | string | The company's registered name, as on the deed or tax record, e.g. "Sunrise Holdings LLC". |
{
"type": "object",
"required": [
"entityName",
"state"
],
"properties": {
"state": {
"enum": [
"AL",
"AK",
"AZ",
"AR",
"CA",
"CO",
"CT",
"DE",
"FL",
"GA",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VA",
"WA",
"WV",
"WI",
"WY",
"DC",
"PR"
],
"type": "string",
"description": "Two-letter US state where the company is registered, e.g. FL. Often the state of the property."
},
"entityName": {
"type": "string",
"maxLength": 200,
"minLength": 2,
"description": "The company's registered name, as on the deed or tax record, e.g. \"Sunrise Holdings LLC\"."
}
}
}Quotes a search of national property data: any US property, including NYC properties that are not in preforeclosure. Filters: place (state plus zip, city or county), property type, beds, baths, value, equity, year built, distress flags (preforeclosure, foreclosure, auction, bank-owned, vacant, absentee owner, high equity, free and clear, inherited) and owner filters (company-owned, out-of-state owner, cash buyer, owners of N+ properties, last sale dates). Never spends credits: it counts the matches and prices one batch. Always quote first. Then tell the user the credit cost, the batch size and their balance after. Records this workspace already pulled in the last 24 hours are free. For large searches, prefer a smaller batch (limit) or narrower filters, such as a zip instead of a county. One run returns at most 250 records; page with offset. Quotes expire after 10 minutes. Call run_national_property_search with the quote_id only after the user agrees to the credit cost.
| Argument | Type | Description |
|---|---|---|
| zip | any | Five-digit zip code. The narrowest and cheapest place filter. |
| city | any | City name. |
| flags | array | Only properties with all of these: pre_foreclosure, foreclosure, auction, reo (bank-owned), vacant, absentee_owner, high_equity, free_clear (no mortgage), inherited, death (owner deceased, a probate signal), judgment (judgment lien), tax_lien, mls_cancelled (listing cancelled or expired, a failed sale), negative_equity. |
| limit | any | Records to price in this batch (max 250). Leave empty to let the quote pick a safe batch size. |
Returns the investors and their properties from a quote made by quote_active_investor_search, grouped by owner with portfolio size and purchases in the last 12 months. Spends credits. Takes only a quote_id. Charges for the records returned, never more than the quote, and releases the rest. Before calling, the user must have agreed to the quoted credit cost. A quote runs once and expires after 10 minutes.
| Argument | Type | Description |
|---|---|---|
| quote_id* | string | The quoteId returned by quote_active_investor_search. |
{
"type": "object",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The quoteId returned by quote_active_investor_search."
}
}
}Spends credits. Runs a quote from quote_investor_firm_search and returns the firms with business phones, business emails, website and key people (name and title only). Charges per firm returned, never more than the quote. No firms found costs nothing. Call only after the user agreed to the quoted cost. A quote runs once and expires after 10 minutes.
| Argument | Type | Description |
|---|---|---|
| quote_id* | string | The quoteId from quote_investor_firm_search. |
{
"type": "object",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The quoteId from quote_investor_firm_search."
}
}
}Spends credits. Runs a quote from quote_llc_owner_lookup and returns the company's officers or managers, registered agent and formation details. Charges only if the company is found, never more than the quote. A company that is not found costs nothing. Call only after the user agreed to the quoted cost. A quote runs once and expires after 10 minutes.
| Argument | Type | Description |
|---|---|---|
| quote_id* | string | The quoteId from quote_llc_owner_lookup. |
{
"type": "object",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The quoteId from quote_llc_owner_lookup."
}
}
}Returns the property records from a quote made by quote_national_property_search. Spends credits. Takes only a quote_id. Charges for the records returned, never more than the quote, and releases the rest. Before calling, the user must have agreed to the quoted credit cost. A quote runs once and expires after 10 minutes. Use get_property_detail on a record id for the full record.
| Argument | Type | Description |
|---|---|---|
| quote_id* | string | The quoteId returned by quote_national_property_search. |
{
"type": "object",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The quoteId returned by quote_national_property_search."
}
}
}Spends credits. Returns the NYC preforeclosure rows from a quote made by search_nyc_preforeclosures and charges the quoted credits (never more). Before calling, tell the user how many credits it costs and get their go-ahead. Quotes expire after 10 minutes and run once.
| Argument | Type | Description |
|---|---|---|
| quote_id* | string | The quote.quoteId from search_nyc_preforeclosures. |
{
"type": "object",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The quote.quoteId from search_nyc_preforeclosures."
}
}
}Spends credits. Returns the NYC signal rows from a quote made by search_nyc_signals and charges the quoted credits (never more). Before calling, tell the user how many credits it costs and get their go-ahead. Quotes expire after 10 minutes and run once.
| Argument | Type | Description |
|---|---|---|
| quote_id* | string | The quote.quoteId from search_nyc_signals. |
{
"type": "object",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The quote.quoteId from search_nyc_signals."
}
}
}Spends credits. Returns the NYC underused-building rows from a quote made by search_nyc_underused_properties and charges the quoted credits (never more). Before calling, tell the user how many credits it costs and get their go-ahead. Quotes expire after 10 minutes and run once.
| Argument | Type | Description |
|---|---|---|
| quote_id* | string | The quote.quoteId from search_nyc_underused_properties. |
{
"type": "object",
"required": [
"quote_id"
],
"properties": {
"quote_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The quote.quoteId from search_nyc_underused_properties."
}
}
}Free. Finds people who own or control NYC buildings, by name, directly or through companies. Returns each person's key, building count and boroughs. Use get_nyc_owner_portfolio with the key to list their buildings.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| includeManagers | boolean |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 2
},
"includeManagers": {
"type": "boolean",
"default": false
}
}
}Searches NYC properties in preforeclosure only: lis pendens foreclosure filings in Manhattan, Brooklyn, Queens, the Bronx and Staten Island. For one NYC property by address use find_nyc_property; for filtered searches or properties outside NYC use the national property search tools. Filters: borough, foreclosure stage, equity (1-3 family homes only), case age, recently added and amount owed. Returns summary rows, newest first, up to 25 per call (default 10); page with offset. Each row carries the lot's bbl when known. For the owner's phone and email on a row, call get_nyc_property with that bbl, then unlock_nyc_owner_contacts; never search the web for it. Never spends credits. On any paid plan the first 25 summary rows each day are free; other workspaces pay for every row. Rows the workspace already pulled are free again. Past the free rows, rows cost 1 credit per 10, and this tool returns them as a quote instead: tell the user the credit cost and ask before calling run_nyc_preforeclosure_search with the quote_id.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Rows to return, 1 to 25. Defaults to 10. |
| stage | array | Foreclosure stages to include. Empty means every stage. |
| equity | array | Estimated equity: positive (value above the debt) or negative, known for 1-3 family homes only. Empty means any. |
| offset | integer | Rows to skip, for the next page. |
| borough | array | NYC boroughs to include. Empty means all five. |
Free. Never spends credits. Lists NYC lots, condo units and co-op apartments that match building, sale, value, equity and owner filters, 20 rows per page. For condo or co-op owners, set filters.grain to unit (it is set for you when the asset classes are only condo and co-op): each condo or co-op row is then one condo unit or co-op apartment with its own last sale, estimated value, equity and owner, and names its building. When the person asks for the buildings, set grain to lot. Estimated value (estValueMin, estValueMax) is a sale-based estimate from comparable sales; always say estimated. The city's market value is never shown or filtered. On lots, equity is estimated for 1-3 family homes only. A co-op apartment with no open share loan has 100% equity; with an open share loan its equity is unknown and it never matches an equity filter. ownerBuildingsMin and ownerBuildingsMax count the owner's properties, buildings and units together. Filters the user's plan does not include are left off and named in the result. For one unit's details, call get_nyc_unit with the building BBL and the unit.
| Argument | Type | Description |
|---|---|---|
| zips | array | NYC ZIP codes the person named. |
| cursor | string | nextCursor from the previous page. |
| filters | object | The same filters as the Hercules NYC map: assetClasses (condo, coop, one_two_family and more), sale price and dates, estValueMin and estValueMax, equityPctMin, ownerBuildingsMin and ownerBuildingsMax, ownedYearsMin, absenteeOwnerOnly, zips, ntas, signals and more. Leave out anything the person did not ask for. |
| boroughs | array | Whole NYC boroughs. For part of a borough use filters.ntas. |
Lists NYC lots that carry one or more property signals: reasons a deal can happen, such as a loan coming due, an old mortgage not refinanced, a long-time owner, an absentee or company owner, a foreclosure case, the tax lien sale list, open code violations, a vacate order, unused air rights, a teardown lot or a rezoning. Use it for asks like these, with these keys: loans coming due or maturing: loan_maturing; old mortgage, not refinanced: aging_mortgage; long holds or long-time owners: long_hold; likely or motivated sellers: long_hold, absentee_owner, serial_seller, value_below_loan; tired landlords or distressed owners: code_violations, hpd_litigation, tax_lien, vacate_order; underwater or over-leveraged: value_below_loan; free and clear, no mortgage: no_recorded_debt; development sites or air rights: underbuilt, teardown, vacant_land, assemblage; new construction or rezonings: new_building_permit, rezoning_filed, entitled_not_built; recent sales or active buyers: just_sold, serial_buyer. Narrow by boroughs, ZIP codes, neighborhoods (ntas) and building types. Each row gives the BBL, address, owner of record and every signal on the lot with its date. Signals marked likely are estimates; say likely when you repeat them. The result also counts lots per signal in the area. Never spends credits. On any paid plan the first 25 rows each day are free; other workspaces pay for every row. Rows already pulled are free again. Past the free rows, rows cost 1 credit per row, and this tool returns them as a quote: tell the user the credit cost and ask before calling run_nyc_signals_search with the quote_id. No contacts in the result: use unlock_nyc_property_report and then unlock_nyc_owner_contacts on a BBL for the owner's phones and emails. Up to 50 rows per call (default 25), newest signal first; page with offset.
| Argument | Type | Description |
|---|---|---|
| ntas | array | 2020 neighborhood codes from find_nyc_area, for example BK0102 Williamsburg. Use them whenever the person names a neighborhood. |
| zips |
Lists NYC buildings with unused or vacant space: office buildings, school buildings and religious property (churches, convents, synagogues) in any of the five boroughs. A building is flagged when its owner reports it half occupied or less, half or more of its storefronts are reported vacant, it is listed for lease, a city order to vacate it is in force, or it is a school building with no school registered in it. Buildings listed for sale are returned too. Each row gives the BBL, address, owner of record, building size and every figure behind the flag, marked owner-reported, seen or inferred, with its date. The underused flag itself is derived. Never spends credits. On any paid plan the first 25 rows each day are free; other workspaces pay for every row. Rows already pulled are free again. Past the free rows, rows cost 1 credit per row, and this tool returns them as a quote: tell the user the credit cost and ask before calling run_nyc_underused_search with the quote_id. No contacts in the result: use unlock_nyc_property_report and then unlock_nyc_owner_contacts on a BBL for the owner's phones and emails. Up to 50 rows per call (default 25), largest buildings first; page with offset.
| Argument | Type | Description |
|---|---|---|
| use | string | office (office buildings), school (school buildings) or religious (churches, convents, synagogues and other property of religious owners). Every use when omitted. |
| ntas | array | 2020 neighborhood codes from find_nyc_area, for example MN0801 Upper East Side-Lenox Hill-Roosevelt Island. Use them whenever the person names a neighborhood, so rows outside it are never quoted. |
| zips | array | NYC ZIP codes. Combined with ntas as any of those places. |
Buys a credit pack on the workspace's saved card, the card it already paid Hercules with. There is no checkout page. Packs: 200 credits for $24.99; 550 credits for $59.99; 1500 credits for $149.99. Before you call it, confirm the pack and the price with the user, unless the user already told you to top up or to keep credits topped up. It charges only when an owner or admin allowed AI top-ups, and only up to the workspace's monthly cap. When AI top-ups are not allowed yet, it charges nothing and returns a one-click approval link for the user. When no card is saved, it charges nothing and returns a link where the user can buy the pack once.
| Argument | Type | Description |
|---|---|---|
| credits* | integer | How many credits to buy. Must be one of the credit pack sizes. |
{
"type": "object",
"required": [
"credits"
],
"properties": {
"credits": {
"type": "integer",
"maximum": 9007199254740991,
"description": "How many credits to buy. Must be one of the credit pack sizes.",
"exclusiveMinimum": 0
}
}
}Spends credits: the contacts price from get_nyc_property (usually 3 credits). Takes only the lot's BBL, including a condo unit's BBL from get_nyc_unit; for a unit whose report is locked it first unlocks the unit report (its report price, usually 1 credit), so quote both. Returns how to reach the party in control of that lot: a name, phone numbers (with line type and do-not-call flag) and email addresses, the contact's role (owner, principal, permit filer, owner's representative or office line), the date the contact was found and the newest recorded deed, lease or transfer. When a recorded deed, lease or transfer names a newer party than the city tax roll, that party is the one looked up. Needs the full report unlocked first (unlock_nyc_property_report). Free if already unlocked for this workspace. Credits are charged when a contact is returned, whatever its role; a miss costs nothing. When an unlocked contact is marked stale (a deed, lease or transfer was recorded after it was found, or it is old), call again with refresh: true to look it up again at the normal price; without refresh a repeat call is always free. Tell the user the cost and get their go-ahead before calling.
| Argument | Type | Description |
|---|---|---|
| bbl* | string | The 10-digit NYC borough-block-lot id, e.g. "1000300034". Get it from find_nyc_property. |
| refresh | boolean | Look a stale unlocked contact up again at the normal price. Ignored unless the contact is stale. |
{
"type": "object",
"required": [
"bbl"
],
"properties": {
"bbl": {
"type": "string",
"pattern": "^[1-5][0-9]{9}$",
"description": "The 10-digit NYC borough-block-lot id, e.g. \"1000300034\". Get it from find_nyc_property."
},
"refresh": {
"type": "boolean",
"default": false,
"description": "Look a stale unlocked contact up again at the normal price. Ignored unless the contact is stale."
}
}
}Spends credits: the report price from get_nyc_property (usually 1 credit). Free if this workspace unlocked the same lot in the last year. Returns the full NYC property report: owners and mailing address, deed and mortgage history, sales, DOB permits, HPD/DOB/ECB violations, tax bills and assessments, zoning and FAR with unused air rights, HPD registration contacts, pre-foreclosure case and tax-lien flags. Tell the user the cost and get their go-ahead before calling.
| Argument | Type | Description |
|---|---|---|
| bbl* | string | The 10-digit NYC borough-block-lot id, e.g. "1000300034". Get it from find_nyc_property. |
{
"type": "object",
"required": [
"bbl"
],
"properties": {
"bbl": {
"type": "string",
"pattern": "^[1-5][0-9]{9}$",
"description": "The 10-digit NYC borough-block-lot id, e.g. \"1000300034\". Get it from find_nyc_property."
}
}
}| county | any | County name, without the word County. |
| offset | integer | Skip this many matches. Use it to quote the next page. |
| propertyType | any | SFR single family, MFR multifamily, CONDO, LAND, MOBILE or OTHER. |
| corporateOnly | boolean | Only companies and LLCs. |
| outOfStateOnly | boolean | Only owners whose mailing address is in another state. |
| cashInvestorOnly | boolean | Only properties bought with cash by an absentee investor. |
| boughtWithinMonths | any | Only properties in this area bought in the last N months. Default 12. Null means any time. |
| minPropertiesOwned | any | Only owners with at least this many properties. Default 2. |
| minPurchasesLast12Months | any | Only owners who bought at least this many properties in the last 12 months, counted across their whole portfolio. |
{
"type": "object",
"required": [
"state"
],
"properties": {
"zip": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{5}$"
},
{
"type": "null"
}
],
"default": null,
"description": "Five-digit zip code. The narrowest and cheapest place filter."
},
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 80,
"minLength": 1
},
{
"type": "null"
}
],
"default": null,
"description": "City name."
},
"limit": {
"anyOf": [
{
"type": "integer",
"maximum": 250,
"minimum": 1
},
{
"type": "null"
}
],
"default": null,
"description": "Records to price in this batch (max 250). Leave empty to let the quote pick a safe batch size."
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code, e.g. TX. Required."
},
"county": {
"anyOf": [
{
"type": "string",
"maxLength": 80,
"minLength": 1
},
{
"type": "null"
}
],
"default": null,
"description": "County name, without the word County."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 100000,
"minimum": 0,
"description": "Skip this many matches. Use it to quote the next page."
},
"propertyType": {
"anyOf": [
{
"enum": [
"SFR",
"MFR",
"LAND",
"CONDO",
"MOBILE",
"OTHER"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "SFR single family, MFR multifamily, CONDO, LAND, MOBILE or OTHER."
},
"corporateOnly": {
"type": "boolean",
"default": false,
"description": "Only companies and LLCs."
},
"outOfStateOnly": {
"type": "boolean",
"default": false,
"description": "Only owners whose mailing address is in another state."
},
"cashInvestorOnly": {
"type": "boolean",
"default": false,
"description": "Only properties bought with cash by an absentee investor."
},
"boughtWithinMonths": {
"anyOf": [
{
"type": "integer",
"maximum": 60,
"minimum": 1
},
{
"type": "null"
}
],
"default": 12,
"description": "Only properties in this area bought in the last N months. Default 12. Null means any time."
},
"minPropertiesOwned": {
"anyOf": [
{
"type": "integer",
"maximum": 10000,
"minimum": 2
},
{
"type": "null"
}
],
"default": null,
"description": "Only owners with at least this many properties. Default 2."
},
"minPurchasesLast12Months": {
"anyOf": [
{
"type": "integer",
"maximum": 100,
"minimum": 1
},
{
"type": "null"
}
],
"default": null,
"description": "Only owners who bought at least this many properties in the last 12 months, counted across their whole portfolio."
}
}
}| state* | string | Two-letter state code, e.g. TX. Required. |
| county | any | County name, without the word County. |
| offset | integer | Skip this many matches. Use it to quote the next page. |
| bedsMin | any |
| bathsMin | any |
| valueMax | any |
| valueMin | any |
| cashBuyer | boolean | Only properties bought with cash. |
| propertyType | any | SFR single family, MFR multifamily, CONDO, LAND, MOBILE or OTHER. |
| yearBuiltMax | any |
| yearBuiltMin | any |
| lastSoldAfter | any | Last sale on or after this date. |
| corporateOwned | boolean | Only properties owned by a company or LLC. |
| lastSoldBefore | any | Last sale on or before this date. |
| outOfStateOwner | boolean | Only owners whose mailing address is in another state. |
| equityPercentMin | any | Minimum estimated equity, in percent. |
| ownerPropertiesMin | any | Only owners who own at least this many properties. |
{
"type": "object",
"required": [
"state"
],
"properties": {
"zip": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{5}$"
},
{
"type": "null"
}
],
"default": null,
"description": "Five-digit zip code. The narrowest and cheapest place filter."
},
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 80,
"minLength": 1
},
{
"type": "null"
}
],
"default": null,
"description": "City name."
},
"flags": {
"type": "array",
"items": {
"enum": [
"pre_foreclosure",
"foreclosure",
"auction",
"reo",
"vacant",
"absentee_owner",
"high_equity",
"free_clear",
"inherited",
"death",
"judgment",
"tax_lien",
"mls_cancelled",
"negative_equity"
],
"type": "string"
},
"default": [],
"maxItems": 14,
"description": "Only properties with all of these: pre_foreclosure, foreclosure, auction, reo (bank-owned), vacant, absentee_owner, high_equity, free_clear (no mortgage), inherited, death (owner deceased, a probate signal), judgment (judgment lien), tax_lien, mls_cancelled (listing cancelled or expired, a failed sale), negative_equity."
},
"limit": {
"anyOf": [
{
"type": "integer",
"maximum": 250,
"minimum": 1
},
{
"type": "null"
}
],
"default": null,
"description": "Records to price in this batch (max 250). Leave empty to let the quote pick a safe batch size."
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code, e.g. TX. Required."
},
"county": {
"anyOf": [
{
"type": "string",
"maxLength": 80,
"minLength": 1
},
{
"type": "null"
}
],
"default": null,
"description": "County name, without the word County."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 100000,
"minimum": 0,
"description": "Skip this many matches. Use it to quote the next page."
},
"bedsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 50,
"minimum": 0
},
{
"type": "null"
}
],
"default": null
},
"bathsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 50,
"minimum": 0
},
{
"type": "null"
}
],
"default": null
},
"valueMax": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"default": null
},
"valueMin": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"default": null
},
"cashBuyer": {
"type": "boolean",
"default": false,
"description": "Only properties bought with cash."
},
"propertyType": {
"anyOf": [
{
"enum": [
"SFR",
"MFR",
"LAND",
"CONDO",
"MOBILE",
"OTHER"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "SFR single family, MFR multifamily, CONDO, LAND, MOBILE or OTHER."
},
"yearBuiltMax": {
"anyOf": [
{
"type": "integer",
"maximum": 2200,
"minimum": 1600
},
{
"type": "null"
}
],
"default": null
},
"yearBuiltMin": {
"anyOf": [
{
"type": "integer",
"maximum": 2200,
"minimum": 1600
},
{
"type": "null"
}
],
"default": null
},
"lastSoldAfter": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
],
"default": null,
"description": "Last sale on or after this date."
},
"corporateOwned": {
"type": "boolean",
"default": false,
"description": "Only properties owned by a company or LLC."
},
"lastSoldBefore": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
],
"default": null,
"description": "Last sale on or before this date."
},
"outOfStateOwner": {
"type": "boolean",
"default": false,
"description": "Only owners whose mailing address is in another state."
},
"equityPercentMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100,
"minimum": 0
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum estimated equity, in percent."
},
"ownerPropertiesMin": {
"anyOf": [
{
"type": "integer",
"maximum": 10000,
"minimum": 1
},
{
"type": "null"
}
],
"default": null,
"description": "Only owners who own at least this many properties."
}
}
}| filingAge | array | Case age by filing year: fresh (under 2 years), seasoned (2 to 5), long_running (5 or more). |
| amountOwedMax | any |
| amountOwedMin | any |
| addedWithinDays | any | Only filings added in the last N days. Use for 'new this week'. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Rows to return, 1 to 25. Defaults to 10."
},
"stage": {
"type": "array",
"items": {
"enum": [
"summons_and_complaint",
"order_of_reference",
"judgment_of_foreclosure_and_sale",
"notice_of_sale",
"stayed",
"cancelled"
],
"type": "string"
},
"default": [],
"maxItems": 6,
"description": "Foreclosure stages to include. Empty means every stage."
},
"equity": {
"type": "array",
"items": {
"enum": [
"positive",
"negative"
],
"type": "string"
},
"default": [],
"maxItems": 2,
"description": "Estimated equity: positive (value above the debt) or negative, known for 1-3 family homes only. Empty means any."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 975,
"minimum": 0,
"description": "Rows to skip, for the next page."
},
"borough": {
"type": "array",
"items": {
"enum": [
"manhattan",
"brooklyn",
"queens",
"bronx",
"staten_island"
],
"type": "string"
},
"default": [],
"maxItems": 5,
"description": "NYC boroughs to include. Empty means all five."
},
"filingAge": {
"type": "array",
"items": {
"enum": [
"fresh",
"seasoned",
"long_running"
],
"type": "string"
},
"default": [],
"maxItems": 3,
"description": "Case age by filing year: fresh (under 2 years), seasoned (2 to 5), long_running (5 or more)."
},
"amountOwedMax": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"default": null
},
"amountOwedMin": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
],
"default": null
},
"addedWithinDays": {
"anyOf": [
{
"type": "integer",
"maximum": 3650,
"minimum": 1
},
{
"type": "null"
}
],
"default": null,
"description": "Only filings added in the last N days. Use for 'new this week'."
}
}
}{
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 40,
"description": "NYC ZIP codes the person named."
},
"cursor": {
"type": "string",
"pattern": "^(?:[1-5][0-9]{9}(\\|([1-5][0-9]{9}(#[A-Z0-9]{1,8})?)?)?|d:\\d{1,3}:[1-5][0-9]{9})$",
"description": "nextCursor from the previous page."
},
"filters": {
"type": "object",
"properties": {
"ntas": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}\\d{4}$"
},
"maxItems": 40
},
"zips": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 40
},
"grain": {
"enum": [
"lot",
"unit"
],
"type": "string"
},
"signals": {
"type": "array",
"items": {
"enum": [
"long_hold",
"absentee_owner",
"entity_owner",
"portfolio_owner",
"just_sold",
"serial_buyer",
"serial_seller",
"recorded_mortgage",
"no_recorded_debt",
"aging_mortgage",
"value_below_loan",
"foreclosure_filed",
"auction_scheduled",
"tax_lien",
"code_violations",
"vacate_order",
"fire_vacate",
"hpd_litigation",
"vacant_storefront",
"underbuilt",
"vacant_land",
"teardown",
"land_just_bought",
"assemblage",
"rezoning_filed",
"new_building_permit",
"new_co",
"entitled_not_built",
"loan_maturing",
"io_balloon",
"weak_coverage",
"occupancy_down",
"noi_down",
"dscr_below_1",
"loan_modified",
"maturity_extended",
"servicer_advancing",
"special_servicing",
"delinquent",
"ll97_covered",
"ll97_fine_2024",
"ll97_fine_2030",
"evictions",
"facade_unsafe",
"j51_ending",
"421a_ending",
"low_inspection_grade",
"lihtc_year15",
"subsidy_expiring",
"oz_year10"
],
"type": "string"
},
"maxItems": 50
},
"sqftMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"sqftMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"landUses": {
"type": "array",
"items": {
"enum": [
"10",
"11",
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09"
],
"type": "string"
},
"maxItems": 11
},
"unitsMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"unitsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"floorsMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"floorsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"workTypes": {
"type": "array",
"items": {
"enum": [
"General Construction",
"Plumbing",
"Mechanical Systems",
"Structural",
"Sprinklers",
"Foundation",
"Solar",
"Sidewalk Shed",
"Supported Scaffold",
"Construction Fence",
"Sign"
],
"type": "string"
},
"maxItems": 11
},
"lotAreaMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"lotAreaMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"ownerTypes": {
"type": "array",
"items": {
"enum": [
"private",
"city",
"other_public",
"tax_exempt",
"mixed"
],
"type": "string"
},
"maxItems": 5
},
"saleDateTo": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"taxClasses": {
"type": "array",
"items": {
"enum": [
"1",
"2",
"3",
"4"
],
"type": "string"
},
"maxItems": 4
},
"assessedMax": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"assessedMin": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"estValueMax": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"estValueMin": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"lotDepthMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"lotDepthMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"lotWidthMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"lotWidthMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"taxLienOnly": {
"type": "boolean"
},
"assetClasses": {
"type": "array",
"items": {
"enum": [
"office",
"retail",
"industrial",
"hotel",
"parking",
"mixed_use",
"multifamily_walkup",
"multifamily_elevator",
"one_two_family",
"condo",
"healthcare",
"education",
"religious",
"community",
"transportation",
"utility",
"vacant_land",
"government",
"three_family",
"coop"
],
"type": "string"
},
"maxItems": 20
},
"buildableMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"buildableMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"buildingsMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"buildingsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"equityPctMin": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0
},
{
"type": "null"
}
]
},
"historicOnly": {
"type": "boolean"
},
"saleDateFrom": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"salePriceMax": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"salePriceMin": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"yearBuiltMax": {
"anyOf": [
{
"type": "integer",
"maximum": 2200,
"minimum": 1600
},
{
"type": "null"
}
]
},
"yearBuiltMin": {
"anyOf": [
{
"type": "integer",
"maximum": 2200,
"minimum": 1600
},
{
"type": "null"
}
]
},
"amountOwedMax": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"amountOwedMin": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"officeSqftMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"officeSqftMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"ownedYearsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100,
"minimum": 1
},
{
"type": "null"
}
]
},
"retailSqftMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"retailSqftMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"totalUnitsMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"totalUnitsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"commercialOnly": {
"type": "boolean"
},
"zoningFamilies": {
"type": "array",
"items": {
"enum": [
"R",
"C",
"M"
],
"type": "string"
},
"maxItems": 3
},
"signalsMatchAll": {
"type": "boolean"
},
"buildingDepthMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"buildingDepthMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"buildingWidthMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"buildingWidthMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"absenteeOwnerOnly": {
"type": "boolean"
},
"commercialSqftMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"commercialSqftMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"hpdLitigationOnly": {
"type": "boolean"
},
"ownerBuildingsMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"ownerBuildingsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"commercialUnitsMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"commercialUnitsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"residentialSqftMax": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"residentialSqftMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"includeNonHomeUnits": {
"type": "boolean"
},
"constructionPipeline": {
"type": "array",
"items": {
"enum": [
"new_building",
"major_alteration",
"demolition"
],
"type": "string"
},
"maxItems": 3
},
"openHpdViolationsMin": {
"anyOf": [
{
"type": "integer",
"maximum": 100000,
"minimum": 0
},
{
"type": "null"
}
]
},
"preForeclosureEquity": {
"type": "array",
"items": {
"enum": [
"positive",
"negative"
],
"type": "string"
},
"maxItems": 2
},
"preForeclosureStages": {
"type": "array",
"items": {
"enum": [
"sc",
"oor",
"jfs",
"sale_notice",
"stayed"
],
"type": "string"
},
"maxItems": 5
},
"commercialOverlayOnly": {
"type": "boolean"
},
"preForeclosureFiledTo": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"personBehindCompanyOnly": {
"type": "boolean"
},
"preForeclosureFiledFrom": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
}
},
"description": "The same filters as the Hercules NYC map: assetClasses (condo, coop, one_two_family and more), sale price and dates, estValueMin and estValueMax, equityPctMin, ownerBuildingsMin and ownerBuildingsMax, ownedYearsMin, absenteeOwnerOnly, zips, ntas, signals and more. Leave out anything the person did not ask for.",
"additionalProperties": false
},
"boroughs": {
"type": "array",
"items": {
"enum": [
"manhattan",
"brooklyn",
"queens",
"bronx",
"staten_island"
],
"type": "string"
},
"maxItems": 5,
"description": "Whole NYC boroughs. For part of a borough use filters.ntas."
}
},
"additionalProperties": false
}| array |
| NYC ZIP codes. Boroughs, ZIPs and ntas combine as any of them. |
| limit | integer |
| match | string | any keeps lots with at least one of the signals; all keeps lots with every one. |
| offset | integer |
| signals* | array | One or more signal keys: long_hold, absentee_owner, entity_owner, portfolio_owner, just_sold, serial_buyer, serial_seller, recorded_mortgage, no_recorded_debt, aging_mortgage, value_below_loan, foreclosure_filed, auction_scheduled, tax_lien, code_violations, vacate_order, fire_vacate, hpd_litigation, vacant_storefront, underbuilt, vacant_land, teardown, land_just_bought, assemblage, rezoning_filed, new_building_permit, new_co, entitled_not_built, loan_maturing, io_balloon, weak_coverage, occupancy_down, noi_down, dscr_below_1, loan_modified, maturity_extended, servicer_advancing, special_servicing, delinquent, ll97_covered, ll97_fine_2024, ll97_fine_2030, evictions, facade_unsafe, j51_ending, 421a_ending, low_inspection_grade, lihtc_year15, subsidy_expiring, oz_year10. |
| boroughs | array | Whole NYC boroughs. All five when omitted. |
| asset_classes | array | Building types, for example multifamily_walkup, multifamily_elevator, mixed_use, office, retail, one_two_family, condo, coop. |
{
"type": "object",
"required": [
"signals"
],
"properties": {
"ntas": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}\\d{4}$"
},
"maxItems": 40,
"description": "2020 neighborhood codes from find_nyc_area, for example BK0102 Williamsburg. Use them whenever the person names a neighborhood."
},
"zips": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 40,
"description": "NYC ZIP codes. Boroughs, ZIPs and ntas combine as any of them."
},
"limit": {
"type": "integer",
"default": 25,
"maximum": 50,
"minimum": 1
},
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"default": "any",
"description": "any keeps lots with at least one of the signals; all keeps lots with every one."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"signals": {
"type": "array",
"items": {
"enum": [
"long_hold",
"absentee_owner",
"entity_owner",
"portfolio_owner",
"just_sold",
"serial_buyer",
"serial_seller",
"recorded_mortgage",
"no_recorded_debt",
"aging_mortgage",
"value_below_loan",
"foreclosure_filed",
"auction_scheduled",
"tax_lien",
"code_violations",
"vacate_order",
"fire_vacate",
"hpd_litigation",
"vacant_storefront",
"underbuilt",
"vacant_land",
"teardown",
"land_just_bought",
"assemblage",
"rezoning_filed",
"new_building_permit",
"new_co",
"entitled_not_built",
"loan_maturing",
"io_balloon",
"weak_coverage",
"occupancy_down",
"noi_down",
"dscr_below_1",
"loan_modified",
"maturity_extended",
"servicer_advancing",
"special_servicing",
"delinquent",
"ll97_covered",
"ll97_fine_2024",
"ll97_fine_2030",
"evictions",
"facade_unsafe",
"j51_ending",
"421a_ending",
"low_inspection_grade",
"lihtc_year15",
"subsidy_expiring",
"oz_year10"
],
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"description": "One or more signal keys: long_hold, absentee_owner, entity_owner, portfolio_owner, just_sold, serial_buyer, serial_seller, recorded_mortgage, no_recorded_debt, aging_mortgage, value_below_loan, foreclosure_filed, auction_scheduled, tax_lien, code_violations, vacate_order, fire_vacate, hpd_litigation, vacant_storefront, underbuilt, vacant_land, teardown, land_just_bought, assemblage, rezoning_filed, new_building_permit, new_co, entitled_not_built, loan_maturing, io_balloon, weak_coverage, occupancy_down, noi_down, dscr_below_1, loan_modified, maturity_extended, servicer_advancing, special_servicing, delinquent, ll97_covered, ll97_fine_2024, ll97_fine_2030, evictions, facade_unsafe, j51_ending, 421a_ending, low_inspection_grade, lihtc_year15, subsidy_expiring, oz_year10."
},
"boroughs": {
"type": "array",
"items": {
"enum": [
"manhattan",
"bronx",
"brooklyn",
"queens",
"staten_island"
],
"type": "string"
},
"maxItems": 5,
"description": "Whole NYC boroughs. All five when omitted."
},
"asset_classes": {
"type": "array",
"items": {
"enum": [
"office",
"retail",
"industrial",
"hotel",
"parking",
"mixed_use",
"multifamily_walkup",
"multifamily_elevator",
"one_two_family",
"condo",
"healthcare",
"education",
"religious",
"community",
"transportation",
"utility",
"vacant_land",
"government",
"three_family",
"coop"
],
"type": "string"
},
"maxItems": 20,
"description": "Building types, for example multifamily_walkup, multifamily_elevator, mixed_use, office, retail, one_two_family, condo, coop."
}
}
}| limit |
| integer |
| offset | integer |
| reason | string | Keep only buildings with this signal: low_occupancy (owner reports half or less occupied), vacant_storefronts (half or more vacant), for_lease, for_sale, vacate_order (a city order to vacate still in force), no_school (a school building with no school registered in it). |
| borough | string | One NYC borough. All five when omitted. |
| min_building_sqft | integer | Smallest building area in square feet. |
{
"type": "object",
"properties": {
"use": {
"enum": [
"office",
"school",
"religious"
],
"type": "string",
"description": "office (office buildings), school (school buildings) or religious (churches, convents, synagogues and other property of religious owners). Every use when omitted."
},
"ntas": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}\\d{4}$"
},
"maxItems": 40,
"description": "2020 neighborhood codes from find_nyc_area, for example MN0801 Upper East Side-Lenox Hill-Roosevelt Island. Use them whenever the person names a neighborhood, so rows outside it are never quoted."
},
"zips": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{5}$"
},
"maxItems": 40,
"description": "NYC ZIP codes. Combined with ntas as any of those places."
},
"limit": {
"type": "integer",
"default": 25,
"maximum": 50,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0
},
"reason": {
"enum": [
"low_occupancy",
"vacant_storefronts",
"for_lease",
"for_sale",
"vacate_order",
"no_school"
],
"type": "string",
"description": "Keep only buildings with this signal: low_occupancy (owner reports half or less occupied), vacant_storefronts (half or more vacant), for_lease, for_sale, vacate_order (a city order to vacate still in force), no_school (a school building with no school registered in it)."
},
"borough": {
"enum": [
"manhattan",
"bronx",
"brooklyn",
"queens",
"staten_island"
],
"type": "string",
"description": "One NYC borough. All five when omitted."
},
"min_building_sqft": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Smallest building area in square feet."
}
}
}