Public APIs
Website APIs
27.05.2024
─
Vijay Kumar Reddy Dwrampudi
Director of Engineering
Kodelint Innovations Pvt Ltd
Overview
This document contains information on our JSON-based REST APIs designed to provide seamless access to property listings, detailed property information and more.
Getting Started
Make the INIT API using the test token provided.
We will provide a new token for the production environment once we go live.
- The Init API will return client information that needs to be passed along with all the following requests.
Overview BY SEARCH ID
This will give the aggregations based on the given ID.
Use eafbd3f6-ac8b-4efa-9194-5e24ca059615 as a sample searchId
METHOD: GET
URL: https://cp-api.512labs.co/public/api/v1/searches/{searchId}/overviewHeaders:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
Query Params: (optional)
page: number , default page 1
per_page: number, default 25
Sort: string, Available options (status_order_asc, newest,price_change,price_high_low,price_low_high, open_house_recent_first)
Response:
{ "status": "success", "code": 20000, "message": "Overview fetched successfully", "data": { "overview": { "pending": { "price": { "min": 65000, "max": 6590000, "avg": 542398, "median": 425430 }, "price_sqft": { "min": 41.45, "max": 5681.82, "avg": 252.98, "median": 216.71 }, "days_on_market": { "min": 0, "max": 663, "avg": 61, "median": 27 }, "live_sqft": { "min": 132, "max": 11998, "avg": 2150, "median": 2023 }, "lot_sqft": { "min": 0, "max": 1423105200, "avg": 640354, "median": 6896 }, "acres": { "min": 0, "max": 32670, "avg": 14.7, "median": 0.16 }, "beds": { "min": 0, "max": 7, "avg": 4, "median": 4 }, "baths": { "min": 0, "max": 10, "avg": 3, "median": 3 }, "year_built": { "min": 1900, "max": 2024, "avg": 2011, "median": 2023 } }, "closed": {}, "all": { "price": { "min": 65000, "max": 18635000, "avg": 742603, "median": 475000 }, "price_sqft": { "min": 0, "max": 5681.82, "avg": 318.66, "median": 239.73 }, "days_on_market": { "min": 0, "max": 741, "avg": 68, "median": 29 }, "live_sqft": { "min": 0, "max": 14215, "avg": 2246, "median": 2037 }, "lot_sqft": { "min": 0, "max": 1423105200, "avg": 393150, "median": 7841 }, "acres": { "min": 0, "max": 32670, "avg": 9.03, "median": 0.18 }, "beds": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "baths": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "year_built": { "min": 0, "max": 2027, "avg": 2006, "median": 2018 } }, "new": { "price": { "min": 65000, "max": 18635000, "avg": 876479, "median": 528250 }, "price_sqft": { "min": 0, "max": 4449.84, "avg": 362.58, "median": 263.74 }, "days_on_market": { "min": 0, "max": 741, "avg": 73, "median": 30 }, "live_sqft": { "min": 0, "max": 14215, "avg": 2310, "median": 2046 }, "lot_sqft": { "min": 0, "max": 409289760, "avg": 227844, "median": 8712 }, "acres": { "min": 0, "max": 9396, "avg": 5.23, "median": 0.2 }, "beds": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "baths": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "year_built": { "min": 0, "max": 2027, "avg": 2002, "median": 2015 } } }, "count": { "new": 3444, "pending": 2303, "closed": 0, "all": 5747 } } } |
LISTINGS BY SEARCH ID
This will be the initial call to get property listings by the given ID.
Use eafbd3f6-ac8b-4efa-9194-5e24ca059615 as a sample searchId
METHOD: GET
URL: https://cp-api.512labs.co/public/api/v1/searches/{searchId}Headers:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
Query Params: (optional)
page: number , default page 1
per_page: number, default 25
sort: string, Available options (status_order_asc, newest,price_change,price_high_low,price_low_high, open_house_recent_first)
Response:
{ "status": "success", "code": 20000, "message": "Properties fetched successfully", "data": { "updates": [ { "bathrooms_full": 2, "subdivision_name": "Vintage Oaks/The Vineyard Un 2", "living_area": 3350, "bedrooms_total": 3, "state_or_province": "TX", "living_area_units": "SquareFeet", "lot_size_acres": 1.25, "postal_code": "78132", "city": "New Braunfels", "bathrooms_half": 2, "list_price": 975000, "list_price_formatted": "$975,000", "original_list_price": 975000, "previous_list_price": 0, "close_price": null, "status_changed_on": "2023-12-13T20:24:14.223000Z", "price_changed_on": "", "on_market_date": "", "on_market_timestamp": "", "days_on_market": 39, "cumulative_days_on_market": 39, "price_changed_days": 0, "percentage_of_list": 0, "unparsed_address": "1218 Game TRL, New Braunfels TX 78132", "property_sub_type": "Single Family Residence", "property_type": "Residential", "elementary_school": "Bill Brown", "standard_status": "Active", "listing_key": "87e27814704ec40a7b50ea6ea29081d2", "listing_id": "5574052", "custom_rooms_string": "3 Beds, 2 Full and 2 Half Baths", "pses_url": "https://portal.bramlettresidential.com/client-portal/searches/properties/87e27814704ec40a7b50ea6ea29081d2?domain_id=3278317&person_id=", "additionalInfo": [], "lat": 29.785973, "lng": -98.232262, "order_in_cart": 0, "upcoming_open_house_string": "", "upcoming_open_house_date": "", "year_built": 2022, "media": [ { "order": 1, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/83dcefb7.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 2, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/1ad5be0d.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 3, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/6dd28e9b.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 4, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/f3b61b38.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 5, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/84b12bae.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 6, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/1db87a14.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 7, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/6abf4a82.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 8, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/fa005713.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 9, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/8d076785.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 10, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/a15d25e1.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 11, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/d65a1577.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 12, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/4f5344cd.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 13, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/3854745b.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 14, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/a630e1f8.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 15, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/d137d16e.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 16, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/483e80d4.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 17, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/3f39b042.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 18, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/af86add3.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 19, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/d8819d45.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 20, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/8a707622.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 21, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/fd7746b4.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 22, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/647e170e.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null } ], "actions": {} } ], "meta": { "pagination": { "total": 5747, "per_page": 1, "current_page": 1, "last_page": 5747, "next_page_url": "/?page=2", "prev_page_url": null, "from": 1, "to": 1 } } } } |
Property Details By Property ID
This will give full property details by given property ID.
Use a28895cc987205d772bf3aab6b23d6d2as a sample searchId
METHOD: GET
URL: https://cp-api.512labs.co/public/api/v1/properties/{propertyId}Headers:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
X-PERSON-ID(Required): Ex: 84842 ( Get this value from the sign or sign up API)
Response:
{ "status": "success", "code": 20000, "message": "Properties fetched successfully", "data": { "_id": "664a452c259219292f08e983", "ListingKey": "a28895cc987205d772bf3aab6b23d6d2", "BathroomsFull": 4, "WaterfrontYN": false, "LockBoxType": [ "Electronic" ], "LotSizeAcres": 0.95, "SubdivisionName": "River Place Sec 13", "BedroomsTotal": 4, "Fencing": [ "Wrought Iron" ], "WithdrawnDate": null, "LivingAreaUnits": null, "GreenSustainability": [ "None" ], "CustomTitleCompany": "Independence Title", "TaxLegalDescription": "LOT 1 BLK A RIVER PLACE SEC 13", "CloseDate": null, "StreetSuffix": "RD", "ETJExtraTerritorialJurdn": "No", "ListAgentMlsId": "703211", "OnMarketDate": null, "HorseAmenities": [ "None" ], "ListingService": "Full Service", "ListAgentEmail": "kamodisett@gmail.com", "WaterSource": [ "Public" ], "SubAgencyCompensationType": "%", "MajorChangeTimestamp": "2024-05-19T18:25:07.533000Z", "Flooring": [ "Carpet", "Tile", "Wood" ], "FireplacesTotal": 2, "StoriesTotal": null, "EstimatedTaxes": 37000, "YearBuilt": 2000, "SubAgencyCompensation": 0, "Cooling": [ "Central Air" ], "GarageYN": false, "ExteriorFeatures": [ "Balcony", "Gas Grill", "Lighting", "Outdoor Grill", "Private Yard" ], "StatusChangeTimestamp": "2024-05-19T18:25:07.533000Z", "Longitude": -97.851698, "SecurityFeatures": [ "Security System" ], "PreviousListPrice": null, "HorseYN": false, "BonusBALANumeric": null, "DaysOnMarket": 7, "OpenHousePublicUpcoming": null, "UnitNumber": null, "PublicRemarks": "Private, Resort-style living with Hill Country Views! Custom built with historic treasures from all over Texas: vintage doors, beveled glass panels, and stairway banisters from court houses just to name a few. A wrap around porch, huge playroom/flex space, a dedicated office and temperature-controlled pool. A must see!", "BuyerAgencyCompensationType": "%", "TaxExemptions": [ "Over 65" ], "CustomRestrictions": [ "Deed Restrictions" ], "OccupantType": "Vacant", "OtherStructures": [ "None" ], "AssociationAmenities": null, "AssociationFeeFrequency": "Annually", "OpenHousePublicCount": 0, "CurrentFinancing": null, "ListOfficeMlsId": "027201", "ClosePrice": null, "ListAgentDirectPhone": "(325) 668-0081", "ElementarySchoolDistrict": "Leander ISD", "StreetNumberNumeric": 4101, "OpenHouseUpcoming": null, "SpaFeatures": [ "Above Ground" ], "PurchaseContractDate": null, "LivingArea": 4852, "PriceChangeTimestamp": null, "ShowingContactPhone": "(325) 668-0081", "TaxAssessedValue": 2002546, "MajorChangeType": "New Listing", "ListingContractDate": "2024-05-19T00:00:00.000000Z", "CumulativeDaysOnMarket": 7, "ParkingFeatures": [ "Driveway" ], "OpenHouseCount": 2, "BathroomsHalf": 1, "OpenHouseTimePublic": null, "PoolFeatures": [ "Heated", "In Ground" ], "Sewer": [ "Public Sewer" ], "LivingAreaSource": "Public Records", "Appliances": [ "Built-In Gas Oven", "Built-In Gas Range", "Dishwasher", "Disposal", "Microwave", "Plumbed For Ice Maker" ], "SyndicationRemarks": null, "ExpirationDate": null, "Heating": [ "Central" ], "MLSAreaMajor": "RN", "TaxAnnualAmount": 37239.26, "ListOfficeName": "Berkshire Hathaway TX Realty", "LockBoxDescription": "Near the back door.", "StreetName": "Narrow Ridge", "RatioCurrentPriceByLivingArea": 450.33, "BonusToBAType": null, "PatioAndPorchFeatures": [ "Covered", "Front Porch", "Wrap Around" ], "CountyOrParish": "Travis", "Latitude": 30.362186, "MainLevelBedrooms": 1, "GuestAccommodationDesc": [ "None" ], "PropertyType": "Residential", "ListPrice": 2185000, "ListingAgreement": "Exclusive Agency", "ListOfficePhone": "(512) 483-6000", "Utilities": [ "Electricity Connected", "Internet-Fiber", "Natural Gas Connected", "Phone Available", "Water Connected" ], "AssociationYN": true, "MlsStatus": "Active", "RatioCurrentPriceByOriginalListPrice": 1, "StreetNumber": "4101", "ListingId": "8971322", "WindowFeatures": [ "Storm Window(s)" ], "SpecialListingConditions": [ "Standard" ], "NewConstructionYN": false, "CommunityFeatures": [ "Golf Course", "Park", "Sidewalks", "Walk/Bike/Hike/Jog Trail(s" ], "BathroomsTotalInteger": 5, "GarageSpaces": 3, "OriginalListPrice": 2185000, "GreenEnergyEfficient": [ "None" ], "StateOrProvince": "TX", "Media": [ { "Order": 1, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m1", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/83dcefb7.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_1", "ShortDescription": "4101 Narrow Ridge" }, { "Order": 2, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m2", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/1ad5be0d.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_2", "ShortDescription": "Aerial View" }, { "Order": 3, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m3", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/6dd28e9b.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_3", "ShortDescription": "View from back porch" }, { "Order": 4, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m4", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/f3b61b38.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_4", "ShortDescription": "Landscaped backyard" }, { "Order": 5, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m5", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/84b12bae.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_5", "ShortDescription": "Wrap around porch" }, { "Order": 6, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m6", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/1db87a14.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_6", "ShortDescription": "Pond" }, { "Order": 7, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m7", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/6abf4a82.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_7", "ShortDescription": "Temperature controlled swimming pool" }, { "Order": 8, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m8", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/fa005713.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_8", "ShortDescription": "Outdoor kitchen" }, { "Order": 9, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m9", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/8d076785.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_9", "ShortDescription": "Outdoor kitchen and back porch" }, { "Order": 10, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m10", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/a15d25e1.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_10", "ShortDescription": "Main entrance" }, { "Order": 11, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m11", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/d65a1577.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_11", "ShortDescription": "Front Foyer" }, { "Order": 12, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m12", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/4f5344cd.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_12", "ShortDescription": "Separate office with view" }, { "Order": 13, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m13", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/3854745b.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_13", "ShortDescription": "Dining room" }, { "Order": 14, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m14", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/a630e1f8.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_14", "ShortDescription": "Family Room" }, { "Order": 15, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m15", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/d137d16e.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_15", "ShortDescription": "Family room fireplace and built-ins" }, { "Order": 16, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m16", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/483e80d4.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_16", "ShortDescription": "Newly remodeled kitchen" }, { "Order": 17, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m17", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/3f39b042.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_17", "ShortDescription": "Top of the line appliances" }, { "Order": 18, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m18", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/af86add3.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_18", "ShortDescription": "Perfect entertainment setup" }, { "Order": 19, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m19", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/d8819d45.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_19", "ShortDescription": "First floor restroom" }, { "Order": 20, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m20", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/8a707622.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_20", "ShortDescription": "Mud room" }, { "Order": 21, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m21", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/fd7746b4.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_21", "ShortDescription": "Primary suite" }, { "Order": 22, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m22", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/647e170e.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_22", "ShortDescription": "Primary bath" }, { "Order": 23, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m23", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/13792798.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_23", "ShortDescription": "Dual vanities and big soaker tub" }, { "Order": 24, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m24", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/8d1db23b.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_24", "ShortDescription": "Upstairs balcony" }, { "Order": 25, "MediaKey": "a28895cc987205d772bf3aab6b23d6d2-m25", "MediaURL": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/122468131/fa1a82ad.jpeg", "ResourceRecordKey": "a28895cc987205d772bf3aab6b23d6d2", "ResourceName": "Property", "ClassName": "Residential", "MediaCategory": "Photo", "MimeType": "image/jpeg", "MediaObjectID": "122468131_25", "ShortDescription": "Upstairs bedroom" } ], "City": "Austin", "CoveredSpaces": 3, "MiddleOrJuniorSchool": "Four Points", "AssociationFeeIncludes": [ "Common Area Maintenance" ], "BuyerAgencyCompensation": 3, "LaundryLocation": [ "Main Level" ], "ShowingContactType": [ "Agent" ], "AccessibilityFeatures": [ "Common Area" ], "StatusContractualSearchDate": "2024-05-19T00:00:00.000000Z", "ElementarySchool": "River Place", "TaxRate": 1.2746, "HighSchoolDistrict": "Leander ISD", "CustomTitle": "Seller", "OwnershipType": "Fee-Simple", "Disclosures": [ "Municipal Utility District (MUD)", "Seller Disclosure" ], "OwnerName": "Withheld", "DirectionFaces": "NW", "Directions": "2222 to River Place Blvd, left on Big View, Left on Narrow Ridge. House is on the corner. Alternately 2222 to City Park Road, Right on Westminster Glen, Right on Narrow Ridge.", "MLSModificationTimestamp": "2024-05-26T21:03:12.397000Z", "LotFeatures": [ "Back Yard", "Corner Lot", "Front Yard", "Landscaped", "Native Plants", "Near Golf Course", "Private", "Public Maintained Road", "Sprinkler - Automatic" ], "ListAgentFullName": "Kelly Modisett", "PostalCode": "78730", "AttachedGarageYN": false, "OnMarketTimestamp": null, "StandardStatus": "Active", "DocumentsAvailable": [ "Aerial Photos", "Deed Restrictions", "Energy Conservation Audit Disclosure", "Municipal Utility District (MUD)" ], "ConstructionMaterials": [ "Stone" ], "Roof": [ "Asbestos Shingle" ], "PropertyCondition": [ "Resale" ], "ParkingTotal": 4, "AssociationFee": 300, "LotSizeSquareFeet": 41382, "ParcelNumber": "4101 Narrow Ridge Road", "PoolPrivateYN": true, "ShowingRequirements": [ "Call First - Go" ], "MiddleOrJuniorSchoolDistrict": "Leander ISD", "ListingTerms": [ "Cash", "Conventional" ], "FoundationDetails": [ "Slab" ], "OpenHouseDatePublic": null, "BuilderName": null, "View": [ "Canyon", "Golf Course", "Hill Country", "Panoramic" ], "FEMAFloodPlain": [ "No" ], "UnparsedAddress": "4101 Narrow Ridge RD, Austin TX 78730", "PropertySubType": "Single Family Residence", "PrivateRemarks": null, "Possession": [ "Funding" ], "HighSchool": "Vandegrift", "Levels": [ "Two" ], "HomeSaleContingencyYN": null, "InteriorFeatures": [ "Bookcases", "Built-in Features", "Beamed Ceilings", "Central Vacuum", "Granite Counters", "Double Vanity", "Electric Dryer Hookup", "Entrance Foyer", "Interior Steps", "Multiple Dining Areas", "Multiple Living Areas", "Natural Woodwork", "Pantry", "Primary Bedroom on Main", "Soaking Tub", "Storage", "Walk-In Closet(s)", "Washer Hookup" ], "FeedTypes": [], "Location": { "type": "Point", "coordinates": [ -97.851698, 30.362186 ] }, "StatusOrder": 1, "StatusChangeTimestampYMD": 20240519, "OpenHousePublicUpcomingDateInt": 30000101, "DataSource": "actris", "updated_at": "2024-05-26T21:15:15.130000Z", "created_at": "2024-05-19T18:30:04.428000Z" } } |
Sign-In/Sign Up
This will act as a sign-in/sign-up if it’s sign-up lead creation also will happen.
METHOD: POST
URL: https://cp-api.512labs.co/public/api/v1/people/initHeaders:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
Content-Type: application/json
Request Body:
{
"email": "vijay@kodelint.com"
"phone": "+1-212-456-4567"
"source": "public_api",
"first_name": "Name",
"last_name": "Name",
"lock_time": "1", // The given value will be considered in hours.
}
//Allowed source types
'public_api' => 'BP Miscellaneous',
'webform_entry' => 'BP Webform',
'one_tap' => 'BP One Tap',
'property_registration' => 'BP Property Registration',
Response:
{ "status": "success", "code": 20000, "message": "Person created successfully", "data": { "fub_person_id": 78467, "person_type": "person", "first_name": null, "last_name": null, "full_name": null, "phone": "", "email": "vijay@kodelint.com", "last_activity": null, "picture": [] } } |
Page or Property Views
This will be used for both page and property views. Based on X-PERSON-ID key this will recorded for that person. If no key there still it will record but no identifier.
METHOD: POST
URL: https://cp-api.512labs.co/public/api/v1/viewsHeaders:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
X-PERSON-ID: (optional) id of the response from the init API/
Content-Type: application/json
Request Body For View / Saved Property:
{
"category": "Viewed Property", // Viewed Page, Viewed Property, Saved Property
"view_type": "property", // Either page or property
"property": {
"street": "2410 S 2nd Street 416",
"city": "Waco",
"state": "TX",
"code": "76706",
"price": 225000,
"url": "http://localhost:4200/dashboard/client-portal/searches/properties/WACO1107486891?context=eyJhY2NvdW50Ijp7ImlkIjoiMzI3ODMxNyJ9LCJ1c2VyIjp7ImlkIjoxNX0sInBlcnNvbiI6eyJpZCI6IjM1Mzg2NSJ9fQ==&signature=6644af38783c8d3d676bb3f06a138ee42860fda0c1baeb2fc1c7d14cd164bda7",
"type": "Residential",
"bedrooms": 3,
"bathrooms": 2,
"area": 1101,
"lot": 0.06
} // required if view_type is property
}
Request Body For Viewed Page:
{
"category": "Viewed Page",
"view_type": "page",
"page_title": "test page", //If page has subpages use like test page : subpage
"page_url": "test.com",
"page_unique_identifier": "test_page"
}
Request Body For Inquiry Property:
{
"category": "Property Inquiry", // Viewed Page, Viewed Property, Saved Property,Property Inquiry
"view_type": "property", // Either page or property
"source":"webform_entry",
"property": {
"id":"21234",
"street": "3816 Keller Road",
"city": "Temple",
"state": "TX",
"code": "76504",
"price": 299900,
"url": "http://localhost:4200/dashboard/client-portal/searches/properties/WACO1107596306?context=eyJhY2NvdW50Ijp7ImlkIjoiMzI3ODMxNyJ9LCJ1c2VyIjp7ImlkIjoxNX0sInBlcnNvbiI6eyJpZCI6IjM1Mzg2NSJ9fQ==&signature=6644af38783c8d3d676bb3f06a138ee42860fda0c1baeb2fc1c7d14cd164bda7",
"type": "Residential",
"bedrooms": 4,
"bathrooms": 2,
"area": 1763,
"lot": 0.1892
},
"message": null,
"description": "testtttt"
}
Response:
{ "message": "View saved successfully" } |
Forms API
This will be used to create all types of forms.
METHOD: POST
URL: https://cp-api.512labs.co/public/api/v1/formsHeaders:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
Rate Limiting: If a form submission exceeds the rate limit, the API will respond with a 429 status code.
Type 1: Agent Bio Contact
{ "form_type": "agent_bio_contact", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":222, "options":"something else", "message":"example message", "referrer_url":"url" } |
Type 2: Agent: Landing Market Updates
{ "form_type": "agent_landing_market_updates", // Required "name": "Name", // Required "email":"test1464@yopmail.com", // Required "phone":2227767777668778, "address": "Address", "Help_with_anything_else": true, "message":"example message", } |
Type 3: Agent Landing Page Contact
{ "form_type": "agent_landing_page_contact", // Required "name": "Name", // Required "email":"test1464@yopmail.com", // Required "phone":2227767777668778, "address": "Address", "message":"example message", "options":"selected option" } |
Type 4: Area - ask about the property
{ "form_type": "area_ask_about_property", // Required "name": "Name", // Required "email":"test1464@yopmail.com", // Required "phone":2227767777668778, "message":"example message", "options":"selected option", "referrer_url":"url" } |
Type 5: Area - Request showing or information
{ "form_type": "area_request_showing_or_information", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":2227767777668778, "message":"example message", "options":"selected option", "referrer_url":"url" } |
Type 6: Area - Request showing
{ "form_type": "area_request_showing", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":2227767777668778, "message":"example message", "referrer_url":"url" } |
Type 7: Area Neighborhood GeneralName
{ "form_type": "area_neighborhood_general_name", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":2227767777668778, "options":"selected option", "message":"example message", "referrer_url":"url", } |
Type 8: Area Neighborhood General Spanish
{ "form_type": "area_neighborhood_general_spanish", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":2227767777668778, "options":"selected option", "message":"example message", "referrer_url":"url" } |
Type 9: Buyer Form
{ "form_type": "buyer_form", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":2227767777668778, "options":"selected option", "message":"example message" } |
Type 10: Home page + Contact us Page
{ "form_type": "home_page_and_contact_us_page", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":2227767777668778, "options":"selected option", "message":"example message" } |
Type 11: How did everything go? (Sent to client)
{ "form_type": "how_did_everything_go_sent_to_client", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "agent_name":"Agent Name", //Required "experience_as_whole":"", "agent_do":"", "company_do":"", "agent_do_to_improve":"", "agent_exceptionally_well":"", "company_exceptionally_well":"", "message":"example message" } |
Type 12: How did everything go? (Sent to Agent)
{ "form_type": "how_did_everything_go_sent_to_agent", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "agent_name":"Agent Name", //Required "experience_as_whole":"", "agent_do":"", "company_do":"", "agent_do_to_improve":"", "agent_exceptionally_well":"", "company_exceptionally_well":"", "message":"example message" } |
Type 13: Industry newsletter
{ "form_type": "industry_newsletter", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "address":"Address", "message":"example message" } |
Type 14: Investors - County Appraised Value or Sale
{ "form_type": "investors_county_appraised_value_sale", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "address":"Address", "like_to":["Selected value"], //Required "message":"example message" } |
Type 15: Investors - General
{ "form_type": "investors_general", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "investment_properties":true, //Required "options":"", "message":"example message", "referrer_url":"Url" } |
Type 16: Join Bramlett
{ "form_type": "join_bramlett", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "message":"example message" } |
Type 17: Market Updates
{ "form_type": "market_updates", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "address":"Address", //Required "message":"example message", "help_with_anything_else":true } |
Type 18: Market Updates - Neighborhood Lander
{ "form_type": "market_updates_neighborhood_lander", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "address":"Address", //Required "message":"example message", "help_with_anything_else":true } |
Type 19: Market Updates - Neighborhood Lander McGuire Team
{ "form_type": "market_updates_neighborhood_lander_mcguire_team", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "address":"Address", //Required "message":"example message", "help_with_anything_else":true } |
Type 20: Market Updates - T-shirt Promo
{ "form_type": "market_updates_tshirt_promo", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "address":"Address", "city":"", "state":"", "zip_code":"666670", //Required "t_shirt_size":"12", "your_phone":"234", "message":"example message", "can_we_help_with_anything_else":true } |
Type 21: New Agent Intake Questionnaire (Team Member)
{ "form_type": "new_agent_intake_questionnaire_team_member", //Required "name": "Name", //Required "email":"test1464@yopmail.com", //Required "team_leader_name":"", "preferred_bramlettresidential_email":"email@yomail.com", //Required "current_work_email":"email@yomail.com", //Required "other_email_for_work_purposes":"email@yomail.com", //Required "listing_coordination_and_transaction":true, //Required "Upcoming_listings_in_the_next_30_45_days":true, //Required "have_an_esignature_tool":true, //Required "how_do_you_feel_about_tech_savviness":"text",//Required "computer_use_at_home":"text", //Required "computer_use_in_field":"text", //Required "iphone_or_android":"android", //Required "when_you_check_your_work_email":"text", //Required "apple_mail_and_similar_suites":"text",//Required "Which_browser_use":"text", //Required "safari_and_other_browsers":"text", //Required "crm_experience":"text", //Required "about_crm":"", "client_soi_database":"text", //Required "any_immediate_questions":"" } |
Type 22: New Listing Important Information
{ "form_type": "new_listing_important_information", //Required "email":"test1464@yopmail.com", //Required "agent_name":"Agent Name", //Required "include_anyone_else":"", "address":"", //Required "type_of_property":"", "client_email":"", //Required "list_price_notes":"", //Required "commission_to_bramlett_residential":"", //Required "other_commission":"", "company_lead":"true", //Required "team_generated_lead":"true", "lead_source":"", //Required "split_to_you":"", "payees_amounts_or_percentages":"", "marketing_notes":"", "which_services":"", //Required "target_list_date_notes":"", "company_title":"", "total_commission_charged_to_seller":"", //Required "other_commission_charged_to_the_seller":"", "like_to_cced_on_all_messages":"", "all_clients_listed_here":"", //Required "will_property_be_vacant_or_occupied":"", //Required "add_best_practices_settings":"", //Required "sellers_live_in_the_austin_area":"", //Required "property_in_hoa":"", //Required "hoa_other":"", "gate_code_and_or_security_alarm":"", "use_sign_otter":"", //Required "deadline_to_have_inventory_at_property":"", "established_with_your_sellers":"", "signage_would_you_like":"", "other_signage_property":"", "lockboxes":"", "other_lockbox":"", "supra_login_info":"", "what_date_install_the_sign_and_lockbox":"", "mls_lockbox_serial":"", "supra_kimweb_login":"", "send_pdfs_of_flyer_plate":"", "install_a_combo_lockbox":"", "sign_lockbox_notes":"", "scheduling_photos":"", //Required "preferred_photographer":"", "preferred_dates_for_pics":"", "more_photography_notes":"", "when_will_you_have_pics":"", "cs_when_property_showcase_ready":"", "cs_input_for_list_price":"", "cs_other_input_for_list_price":"", "cs_target_list_date":"", "cs_bedrooms_bathrooms_in_property":"", "cs_neighborhood_subdivision_name":"", "cs_sqft_property":"", "pinky_swear":"", //Required "notifications_and_reminders":"", //Required "critical_documents":"", //Required "optional_documents":"", "any_other_special_info":"", //Required "all_files":"", //Required "file_1":"", "file_2":"", "file_3":"", "file_4":"" } |
Type 23: New Agent Intake Questionnaire
{ "form_type": "new_agent_intake_questionnaire", //Required "name":"Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, //Required "type_of_license":"", //Required "license_number":"", //Required "preferred_bramlettresidential_email":"email@yopmail.com", //Required "current_work_email":"email@yopmail.com", //Required "other_email_for_work_purposes":"email@yopmail.com", //Required "listing_coordination_and_transaction":true, //Required "work_with_sign_otter":false, "your_sign_otter_account_associated":true, "upcoming_listings_in_the_next_30_45_days":false, //Required "do_you_have_any_active_listings":true, //Required "already_have_a_form_filling":false, //Required "which_tool_is_it":"", "we_provide_new_headshots":true, //Required "take_leads_duty":false, //Required "have_dedicated_workspace_home":true, "how_do_you_feel_about_tech_savviness":"", //Required "computer_use_at_home":"", "have_a_docking_station_second_monitor":true, "computer_use_in_field":"", //Required "iphone_or_android":"", //Required "when_you_check_your_work_email":"", //Required "apple_mail_and_similar_suites":"", "which_browser_use":"", //Required "safari_and_other_browsers":"", "crm_experience":"", //Required "about_crm":"", "client_soi_database":"", //Required "where_contacts_stored":"", //Required "any_immediate_questions":"" } |
Type 24: Open House
{ "form_type": "open_house", //Required "name":"Name", //Required "email":"test1464@yopmail.com", //Required "phone":234 } |
Type 25: Property Description Questionnaire
{ "form_type": "property_description_questionnaire", //Required "name":"Name", //Required "email":"test1464@yopmail.com", //Required "address":"Address", //Required "answer_15_questions_about_property":"text", //Required "your_favorite_attributes_of_property":"text", "great_first_word_for_property":"", "property_best_described_as":"", "include_the_neighborhood_name":"", "good_headline_for_property":"", "favorite_things_about_property":"", "broad_geographic_area":"", "property_minutes_to_downtown":"", "property_minutes_to_the_domain":"", "property_minutes_to_lake_travis_hill":"", "property_minutes_to_greenbelt_for_hiking":"", "property_feed_to_a_good_school":"", "property_easy_commute_to_airport":"", "property_minutes_to_f1_new_tesla_factory":"", "property_close_to_how_many_minutes":"", "property_have_check_all_that_apply":"", "entire_home_check_all":"", "we_include_check_all_that_apply":"", "property_have_great_backyard":"", "what_else_notable_about_property":"" } |
Type 26: Receptionist intake form
{ "form_type": "receptionist_intake_form", //Required "name":"Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, //Required "caller_id_number":"444", //Required "options":"Selected option", "message":"example message" } |
Type 27: Seller form
{ "form_type": "seller_form", //Required "name":"Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "address":"Address", "message":"example message" } |
Type 28: Spanish contact form
{ "form_type": "spanish_contact_form", //Required "name":"Name", //Required "email":"test1464@yopmail.com", //Required "phone":234, "options":"selected option", "message":"example message" } |
Type 29: New team lead intake questionnaire
{ "form_type": "new_team_lead_intake_questionnaire", //Required "name": "Name", //Required "email":"test14564@yopmail.com", //Required "type_of_license":"", "license_number":"license_number", //Required "your_team_name":"name", //Required "website":"name of the website", //Required "work_email_preferences":"", "other_work_email_preferences":"", "list_all_licensed_agents":"agents", //Required "list_all_unlicensed_staff":"staff", //Required "any_active_listings":false, "plan_to_use_lc_ctc":true, //Required "plan_on_requiring_agents":true, //Required "sign_otter_as_part_of_lc_ctc_services":true, //Required "sign_otter_account_associated":false, //Required "plan_to_use_soi_nurture_program":true, //Required "plan_on_having_your_agents":false, "plan_to_have_own_zillow_team":false, "join_zillow_team":true, //Required "have_system_for_collecting_reviews":true, "help_build_out_review_system":true, //Required "any_other_notes":"example note" //Required } |
V2 LISTINGS BY PUBLIC LINK ID
This will be the initial call to get property listings by the given Public ID from the super portal.
Use 6eb3447e-04c8-4edd-9482-506e28f09c2a as a sample searchId
METHOD: GET
URL: https://cp-api.512labs.co/public/api/v2/searches/{searchId}Headers:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
Query Params: (optional)
page: number , default page 1
per_page: number, default 25
sort: string, Available options (status_order_asc, newest,price_change,price_high_low,price_low_high, open_house_recent_first)
Response:
{ "status": "success", "code": 20000, "message": "Properties fetched successfully", "data": { "updates": [ { "bathrooms_full": 2, "subdivision_name": "Vintage Oaks/The Vineyard Un 2", "living_area": 3350, "bedrooms_total": 3, "state_or_province": "TX", "living_area_units": "SquareFeet", "lot_size_acres": 1.25, "postal_code": "78132", "city": "New Braunfels", "bathrooms_half": 2, "list_price": 975000, "list_price_formatted": "$975,000", "original_list_price": 975000, "previous_list_price": 0, "close_price": null, "status_changed_on": "2023-12-13T20:24:14.223000Z", "price_changed_on": "", "on_market_date": "", "on_market_timestamp": "", "days_on_market": 39, "cumulative_days_on_market": 39, "price_changed_days": 0, "percentage_of_list": 0, "unparsed_address": "1218 Game TRL, New Braunfels TX 78132", "property_sub_type": "Single Family Residence", "property_type": "Residential", "elementary_school": "Bill Brown", "standard_status": "Active", "listing_key": "87e27814704ec40a7b50ea6ea29081d2", "listing_id": "5574052", "custom_rooms_string": "3 Beds, 2 Full and 2 Half Baths", "pses_url": "https://portal.bramlettresidential.com/client-portal/searches/properties/87e27814704ec40a7b50ea6ea29081d2?domain_id=3278317&person_id=", "additionalInfo": [], "lat": 29.785973, "lng": -98.232262, "order_in_cart": 0, "upcoming_open_house_string": "", "upcoming_open_house_date": "", "year_built": 2022, "media": [ { "order": 1, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/83dcefb7.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 2, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/1ad5be0d.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 3, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/6dd28e9b.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 4, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/f3b61b38.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 5, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/84b12bae.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 6, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/1db87a14.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 7, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/6abf4a82.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 8, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/fa005713.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 9, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/8d076785.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 10, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/a15d25e1.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 11, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/d65a1577.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 12, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/4f5344cd.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 13, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/3854745b.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 14, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/a630e1f8.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 15, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/d137d16e.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 16, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/483e80d4.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 17, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/3f39b042.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 18, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/af86add3.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 19, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/d8819d45.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 20, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/8a707622.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 21, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/fd7746b4.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null }, { "order": 22, "media_url": "https://dvvjkgh94f2v6.cloudfront.net/62e30b5c/120364699/647e170e.jpeg", "resource_name": "Property", "class_name": "Residential", "media_category": "Photo", "mime_type": "image/jpeg", "short_description": null } ], "actions": {} } ], "meta": { "pagination": { "total": 5747, "per_page": 1, "current_page": 1, "last_page": 5747, "next_page_url": "/?page=2", "prev_page_url": null, "from": 1, "to": 1 } } } } |
V2 OVERVIEW BY PUBLIC LINK ID
This will provide the aggregations based on the given Public Search ID.
Use 6eb3447e-04c8-4edd-9482-506e28f09c2a as a sample searchId
METHOD: GET
URL: https://cp-api.512labs.co/public/api/v2/searches/{searchId}/overviewHeaders:
X-API-KEY : c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458
Query Params: (optional)
page: number , default page 1
per_page: number, default 25
Sort: string, Available options (status_order_asc, newest,price_change,price_high_low,price_low_high, open_house_recent_first)
Response:
{ "status": "success", "code": 20000, "message": "Overview fetched successfully", "data": { "overview": { "pending": { "price": { "min": 65000, "max": 6590000, "avg": 542398, "median": 425430 }, "price_sqft": { "min": 41.45, "max": 5681.82, "avg": 252.98, "median": 216.71 }, "days_on_market": { "min": 0, "max": 663, "avg": 61, "median": 27 }, "live_sqft": { "min": 132, "max": 11998, "avg": 2150, "median": 2023 }, "lot_sqft": { "min": 0, "max": 1423105200, "avg": 640354, "median": 6896 }, "acres": { "min": 0, "max": 32670, "avg": 14.7, "median": 0.16 }, "beds": { "min": 0, "max": 7, "avg": 4, "median": 4 }, "baths": { "min": 0, "max": 10, "avg": 3, "median": 3 }, "year_built": { "min": 1900, "max": 2024, "avg": 2011, "median": 2023 } }, "closed": {}, "all": { "price": { "min": 65000, "max": 18635000, "avg": 742603, "median": 475000 }, "price_sqft": { "min": 0, "max": 5681.82, "avg": 318.66, "median": 239.73 }, "days_on_market": { "min": 0, "max": 741, "avg": 68, "median": 29 }, "live_sqft": { "min": 0, "max": 14215, "avg": 2246, "median": 2037 }, "lot_sqft": { "min": 0, "max": 1423105200, "avg": 393150, "median": 7841 }, "acres": { "min": 0, "max": 32670, "avg": 9.03, "median": 0.18 }, "beds": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "baths": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "year_built": { "min": 0, "max": 2027, "avg": 2006, "median": 2018 } }, "new": { "price": { "min": 65000, "max": 18635000, "avg": 876479, "median": 528250 }, "price_sqft": { "min": 0, "max": 4449.84, "avg": 362.58, "median": 263.74 }, "days_on_market": { "min": 0, "max": 741, "avg": 73, "median": 30 }, "live_sqft": { "min": 0, "max": 14215, "avg": 2310, "median": 2046 }, "lot_sqft": { "min": 0, "max": 409289760, "avg": 227844, "median": 8712 }, "acres": { "min": 0, "max": 9396, "avg": 5.23, "median": 0.2 }, "beds": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "baths": { "min": 0, "max": 16, "avg": 3, "median": 3 }, "year_built": { "min": 0, "max": 2027, "avg": 2002, "median": 2015 } } }, "count": { "new": 3444, "pending": 2303, "closed": 0, "all": 5747 } } } |
Get Properties By Agent
This will be used to get properties by agent.
| METHOD | GET |
| URL | https://cp-api.512labs.co/public/api/v1/agent-properties |
| Headers | X-API-KEY: c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458 |
| Query Params | agent_mls_id: 498954 office_mls_id: 4395 feed: actris/mfrmls/waco - Required status: active/pending/closed, picture: main_pic/all, pagination: 0/1 elementary_school: Call auto-search-items API with field ElementarySchool and pass value to the API. middle_school: Call auto-search-items API with field MiddleOrJuniorSchool and pass value to the API. high_school: Call auto-search-items API with field HighSchool and pass value to the API. school_district: Call auto-search-items API with field HighSchoolDistrict and pass value to the API. postal_code: Call auto-search-items API with field PostalCode and pass value to the API. neighbourhood_id: Call auto-search-items API with field Neighborhood and pass id to the API. |
Options API
This will be used to get properties by agent.
| METHOD | GET |
| URL | https://cp-api.512labs.co/public/api/v1/auto-search-items |
| Headers | X-API-KEY: c695f64dd0517e7acacdc066d8fff19b05a09218f12f03663ca7a632d206d458 |
| Query Params | feed: actris/mfrmls/waco - Required field: Neighborhood/ElementarySchool/HighSchool/MiddleOrJuniorSchool/HighSchoolDistrict/PostalCode - Required search: The search term |