# PropGPT API Check out the functionality of this endpoint at https://www.propgpt.com ## How to Get an OpenAI API Key for Using PropGPT API Visit [https://openai.com/blog/openai-api](https://openai.com/blog/openai-api) and create an account. Once your account is created you can follow this OpenAI help article that directs you to where to find your secret key: [https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key) ## Why do I need to include my OpenAI Key? There are two reasons why we need to have your OpenAI key in order to fulfill PropGPT API Requests: 1. Accurate tracking of tokens that will get billed to your OpenAI account balance 2. OpenAI data use compliance # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "property-apis", "version": "1.0" }, "servers": [ { "url": "https://api.realestateapi.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "x-api-key" } } }, "security": [ { "sec0": [] } ], "paths": { "/v2/PropGPT": { "post": { "summary": "PropGPT API", "description": "Check out the functionality of this endpoint at https://www.propgpt.com", "operationId": "propgpt-api", "parameters": [ { "name": "x-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-user-id", "in": "header", "schema": { "type": "string" } }, { "name": "x-openai-key", "in": "header", "description": "Sign up with OpenAI (at https://openai.com/blog/openai-api) and get your free API Key to attach to all your requests to this endpoint for token spend tracking.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "query" ], "properties": { "size": { "type": "integer", "description": "Maximum of 250", "format": "int32" }, "query": { "type": "string", "description": "A natural language string that references data points in the Property Search API in order to retrieve a list of properties." }, "model": { "type": "string", "description": "Options: gpt-4, gpt-4o, gpt-4o-mini, gpt-4-turbo, gpt-3.5-turbo" } } } } } }, "responses": { "200": { "description": "200", "content": { "text/plain": { "examples": { "Result": { "value": "{\n \"live\": true,\n \"input\": {\n \"mls_active\": true,\n \"mls_listing_price_min\": 600000,\n \"mls_listing_price_max\": 700000,\n \"city\": \"Herndon\",\n \"state\": \"VA\",\n \"query\": \"Find all properties listed for sale in Herndon Virginia between 600K and 700K\",\n \"size\": 3\n },\n \"data\": [\n {\n \"absenteeOwner\": false,\n \"address\": {\n \"address\": \"13011 Park Crescent Cir, Herndon, Va 20171\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"13011 Park Crescent Cir\",\n \"zip\": \"20171\"\n },\n \"adjustableRate\": false,\n \"airConditioningAvailable\": false,\n \"assessedImprovementValue\": 372120,\n \"assessedLandValue\": 143000,\n \"assessedValue\": 515120,\n \"assumable\": false,\n \"auction\": false,\n \"basement\": true,\n \"bathrooms\": 2,\n \"bedrooms\": 3,\n \"cashBuyer\": true,\n \"corporateOwned\": false,\n \"death\": false,\n \"deck\": true,\n \"deckArea\": 252,\n \"documentType\": \"Grant Deed\",\n \"documentTypeCode\": \"DTGD\",\n \"equity\": false,\n \"equityPercent\": 100,\n \"estimatedEquity\": 553596,\n \"estimatedValue\": 553596,\n \"floodZone\": true,\n \"floodZoneDescription\": \"AREA OF MINIMAL FLOOD HAZARD\",\n \"floodZoneType\": \"X\",\n \"foreclosure\": false,\n \"forSale\": false,\n \"freeClear\": false,\n \"garage\": false,\n \"highEquity\": true,\n \"id\": \"33781421\",\n \"inherited\": false,\n \"inStateAbsenteeOwner\": false,\n \"investorBuyer\": false,\n \"judgment\": false,\n \"landUse\": \"Residential\",\n \"lastMortgage1Amount\": null,\n \"lastSaleAmount\": \"520000\",\n \"lastSaleDate\": \"2020-07-14\",\n \"latitude\": 38.946442,\n \"lenderName\": \"Suburban Federal Savings\",\n \"listingAmount\": null,\n \"longitude\": -77.394123,\n \"lotSquareFeet\": 1332,\n \"mailAddress\": {\n \"address\": \"13011 Park Crescent Cir, Herndon, Va 20171\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"13011 Park Crescent Cir\",\n \"zip\": \"20171\"\n },\n \"medianIncome\": \"150066\",\n \"MFH2to4\": false,\n \"MFH5plus\": false,\n \"mlsActive\": true,\n \"mlsCancelled\": false,\n \"mlsDaysOnMarket\": 43,\n \"mlsFailed\": false,\n \"mlsHasPhotos\": true,\n \"mlsLastSaleDate\": \"2020-07-14\",\n \"mlsListingDate\": \"2023-06-15\",\n \"mlsListingPrice\": 615000,\n \"mlsPending\": true,\n \"mlsSold\": false,\n \"mlsStatus\": \"Active\",\n \"mlsType\": \"ForSale\",\n \"negativeEquity\": false,\n \"neighborhood\": {\n \"center\": \"POINT(-77.3937489163297 38.947147566096)\",\n \"id\": \"63187\",\n \"name\": \"Woodland Park\",\n \"type\": \"subdivision\"\n },\n \"openMortgageBalance\": 0,\n \"outOfStateAbsenteeOwner\": false,\n \"owner1FirstName\": \"Decoite\",\n \"owner1LastName\": \"Jeffrey\",\n \"owner2FirstName\": \"Decoite\",\n \"owner2LastName\": \"Michelle\",\n \"ownerOccupied\": true,\n \"pool\": false,\n \"poolArea\": 0,\n \"preForeclosure\": false,\n \"privateLender\": false,\n \"propertyId\": \"33781421\",\n \"propertyType\": \"SFR\",\n \"propertyUse\": \"Townhouse\",\n \"propertyUseCode\": 386,\n \"rentAmount\": null,\n \"reo\": false,\n \"roomsCount\": 8,\n \"squareFeet\": 1656,\n \"stories\": 2,\n \"suggestedRent\": \"2590\",\n \"unitsCount\": 0,\n \"vacant\": false,\n \"yearBuilt\": 1999,\n \"yearsOwned\": 3\n },\n {\n \"absenteeOwner\": false,\n \"address\": {\n \"address\": \"508 Fillmore St, Herndon, Va 20170\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"508 Fillmore St\",\n \"zip\": \"20170\"\n },\n \"adjustableRate\": false,\n \"airConditioningAvailable\": false,\n \"assessedImprovementValue\": 370670,\n \"assessedLandValue\": 231000,\n \"assessedValue\": 601670,\n \"assumable\": false,\n \"auction\": false,\n \"basement\": true,\n \"bathrooms\": 3,\n \"bedrooms\": 3,\n \"cashBuyer\": false,\n \"corporateOwned\": false,\n \"death\": false,\n \"deck\": false,\n \"deckArea\": 0,\n \"documentType\": \"Grant Deed\",\n \"documentTypeCode\": \"DTGD\",\n \"equity\": false,\n \"equityPercent\": 27,\n \"estimatedEquity\": 153798,\n \"estimatedValue\": 568264,\n \"floodZone\": true,\n \"floodZoneDescription\": \"AREA OF MINIMAL FLOOD HAZARD\",\n \"floodZoneType\": \"X\",\n \"foreclosure\": false,\n \"forSale\": false,\n \"freeClear\": false,\n \"garage\": false,\n \"highEquity\": false,\n \"id\": \"23164100\",\n \"inherited\": false,\n \"inStateAbsenteeOwner\": false,\n \"investorBuyer\": false,\n \"judgment\": false,\n \"landUse\": \"Residential\",\n \"lastMortgage1Amount\": null,\n \"lastSaleAmount\": \"479000\",\n \"lastSaleDate\": \"2018-07-30\",\n \"latitude\": 38.974252,\n \"lenderName\": \"Navy Fcu\",\n \"listingAmount\": null,\n \"loanTypeCode\": \"CPI\",\n \"longitude\": -77.374725,\n \"lotSquareFeet\": 11486,\n \"mailAddress\": {\n \"address\": \"508 Fillmore St, Herndon, Va 20170\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"508 Fillmore St\",\n \"zip\": \"20170\"\n },\n \"medianIncome\": \"132059\",\n \"MFH2to4\": false,\n \"MFH5plus\": false,\n \"mlsActive\": true,\n \"mlsCancelled\": false,\n \"mlsDaysOnMarket\": 7,\n \"mlsFailed\": false,\n \"mlsHasPhotos\": false,\n \"mlsLastSaleDate\": \"2018-07-30\",\n \"mlsLastStatusDate\": \"2023-07-21\",\n \"mlsListingDate\": \"2023-07-21\",\n \"mlsListingPrice\": 674900,\n \"mlsPending\": false,\n \"mlsSold\": false,\n \"mlsStatus\": \"Active\",\n \"mlsType\": \"ForSale\",\n \"negativeEquity\": false,\n \"neighborhood\": {\n \"center\": \"POINT(-77.3746181604251 38.9740770995265)\",\n \"id\": \"63025\",\n \"name\": \"Chelmsford\",\n \"type\": \"subdivision\"\n },\n \"openMortgageBalance\": 432432,\n \"outOfStateAbsenteeOwner\": false,\n \"owner1FirstName\": \"Megan\",\n \"owner1LastName\": \"Eschman\",\n \"owner2FirstName\": \"David\",\n \"owner2LastName\": \"Neumaier\",\n \"ownerOccupied\": true,\n \"pool\": false,\n \"poolArea\": 0,\n \"preForeclosure\": false,\n \"privateLender\": false,\n \"propertyId\": \"23164100\",\n \"propertyType\": \"SFR\",\n \"propertyUse\": \"Single Family Residence\",\n \"propertyUseCode\": 385,\n \"rentAmount\": null,\n \"reo\": false,\n \"roomsCount\": 8,\n \"squareFeet\": 1234,\n \"stories\": 1,\n \"suggestedRent\": \"2530\",\n \"unitsCount\": 0,\n \"vacant\": false,\n \"yearBuilt\": 1976,\n \"yearsOwned\": 5\n },\n {\n \"absenteeOwner\": false,\n \"address\": {\n \"address\": \"1409 Cuttermill Ct, Herndon, Va 20170\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"1409 Cuttermill Ct\",\n \"zip\": \"20170\"\n },\n \"adjustableRate\": false,\n \"airConditioningAvailable\": false,\n \"assessedImprovementValue\": 337940,\n \"assessedLandValue\": 215000,\n \"assessedValue\": 552940,\n \"assumable\": false,\n \"auction\": false,\n \"basement\": true,\n \"bathrooms\": 3,\n \"bedrooms\": 3,\n \"cashBuyer\": false,\n \"corporateOwned\": false,\n \"death\": false,\n \"deck\": true,\n \"deckArea\": 200,\n \"equity\": false,\n \"equityPercent\": 61,\n \"estimatedEquity\": 361186,\n \"estimatedValue\": 583837,\n \"floodZone\": true,\n \"floodZoneDescription\": \"AREA OF MINIMAL FLOOD HAZARD\",\n \"floodZoneType\": \"X\",\n \"foreclosure\": false,\n \"forSale\": false,\n \"freeClear\": false,\n \"garage\": true,\n \"highEquity\": true,\n \"id\": \"47750425\",\n \"inherited\": false,\n \"inStateAbsenteeOwner\": false,\n \"investorBuyer\": false,\n \"judgment\": false,\n \"landUse\": \"Residential\",\n \"lastMortgage1Amount\": null,\n \"lastSaleAmount\": \"249000\",\n \"lastSaleDate\": \"2000-05-23\",\n \"latitude\": 38.979282,\n \"lenderName\": \"Td Bk Na\",\n \"listingAmount\": null,\n \"loanTypeCode\": \"COV\",\n \"longitude\": -77.403757,\n \"lotSquareFeet\": 10000,\n \"mailAddress\": {\n \"address\": \"1409 Cuttermill Ct, Herndon, Va 20170\",\n \"city\": \"Herndon\",\n \"county\": \"Fairfax\",\n \"state\": \"VA\",\n \"street\": \"1409 Cuttermill Ct\",\n \"zip\": \"20170\"\n },\n \"medianIncome\": \"132059\",\n \"MFH2to4\": false,\n \"MFH5plus\": false,\n \"mlsActive\": true,\n \"mlsCancelled\": false,\n \"mlsDaysOnMarket\": 7,\n \"mlsFailed\": false,\n \"mlsHasPhotos\": false,\n \"mlsLastSaleDate\": \"2000-05-23\",\n \"mlsLastStatusDate\": \"2023-07-21\",\n \"mlsListingDate\": \"2023-07-21\",\n \"mlsListingPrice\": 700000,\n \"mlsPending\": false,\n \"mlsSold\": false,\n \"mlsStatus\": \"Active\",\n \"mlsType\": \"ForSale\",\n \"negativeEquity\": false,\n \"neighborhood\": {\n \"center\": \"POINT(-77.404389381409 38.977426631181)\",\n \"id\": \"63045\",\n \"name\": \"Treeside\",\n \"type\": \"subdivision\"\n },\n \"openMortgageBalance\": 274000,\n \"outOfStateAbsenteeOwner\": false,\n \"owner1FirstName\": \"Fitzgerald\",\n \"owner1LastName\": \"G\",\n \"owner2FirstName\": \"Fitzgerald\",\n \"owner2LastName\": \"M\",\n \"ownerOccupied\": true,\n \"pool\": false,\n \"poolArea\": 0,\n \"preForeclosure\": false,\n \"privateLender\": false,\n \"propertyId\": \"47750425\",\n \"propertyType\": \"SFR\",\n \"propertyUse\": \"Single Family Residence\",\n \"propertyUseCode\": 385,\n \"rentAmount\": null,\n \"reo\": false,\n \"roomsCount\": 8,\n \"squareFeet\": 1671,\n \"stories\": 2,\n \"suggestedRent\": \"2530\",\n \"totalPortfolioEquity\": \"504212\",\n \"totalPortfolioMortgageBalance\": \"302286\",\n \"totalPortfolioValue\": \"806498\",\n \"totalPropertiesOwned\": \"3\",\n \"unitsCount\": 0,\n \"vacant\": false,\n \"yearBuilt\": 1984,\n \"yearsOwned\": 23\n }\n ],\n \"resultCount\": 12,\n \"resultIndex\": 3,\n \"recordCount\": 3,\n \"statusCode\": 200,\n \"statusMessage\": \"Success\",\n \"requestExecutionTimeMS\": \"2121ms\",\n \"propGPTExecutionTimeMS\": \"2076ms\",\n \"searchExecutionTimeMS\": \"38ms\"\n}" } }, "schema": { "type": "object", "properties": { "live": { "type": "boolean", "example": true, "default": true }, "input": { "type": "object", "properties": { "mls_active": { "type": "boolean", "example": true, "default": true }, "mls_listing_price_min": { "type": "integer", "example": 600000, "default": 0 }, "mls_listing_price_max": { "type": "integer", "example": 700000, "default": 0 }, "city": { "type": "string", "example": "Herndon" }, "state": { "type": "string", "example": "VA" }, "query": { "type": "string", "example": "Find all properties listed for sale in Herndon Virginia between 600K and 700K" }, "size": { "type": "integer", "example": 3, "default": 0 } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "absenteeOwner": { "type": "boolean", "example": false, "default": true }, "address": { "type": "object", "properties": { "address": { "type": "string", "example": "13011 Park Crescent Cir, Herndon, Va 20171" }, "city": { "type": "string", "example": "Herndon" }, "county": { "type": "string", "example": "Fairfax" }, "state": { "type": "string", "example": "VA" }, "street": { "type": "string", "example": "13011 Park Crescent Cir" }, "zip": { "type": "string", "example": "20171" } } }, "adjustableRate": { "type": "boolean", "example": false, "default": true }, "airConditioningAvailable": { "type": "boolean", "example": false, "default": true }, "assessedImprovementValue": { "type": "integer", "example": 372120, "default": 0 }, "assessedLandValue": { "type": "integer", "example": 143000, "default": 0 }, "assessedValue": { "type": "integer", "example": 515120, "default": 0 }, "assumable": { "type": "boolean", "example": false, "default": true }, "auction": { "type": "boolean", "example": false, "default": true }, "basement": { "type": "boolean", "example": true, "default": true }, "bathrooms": { "type": "integer", "example": 2, "default": 0 }, "bedrooms": { "type": "integer", "example": 3, "default": 0 }, "cashBuyer": { "type": "boolean", "example": true, "default": true }, "corporateOwned": { "type": "boolean", "example": false, "default": true }, "death": { "type": "boolean", "example": false, "default": true }, "deck": { "type": "boolean", "example": true, "default": true }, "deckArea": { "type": "integer", "example": 252, "default": 0 }, "documentType": { "type": "string", "example": "Grant Deed" }, "documentTypeCode": { "type": "string", "example": "DTGD" }, "equity": { "type": "boolean", "example": false, "default": true }, "equityPercent": { "type": "integer", "example": 100, "default": 0 }, "estimatedEquity": { "type": "integer", "example": 553596, "default": 0 }, "estimatedValue": { "type": "integer", "example": 553596, "default": 0 }, "floodZone": { "type": "boolean", "example": true, "default": true }, "floodZoneDescription": { "type": "string", "example": "AREA OF MINIMAL FLOOD HAZARD" }, "floodZoneType": { "type": "string", "example": "X" }, "foreclosure": { "type": "boolean", "example": false, "default": true }, "forSale": { "type": "boolean", "example": false, "default": true }, "freeClear": { "type": "boolean", "example": false, "default": true }, "garage": { "type": "boolean", "example": false, "default": true }, "highEquity": { "type": "boolean", "example": true, "default": true }, "id": { "type": "string", "example": "33781421" }, "inherited": { "type": "boolean", "example": false, "default": true }, "inStateAbsenteeOwner": { "type": "boolean", "example": false, "default": true }, "investorBuyer": { "type": "boolean", "example": false, "default": true }, "judgment": { "type": "boolean", "example": false, "default": true }, "landUse": { "type": "string", "example": "Residential" }, "lastMortgage1Amount": {}, "lastSaleAmount": { "type": "string", "example": "520000" }, "lastSaleDate": { "type": "string", "example": "2020-07-14" }, "latitude": { "type": "number", "example": 38.946442, "default": 0 }, "lenderName": { "type": "string", "example": "Suburban Federal Savings" }, "listingAmount": {}, "longitude": { "type": "number", "example": -77.394123, "default": 0 }, "lotSquareFeet": { "type": "integer", "example": 1332, "default": 0 }, "mailAddress": { "type": "object", "properties": { "address": { "type": "string", "example": "13011 Park Crescent Cir, Herndon, Va 20171" }, "city": { "type": "string", "example": "Herndon" }, "county": { "type": "string", "example": "Fairfax" }, "state": { "type": "string", "example": "VA" }, "street": { "type": "string", "example": "13011 Park Crescent Cir" }, "zip": { "type": "string", "example": "20171" } } }, "medianIncome": { "type": "string", "example": "150066" }, "MFH2to4": { "type": "boolean", "example": false, "default": true }, "MFH5plus": { "type": "boolean", "example": false, "default": true }, "mlsActive": { "type": "boolean", "example": true, "default": true }, "mlsCancelled": { "type": "boolean", "example": false, "default": true }, "mlsDaysOnMarket": { "type": "integer", "example": 43, "default": 0 }, "mlsFailed": { "type": "boolean", "example": false, "default": true }, "mlsHasPhotos": { "type": "boolean", "example": true, "default": true }, "mlsLastSaleDate": { "type": "string", "example": "2020-07-14" }, "mlsListingDate": { "type": "string", "example": "2023-06-15" }, "mlsListingPrice": { "type": "integer", "example": 615000, "default": 0 }, "mlsPending": { "type": "boolean", "example": true, "default": true }, "mlsSold": { "type": "boolean", "example": false, "default": true }, "mlsStatus": { "type": "string", "example": "Active" }, "mlsType": { "type": "string", "example": "ForSale" }, "negativeEquity": { "type": "boolean", "example": false, "default": true }, "neighborhood": { "type": "object", "properties": { "center": { "type": "string", "example": "POINT(-77.3937489163297 38.947147566096)" }, "id": { "type": "string", "example": "63187" }, "name": { "type": "string", "example": "Woodland Park" }, "type": { "type": "string", "example": "subdivision" } } }, "openMortgageBalance": { "type": "integer", "example": 0, "default": 0 }, "outOfStateAbsenteeOwner": { "type": "boolean", "example": false, "default": true }, "owner1FirstName": { "type": "string", "example": "Decoite" }, "owner1LastName": { "type": "string", "example": "Jeffrey" }, "owner2FirstName": { "type": "string", "example": "Decoite" }, "owner2LastName": { "type": "string", "example": "Michelle" }, "ownerOccupied": { "type": "boolean", "example": true, "default": true }, "pool": { "type": "boolean", "example": false, "default": true }, "poolArea": { "type": "integer", "example": 0, "default": 0 }, "preForeclosure": { "type": "boolean", "example": false, "default": true }, "privateLender": { "type": "boolean", "example": false, "default": true }, "propertyId": { "type": "string", "example": "33781421" }, "propertyType": { "type": "string", "example": "SFR" }, "propertyUse": { "type": "string", "example": "Townhouse" }, "propertyUseCode": { "type": "integer", "example": 386, "default": 0 }, "rentAmount": {}, "reo": { "type": "boolean", "example": false, "default": true }, "roomsCount": { "type": "integer", "example": 8, "default": 0 }, "squareFeet": { "type": "integer", "example": 1656, "default": 0 }, "stories": { "type": "integer", "example": 2, "default": 0 }, "suggestedRent": { "type": "string", "example": "2590" }, "unitsCount": { "type": "integer", "example": 0, "default": 0 }, "vacant": { "type": "boolean", "example": false, "default": true }, "yearBuilt": { "type": "integer", "example": 1999, "default": 0 }, "yearsOwned": { "type": "integer", "example": 3, "default": 0 } } } }, "resultCount": { "type": "integer", "example": 12, "default": 0 }, "resultIndex": { "type": "integer", "example": 3, "default": 0 }, "recordCount": { "type": "integer", "example": 3, "default": 0 }, "statusCode": { "type": "integer", "example": 200, "default": 0 }, "statusMessage": { "type": "string", "example": "Success" }, "requestExecutionTimeMS": { "type": "string", "example": "2121ms" }, "propGPTExecutionTimeMS": { "type": "string", "example": "2076ms" }, "searchExecutionTimeMS": { "type": "string", "example": "38ms" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [ { "key": "x-user-id", "value": "UniqueUserIdentifier" } ], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```