{ "openapi": "3.0.3", "info": { "version": "", "title": "LeadGen - Property", "description": "## Overview ##\nLeadGen Property is a REST based Cloud API available to mailers for private, in-house use, or as a portal for your customers to use to make their list selections. You can custom-design a website to meet your own needs, as well as those of your customers.\n\nYou can use LeadGen Property to:\n- Select\n- Get counts\n- Purchase targeted property owner mailing lists\n- Do any of the above in real-time, anytime\n\n**Documentation**\n- [LeadGen Property Documentation](https://docs.melissa.com/reference-data/leadgen-property/leadgen-property-index.html)\n\n**Useful Resources**\n- [GitHub](https://github.com/MelissaData/MelissaCloudAPI-OpenAPI-Specifications)\n- [Release Notes](https://releasenotes.melissa.com/cloud-api/leadgen-cloud-api/)\n- [Status Codes](https://docs.melissa.com/other/status-codes-index.html)\n\n**Product Page**\n\n[https://www.melissa.com/direct/mailing-lists-sales-leads/leadgen-api](https://www.melissa.com/direct/mailing-lists-sales-leads/leadgen-api)\n\n**Support Center**\n\n[https://www.melissa.com/company/product-support](https://www.melissa.com/company/product-support)\n" }, "security": [], "tags": [ { "name": "Property List", "description": "Use this endpoint to count or buy property mailing lists." } ], "servers": [ { "url": "https://list.melissadata.net/v2/Property", "description": "LeadGen Property Server" } ], "paths": { "/{action}_{geographicType}": { "get": { "tags": [ "Property List" ], "summary": "Get count or buy a property list", "description": "There are multiple endpoints you can access for LeadGen: Property. These endpoints are all formatted like:\n\n`https://list.melissadata.net/v2/Property/{action}_{geographicType}`\n\nMake sure to replace `{action}` and `{geographicType}` with the appropriate values. For more information on the available actions and geographic types, see the parameters below.\n", "operationId": "propertyGET", "parameters": [ { "$ref": "#/components/parameters/HeaderAcceptParam" }, { "$ref": "#/components/parameters/HeaderContentTypeParam" }, { "name": "action", "in": "path", "required": true, "description": "There are two available actions:\n- `count` - Get count of addresses that fit in the given criteria.\n- `buy` - Buy a list of addresses' info that fit the given criteria.\n", "schema": { "type": "string", "enum": [ "count", "buy" ] }, "example": "count" }, { "name": "geographicType", "in": "path", "required": true, "description": "Each request must specify a single geographic type. Here are the available Geographic Types:\n\n- `Zip`\n - Zips - 5-digit ZIPs. Multiple ZIP can be requested, comma separated with no space or period.\n - ZIP in Radius - 5-digit ZIP. Miles of radius from any given ZIP (mile in decimal).\n - ZIP(s) in City - 5-digit ZIP, City, and 2-digit State.\n- `Address` - Address, City and State or ZIP. Miles of radius from a given address. (mile in decimal)\n- `Street` - Street name and ZIP or city and state, with street number range being optional\n- `City` - Format: 2-digit state;city name, i.e. TX;Dallas. Multiple cities be requested, comma separated with no space, or period\n- `County`\n - by FIPS - Format: 2-digit state;county name, or FIPS\n - by County, State - Multiple counties be requested, comma separated with no space or period, i.e. CA:Lake, 06029.\n- `State` - 2-digit state name.\n- `Circle` - Miles of radius from a point defined as “latitude;longitude” with a semi colon delimiter, i.e.“-117.597760116333;33.63565170564778”. 0.25 miles radius min., 25 miles radius max.\n- `Polygon` - A set of points (latitude /longitude) within 0.25 miles square and 25 miles square. Each point is defined as “latitude;longitude” with a semi colon delimiter, use comma delimiter between each set of latitude;longitude. For example, 33.649656850987895;-117.59544268774414, 33.636509228993326;-117.6109780423584, 33.63222152688031;-117.59518519567871”.\n- `Rectangle` - Southwest and northeast points (latitude /longitude). Each point is defined as “latitude;longitude” with a semi colon delimiter, use comma delimiter between each set of latitude;longitude. For example, “33.63565170564778;-117.597760116333, 33.649513952846554;-117.58685961889648”. 0.25 miles square min., 25 miles square max.\n", "schema": { "type": "string", "enum": [ "zip", "address", "street", "city", "county", "state", "circle", "polygon", "rectangle" ] }, "example": "zip" }, { "name": "id", "in": "query", "required": true, "description": "Customer ID, [License Key](https://docs.melissa.com/melissa/license/license-information.html), or Email Address. This is checked against the list of registered customers.\n", "schema": { "type": "string", "format": "password" }, "example": "REPLACE-WITH-YOUR-LICENSE-KEY" }, { "name": "zip", "in": "query", "description": "*Required* for Geographic Type: `zip`\n\n*Optional* for Geographic Type: `address`, `street`, `circle`, `rectangle`\n\nEach five-digit ZIP is validated.\n", "schema": { "type": "string" }, "required": true, "example": "92688" }, { "name": "addr", "in": "query", "description": "*Required* for Geographic Type: `address`\n\nNo validation.\n", "schema": { "type": "string" } }, { "name": "ctyst", "in": "query", "description": "*Required* for Geographic Type: `city`\n\nFormat: state;city\n", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "*Optional* for Geographic Type: `address`, `street`, `zip`\n\nIf ZIP is given, city is not necessary.\n", "schema": { "type": "string" } }, { "name": "cntyst", "in": "query", "description": "*Required* for Geographic Type: `county`\n\nThe value could be a variety of state;county and/or FIPS.\n", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "*Required* for Geographic Type: `state`\n\n*Optional* for Geographic Type: `address`, `county`, `street`, `zip`\n\nFor state type, 2-digit state is required. For other types, if ZIP or FIPS is given, state is not necessary.\n", "schema": { "type": "string" } }, { "name": "mile", "in": "query", "description": "*Required* for Geographic Type: `address`, `street`, `circle`\n\n*Optional* for Geographic Type: `zip`\n\nRadius of miles from a given street, address or ZIP.\n", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "*Required* for Geographic Type: `street`\n\nExact street name is required. No validation.\n", "schema": { "type": "string" } }, { "name": "num1", "in": "query", "description": "*Optional* for Geographic Type: `street`\n\nStart of the range of street numbers. Either end can be left unspecified.\n", "schema": { "type": "string" } }, { "name": "num2", "in": "query", "description": "*Optional* for Geographic Type: `street`\n\nEnd of the range of street numbers. Either end can be left unspecified.\n", "schema": { "type": "string" } }, { "name": "pt", "in": "query", "description": "*Required* for Geographic Type: `circle`, `rectangle`, `polygon`\n\nEach point is defined as “latitude;longitude” with a semi colon delimiter. For multiple points, use comma delimiter between each set of latitude;longitude. For example, “33.63565170564778;-117.597760116333, 33.649513952846554;-117.58685961889648”. Rectangle takes 2 points: 1) southwest, 2) northeast. Polygon takes at least 3 points, counter clockwise.\n", "schema": { "type": "string" } }, { "name": "propertype", "in": "query", "description": "Default: all. Otherwise specify the index; use `-` dash to specify multiple choices, e.g. propertype =10-11 means Single Family Residence and Condominium(Residential)\n\nProperty codes & types:\n- `00` - Miscellaneous\n- `000` - Not Available/None\n- `10` - Single Family Residence\n- `11` - Condominium(Residential)\n- `20` - Commercial\n- `21` - Duplex, Triplex, Quadplex\n- `22` - Apartment\n- `23` - Hotel, Motel\n- `24` - Condominium(Commercial)\n- `25` - Retail\n- `26` - Service(general public)\n- `27` - Office Building\n- `28` - Warehouse\n- `29` - Financial Institution\n- `30` - Hospital(medical complex, clinic)\n- `31` - Parking\n- `32` - Amusement-Recreation\n- `33` - Mobile Home\n- `50` - Industrial\n- `51` - Industrial Light\n- `52` - Industrial Heavy\n- `53` - Transport\n- `54` - Utility\n- `70` - Agricultural\n- `80` - Vacant Lot (Land)\n- `90` - Exempt\n", "schema": { "type": "string" } }, { "name": "bedrooms", "in": "query", "description": "Number of bedrooms\n", "schema": { "type": "string" } }, { "name": "bathrooms", "in": "query", "description": "Number of bathrooms\n", "schema": { "type": "string" } }, { "name": "units", "in": "query", "description": "Unit number\n", "schema": { "type": "string" } }, { "name": "yearbuilt", "in": "query", "description": "Year built. Format: `YYYY`.\n", "schema": { "type": "string" } }, { "name": "pval", "in": "query", "description": "Property value ($)\n", "schema": { "type": "string" } }, { "name": "equity", "in": "query", "description": "Equity ($)\n", "schema": { "type": "string" } }, { "name": "lvratio", "in": "query", "description": "Loan to value ratio (%)\n", "schema": { "type": "string" } }, { "name": "sqft", "in": "query", "description": "Square footage\n", "schema": { "type": "string" } }, { "name": "bsqft", "in": "query", "description": "Basement square footage\n", "schema": { "type": "string" } }, { "name": "lot", "in": "query", "description": "Lot size. It can be a range. The unit can be:\n\n- `a` for acre\n- `f` for ft.\n\nFormat: `unit; size`.\n\nDefault: no filter.\n\nUnit: default is sq. ft (f).\n\nSize: To specify a range, use `min-max`. `2-4` means 2-4 acres. Use 0 if either end has no preference. For instance, `f;2000-0` means at least 2000 sq. ft.\n", "schema": { "type": "string" } }, { "name": "samt", "in": "query", "description": "Range of sale amounts in thousands ($).\n\nDefault: no filter. To specify a range, use `min-max`, i.e. `2-4`. Use 0 if either end has no preference. For instance, `2-0` means at least $2,000.\n", "schema": { "type": "string" } }, { "name": "sdt", "in": "query", "description": "Range of sale dates.\n\nDefault: no filter. To specify a period, use `MYYYY-MYYYY`. The start month starts on the 1st; the end month ends on the last day, i.e. sdt=`32010-122014`, this covers 3/1/2010 to 12/31/2014.\n", "schema": { "type": "string" } }, { "name": "pool", "in": "query", "description": "Has pool or not.\n\n`1` means using it as a filter while `0` means no preference. For example, pool=`1`. If not specified, it means no preference.\n", "schema": { "type": "integer" } }, { "name": "heat", "in": "query", "description": "Has heater or not.\n\n`1` means using it as a filter while `0` means no preference. For example, heat=`1`. If not specified, it means no preference.\n", "schema": { "type": "integer" } }, { "name": "ac", "in": "query", "description": "Has A/C or not.\n\n`1` means using it as a filter while `0` means no preference. For example, ac=`1`. If not specified, it means no preference.\n", "schema": { "type": "integer" } }, { "name": "fireplace", "in": "query", "description": "Has fireplace or not.\n\n`1` means using it as a filter while `0` means no preference. For example, fireplace=`1`. If not specified, it means no preference.\n", "schema": { "type": "integer" } }, { "name": "mtgAmt", "in": "query", "description": "(Range of) amount in thousands ($). Combined amount for 1st and 2nd mortgages\n\nDefault: no filter. To specify a range of amounts, use `min-max`. Use `0` if either end has no preference.\n\nFor instance, `2-0` means at least $2000, `5-10` means between $5000 and $10000. It's an OR relationship when more than one of `mtgAmt`, `mtgAmt1`, and `mtgAmt2` have values.\n", "schema": { "type": "string" } }, { "name": "mtgAmt1", "in": "query", "description": "1st Mortgage Amount\n\nDefault: no filter. To specify a range of amounts, use `min-max`. Use `0` if either end has no preference.\n\nFor instance, `2-0` means at least $2000, `5-10` means between $5000 and $10000. It's an OR relationship when more than one of `mtgAmt`, `mtgAmt1`, and `mtgAmt2` have values.\n", "schema": { "type": "string" } }, { "name": "mtgAmt2", "in": "query", "description": "2nd Mortgage Amount\n\nDefault: no filter. To specify a range of amounts, use `min-max`. Use `0` if either end has no preference.\n\nFor instance, `2-0` means at least $2000, `5-10` means between $5000 and $10000. It's an OR relationship when more than one of `mtgAmt`, `mtgAmt1`, and `mtgAmt2` have values.\n", "schema": { "type": "string" } }, { "name": "mtgRt", "in": "query", "description": "Rate (range)Rate for either 1st or 2nd mortgage\n\nDefault: no filter. To specify a range of rates, use `min-max`. Use `0` if either end has no preference.\n\nFor instance, `2.5-0` means 2.5% at least, `3-5.5` means between 3% and 5.5%. It's an OR relationship when more than one of the three parameters have values.\n", "schema": { "type": "string" } }, { "name": "mtgRtTp", "in": "query", "description": "Interest rate type for 1st or 2nd mortgage. Types are:\n\n- `2` - Fixed Rate\n- `1` - Adjustable Rate\n- `0` - Unknown\n\nDefault: no filter.\n\nTo include a variety of types, use `-`. For instance, `2-1` means to include fixed and adjustable rate.\n\nIt's an OR relationship when more than one of the three parameters have values.\n", "schema": { "type": "string" } }, { "name": "mtgRecDt", "in": "query", "description": "Recording date (range)\n\nDefault: no filter.\n", "schema": { "type": "string" } }, { "name": "mtgTp", "in": "query", "description": "Interest rate type for 1st or 2nd mortgage. Types are:\n\n- `0` - Unknown\n- `3` - Building or Construction\n- `5` - Conventional\n- `6` - Line of Credit\n- `8` - FHA\n- `10` - Conventional\n- `16` - Veterans Administration Loan\n- `101` - USDA - US Department of Agriculture Loan\n- `102` - Regional Government Programs\n- `103` - Commercial\n- `104` - Regional Government Programs\n- `105` - Reverse Mortgage\n- `120` - Private Party Loan\n\nDefault: no filter.\n\nFor instance, `5-8` means conventional or FHA.\n\nIt's an OR relationship when more than one of the three parameters have values.\n", "schema": { "type": "string" } }, { "name": "mtgScb", "in": "query", "description": "Seller Carry Back (Is the seller is also the lender?)\n\nDefault: no filter.\n", "schema": { "type": "string" } }, { "name": "occu", "in": "query", "description": "Occupant types\n\n- `1` - Owner occupied\n- `2` - Absentee owner (all types)\n- `3` - Absentee Owner - In County\n- `4` - Absentee Owner - In State\n- `5` - Absentee Owner - Out of Country\n- `6` - Absentee Owner - Out of State\n\nDefault: no preference.\n\nFor multiple absentee owner types, use `-` as the delimiter. It's an OR relationship between the selected types. For instance, `3-6` means in county or out of state.\n", "schema": { "type": "string" } }, { "name": "owntrs", "in": "query", "description": "Trustee owner\n\nDefault: no preference.\n\nIncluding or excluding - true or false.\n", "schema": { "type": "string" } }, { "name": "vacant", "in": "query", "description": "Vacant property\n\nDefault: no preference.\n\nIncluding or excluding - true or false.\n", "schema": { "type": "string" } }, { "name": "hhage", "in": "query", "description": "Household age\n\n- `1` - 18 - 24 Years\n- `2` - 25 - 34 Years\n- `3` - 35 - 44 Years\n- `4` - 45 - 54 Years\n- `5` - 55 - 64 Years\n- `6` - 65 - 74 Years\n- `7` - 75+ Years\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple choices, i.e. `1-2` means 18-34 years old\n", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Gender\n\n- `f` - female\n- `m` - male\n- `u` - unisex\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple genders, i.e. `f-m` mean female and male\n", "schema": { "type": "string" } }, { "name": "hhinc", "in": "query", "description": "Household income\n\n- `1` - Under $10,000\n- `2` - $10,000 - $14,999\n- `3` - $15,000 - $19,999\n- `4` - $20,000 - $24,999\n- `5` - $25,000 - $29,999\n- `6` - $30,000 - $34,999\n- `7` - $35,000 - $39,999\n- `8` - $40,000 - $44,999\n- `9` - $45,000 - $49,999\n- `A` - $50,000 - $54,999\n- `B` - $55,000 - $59,999\n- `C` - $60,000 - $64,999\n- `D` - $65,000 - $69,999\n- `E` - $70,000 - $99,999\n- `F` - $100,000 - $149,999\n- `G` - $150,000 - $174,999\n- `H` - $175,000 - $199,999\n- `I` - $200,000 - $249,999\n- `J` - $250,000+\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple choices, i.e. `1-2` means $14,999 or less\n", "schema": { "type": "string" } }, { "name": "marital", "in": "query", "description": "Marital Status\n\n- `a` - inferred married\n- `b` - inferred single\n- `m` - married\n- `s` - single\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple choices, i.e. `b-s` means inferred single or single\n", "schema": { "type": "string" } }, { "name": "lores", "in": "query", "description": "Length of Residence\n\n- `0` - Less than 1 year\n- `1` - 1 Years\n- `2` - 2 Years\n- `3` - 3 Years\n- `4` - 4 Years\n- `5` - 5 Years\n- `6` - 6 Years\n- `7` - 7 Years\n- `8` - 8 Years\n- `9` - 9 Years\n- `10` - 10 Years\n- `11` - 11 Years\n- `12` - 12 Years\n- `13` - 13 Years\n- `14` - 14 Years\n- `15` - Over 14 Years\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple choices, i.e. `0-1-2` means 2 years or under\n", "schema": { "type": "string" } }, { "name": "people", "in": "query", "description": "Persons in household (number of people in household)\n\n- `1` - 1 Person\n- `2` - 2 Persons\n- `3` - 3 Persons\n- `4` - 4 Persons\n- `5` - 5 Persons\n- `6` - 6 Persons\n- `7` - 7 Persons\n- `8` - 8 Persons\n- `9` - 9+ Persons\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple choices, i.e. `1-2` means 2 or less\n", "schema": { "type": "string" } }, { "name": "adults", "in": "query", "description": "Adults in household\n\n- `1` - 1 Adult\n- `2` - 2 Adults\n- `3` - 3 Adults\n- `4` - 4 Adults\n- `5` - 5 Adults\n- `6` - 6+ Adults\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple choices, i.e. `1-2` means 2 or less\n", "schema": { "type": "string" } }, { "name": "kids", "in": "query", "description": "Children in household\n\n- `1` - 1 Child\n- `2` - 2 Children\n- `3` - 3 Children\n- `4` - 4 Children\n- `5` - 5 Children\n- `6` - 6 Children\n- `7` - 7 Children\n- `8` - 8+ Children\n\nDefault: all.\n\nOtherwise specify the index; use `-` dash to specify multiple choices, i.e. `1-2` means 2 or less\n", "schema": { "type": "string" } }, { "name": "qty", "in": "query", "description": "Number of records to buy\n\nDefault: no preference.\n", "schema": { "type": "integer", "maximum": 100000 } }, { "name": "file", "in": "query", "description": "File Format\n\n- `1` - Zipped .dbf\n- `3` - Zipped .csv\n- `5` - Zipped .xls\n- `6` - .dbf\n- `8` - .csv\n- `10` - .xls\n", "schema": { "type": "integer", "default": 8, "enum": [ 1, 3, 5, 6, 8, 10 ] } }, { "name": "emails", "in": "query", "description": "- `0` - records with no email\n- `1` - records with email\n- `2` - all records\n", "schema": { "type": "integer", "default": 2, "enum": [ 0, 1, 2 ] } }, { "name": "femails", "in": "query", "description": "- `0` - do not append\n- `1` - append email to order file\n", "schema": { "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, { "name": "one", "in": "query", "description": "- `false` - all properties owned by owner\n- `true` - one property per owner\n", "schema": { "type": "boolean", "default": true } }, { "name": "xml", "in": "query", "description": "- `false` - response in json\n- `true` - response in xml\n", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" }, "example": { "options": { "propertyOptions": [ "Property Type: Single Family Residence;Condominium(Residential);Apartment;", "Bedrooms: between 2 and 4" ], "mortgageOptions": [], "occupantOptions": [ "Absentee/Owner Occupied: AbsenteeOwner_InCounty" ], "demographicOptions": [], "foreclosureOptions": [], "listOptions": [ "One property per owner." ] }, "areas": [ { "geo": "92688", "count": 1336, "message": "" } ], "summary": { "geoType": "Zip", "totalCount": 1336, "orderId": 0, "fileUrl": null, "status": [ { "statusCode": 1, "statusDetail": "Approved." } ] } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" } } } } }, "components": { "parameters": { "HeaderAcceptParam": { "in": "header", "name": "Accept", "description": "Format of the response.", "required": true, "schema": { "type": "string", "enum": [ "application/json", "*/*" ] }, "example": "application/json" }, "HeaderContentTypeParam": { "in": "header", "name": "Content-Type", "description": "Format of the request.", "required": true, "schema": { "type": "string", "enum": [ "application/json", "application/xml" ] } } }, "schemas": { "Response": { "type": "object", "properties": { "options": { "type": "object", "properties": { "propertyOptions": { "type": "array", "items": { "type": "string" } }, "mortgageOptions": { "type": "array", "items": { "type": "string" } }, "occupantOptions": { "type": "array", "items": { "type": "string" } }, "demographicOptions": { "type": "array", "items": { "type": "string" } }, "foreclosureOptions": { "type": "array", "items": { "type": "string" } }, "listOptions": { "type": "array", "items": { "type": "string" } } } }, "areas": { "type": "array", "items": { "type": "object", "properties": { "geo": { "type": "string" }, "count": { "type": "integer" }, "message": { "type": "string" } } } }, "summary": { "type": "object", "properties": { "geoType": { "type": "string" }, "totalCount": { "type": "integer" }, "orderId": { "type": "integer" }, "fileUrl": { "type": "string", "nullable": true }, "status": { "type": "array", "items": { "type": "object", "properties": { "statusCode": { "type": "integer", "description": "For details of all status codes please visit [here](https://docs.melissa.com/other/status-codes-index.html).\n\nAll Melissa products use result codes. LeadGen - Property Status codes are numeric codes, e.g. `101`. Status codes are returned as a comma-delimited string with no whitespace, e.g. `100,101`.\n" }, "statusDetail": { "type": "string" } } } } } } } } }, "responses": { "ErrorResponse": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of error that occurred." }, "title": { "type": "string", "description": "A short summary of the error." }, "status": { "type": "integer", "description": "The HTTP status code for the error." }, "errors": { "type": "object", "properties": { "$.": { "type": "array", "description": "A detailed message about the error.", "items": { "type": "string" } } } }, "traceId": { "type": "string", "description": "A unique identifier for the request, useful for debugging." } } } } } } } } }