{ "openapi": "3.0.1", "info": { "title": "MLS Listings API - Sold Prices, Comps, Agent Contacts", "description": "Search MLS listings across the US and Canada with sold prices and status history, pull the expanded record with listing agents, comparables and room detail, group listings by building, and compute market statistics over any filter set.", "version": "0.1", "x-build-id": "Hwr0cLXhorEywQ88U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~mls-listings-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-mls-listings-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~mls-listings-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-mls-listings-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~mls-listings-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-mls-listings-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "What to do", "enum": [ "listingSearch", "listingDetails", "similarListings", "marketStatistics", "buildingSearch", "buildingDetails", "locations", "agents", "offices" ], "type": "string", "description": "Listing search pages the live and historical listing set. Listing details reads one MLS number in the expanded form that adds the agents, the full status history and the comparables. Market statistics asks the same route for aggregates. Building search groups every listing at one address. Locations, agents and offices read the reference sides of the MLS.", "default": "listingSearch" }, "cities": { "title": "Cities", "type": "array", "description": "One city per line. Array filters repeat rather than join, so two cities match either of them.", "items": { "type": "string" } }, "areas": { "title": "Areas", "type": "array", "description": "One area, also called a region, per line.", "items": { "type": "string" } }, "neighborhoods": { "title": "Neighbourhoods", "type": "array", "description": "One neighbourhood per line. More precise than a city and the usual unit for comparables.", "items": { "type": "string" } }, "states": { "title": "States or provinces", "type": "array", "description": "One state or province per line.", "items": { "type": "string" } }, "zips": { "title": "ZIP or postal codes", "type": "array", "description": "One code per line.", "items": { "type": "string" } }, "mlsNumbers": { "title": "MLS numbers", "type": "array", "description": "One MLS number per line. In listing details and similar listings modes this is what the run reads; in search mode it is a filter.", "items": { "type": "string" } }, "addressKeys": { "title": "Building address keys", "type": "array", "description": "Building details mode. One address key per line, as returned in the addressKey column of a building search.", "items": { "type": "string" } }, "boardIds": { "title": "Board IDs", "type": "array", "description": "One MLS board ID per line. Keys often reach several boards, and the same MLS number can exist on more than one.", "items": { "type": "string" } }, "streetName": { "title": "Street name", "type": "string", "description": "Listing search. Narrows to one street, which with a street number is how to find a specific address." }, "streetNumber": { "title": "Street number", "type": "string", "description": "Listing search. Used together with a street name." }, "addressKey": { "title": "Address key", "type": "string", "description": "Listing search. Returns every listing the provider has grouped at one address." }, "latitude": { "title": "Latitude", "type": "string", "description": "Centre of a radius search. Give a longitude and a radius with it." }, "longitude": { "title": "Longitude", "type": "string", "description": "Centre of a radius search. Give a latitude and a radius with it." }, "radiusKm": { "title": "Radius", "minimum": 1, "type": "integer", "description": "Radius searches and similar listings mode. In the provider's own units, kilometres." }, "mapPolygon": { "title": "Map polygon", "type": "string", "description": "Listing search. A polygon in the provider's map format, for searching an arbitrary drawn area rather than an administrative one." }, "mapOperator": { "title": "Map operator", "enum": [ "AND", "OR" ], "type": "string", "description": "How the map polygon combines with the other filters." }, "classes": { "title": "Classes", "type": "array", "description": "One class per line, for example ResidentialProperty, CondoProperty or CommercialProperty.", "items": { "type": "string" } }, "types": { "title": "Sale or lease", "type": "array", "description": "Sale returns properties for sale; lease returns rentals.", "items": { "type": "string", "enum": [ "Sale", "Lease" ], "enumTitles": [ "Sale", "Lease" ] } }, "propertyTypes": { "title": "Property types", "type": "array", "description": "One property type per line, in the board's own spelling. Use the aggregates parameter to discover what a board actually uses.", "items": { "type": "string" } }, "styles": { "title": "Styles", "type": "array", "description": "One style per line, for example Bungalow, 2-Storey or Apartment.", "items": { "type": "string" } }, "statuses": { "title": "Statuses", "type": "array", "description": "The board's short status codes. A is active and U is unavailable, which is how to search off-market history.", "items": { "type": "string", "enum": [ "A", "U" ], "enumTitles": [ "Active", "Unavailable" ] } }, "standardStatuses": { "title": "Standard statuses", "type": "array", "description": "The RESO standard status, which is comparable across boards where the short codes are not.", "items": { "type": "string", "enum": [ "Active", "Active Under Contract", "Canceled", "Closed", "Coming Soon", "Expired", "Hold", "Incomplete", "Pending", "Withdrawn" ], "enumTitles": [ "Active", "Active under contract", "Canceled", "Closed", "Coming soon", "Expired", "Hold", "Incomplete", "Pending", "Withdrawn" ] } }, "lastStatuses": { "title": "Last statuses", "type": "array", "description": "The board's last-status code, for example New, Sld, Lsd, Ter or Exp. This is the field that says how a listing ended.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum list price", "type": "integer", "description": "In the listing's own currency. On a lease listing this is the monthly rent." }, "maxPrice": { "title": "Maximum list price", "type": "integer", "description": "In the listing's own currency. On a lease listing this is the monthly rent." }, "minSoldPrice": { "title": "Minimum sold price", "type": "integer", "description": "Only meaningful alongside a sold status, since unsold listings carry no sold price." }, "maxSoldPrice": { "title": "Maximum sold price", "type": "integer", "description": "Only meaningful alongside a sold status." }, "minBedrooms": { "title": "Minimum bedrooms", "type": "integer", "description": "The base bedroom count, not counting a converted basement room." }, "maxBedrooms": { "title": "Maximum bedrooms", "type": "integer", "description": "The base bedroom count, not counting a converted basement room." }, "minBedroomsPlus": { "title": "Minimum plus bedrooms", "type": "integer", "description": "The extra rooms in the local \"3+1\" notation, meaning a converted basement room." }, "maxBedroomsPlus": { "title": "Maximum plus bedrooms", "type": "integer", "description": "The extra rooms in the local \"3+1\" notation." }, "maxBedroomsTotal": { "title": "Maximum total bedrooms", "type": "integer", "description": "Base and plus bedrooms added together." }, "minBaths": { "title": "Minimum bathrooms", "type": "integer", "description": "Full bathrooms." }, "maxBaths": { "title": "Maximum bathrooms", "type": "integer", "description": "Full bathrooms." }, "minBathroomsHalf": { "title": "Minimum half bathrooms", "type": "integer", "description": "Powder rooms, counted separately from full bathrooms." }, "maxBathroomsHalf": { "title": "Maximum half bathrooms", "type": "integer", "description": "Powder rooms, counted separately from full bathrooms." }, "minSqft": { "title": "Minimum square footage", "type": "integer", "description": "Interior area. Many boards publish a band rather than a figure, so this filters on the band's edge." }, "maxSqft": { "title": "Maximum square footage", "type": "integer", "description": "Interior area." }, "minLotSizeSqft": { "title": "Minimum lot size", "type": "integer", "description": "In square feet." }, "maxLotSizeSqft": { "title": "Maximum lot size", "type": "integer", "description": "In square feet." }, "minLotWidth": { "title": "Minimum lot width", "type": "integer", "description": "In the board's own units, usually feet." }, "maxLotWidth": { "title": "Maximum lot width", "type": "integer", "description": "In the board's own units, usually feet." }, "minLotDepth": { "title": "Minimum lot depth", "type": "integer", "description": "In the board's own units, usually feet." }, "maxLotDepth": { "title": "Maximum lot depth", "type": "integer", "description": "In the board's own units, usually feet." }, "minYearBuilt": { "title": "Built no earlier than", "type": "integer", "description": "A four digit year. Many boards publish a band here too." }, "maxYearBuilt": { "title": "Built no later than", "type": "integer", "description": "A four digit year." }, "minDaysOnMarket": { "title": "Minimum days on market", "type": "integer", "description": "A high floor finds stale stock, which is where negotiation room usually is." }, "maxDaysOnMarket": { "title": "Maximum days on market", "type": "integer", "description": "A low ceiling finds fresh listings." }, "minParkingSpaces": { "title": "Minimum parking spaces", "type": "integer", "description": "Total spaces including the garage." }, "maxParkingSpaces": { "title": "Maximum parking spaces", "type": "integer", "description": "Total spaces including the garage." }, "minGarageSpaces": { "title": "Minimum garage spaces", "type": "integer", "description": "Garage spaces only." }, "minKitchens": { "title": "Minimum kitchens", "type": "integer", "description": "More than one kitchen usually means a legal second suite." }, "maxKitchens": { "title": "Maximum kitchens", "type": "integer", "description": "More than one kitchen usually means a legal second suite." }, "minStories": { "title": "Minimum storeys", "type": "integer", "description": "Storeys in the building." }, "maxStories": { "title": "Maximum storeys", "type": "integer", "description": "Storeys in the building." }, "maxMaintenanceFee": { "title": "Maximum maintenance fee", "type": "integer", "description": "Condominium listings. The monthly common element fee." }, "minTaxes": { "title": "Minimum annual taxes", "type": "integer", "description": "The annual property tax amount on file." }, "maxTaxes": { "title": "Maximum annual taxes", "type": "integer", "description": "The annual property tax amount on file." }, "minListDate": { "title": "Listed on or after", "type": "string", "description": "As YYYY-MM-DD." }, "maxListDate": { "title": "Listed on or before", "type": "string", "description": "As YYYY-MM-DD." }, "minSoldDate": { "title": "Sold on or after", "type": "string", "description": "As YYYY-MM-DD. This is the filter for a sold comparables study." }, "maxSoldDate": { "title": "Sold on or before", "type": "string", "description": "As YYYY-MM-DD." }, "minClosedDate": { "title": "Closed on or after", "type": "string", "description": "As YYYY-MM-DD. Closing is later than the sale date." }, "maxClosedDate": { "title": "Closed on or before", "type": "string", "description": "As YYYY-MM-DD." }, "minUpdatedOn": { "title": "Board updated on or after", "type": "string", "description": "As YYYY-MM-DD. The board's own timestamp." }, "maxUpdatedOn": { "title": "Board updated on or before", "type": "string", "description": "As YYYY-MM-DD." }, "minRepliersUpdatedOn": { "title": "Provider updated on or after", "type": "string", "description": "As YYYY-MM-DD. The provider's own ingestion timestamp, which is the right one for a reliable daily delta." }, "maxRepliersUpdatedOn": { "title": "Provider updated on or before", "type": "string", "description": "As YYYY-MM-DD." }, "minUnavailableDate": { "title": "Went unavailable on or after", "type": "string", "description": "As YYYY-MM-DD." }, "maxUnavailableDate": { "title": "Went unavailable on or before", "type": "string", "description": "As YYYY-MM-DD." }, "minOpenHouseDate": { "title": "Open house on or after", "type": "string", "description": "As YYYY-MM-DD." }, "maxOpenHouseDate": { "title": "Open house on or before", "type": "string", "description": "As YYYY-MM-DD." }, "basements": { "title": "Basement", "type": "array", "description": "One basement value per line, for example Finished, Walk-Out or None.", "items": { "type": "string" } }, "heating": { "title": "Heating", "type": "array", "description": "One heating value per line, for example Forced Air or Radiant.", "items": { "type": "string" } }, "garages": { "title": "Garage", "type": "array", "description": "One garage value per line, for example Built-In, Attached or Detached.", "items": { "type": "string" } }, "swimmingPools": { "title": "Swimming pool", "type": "array", "description": "One pool value per line, for example Inground or Above Ground.", "items": { "type": "string" } }, "waterSources": { "title": "Water source", "type": "array", "description": "One water source per line, for example Municipal or Well.", "items": { "type": "string" } }, "sewers": { "title": "Sewer", "type": "array", "description": "One sewer value per line, for example Sewer or Septic.", "items": { "type": "string" } }, "amenities": { "title": "Amenities", "type": "array", "description": "One amenity per line, for example Gym or Concierge.", "items": { "type": "string" } }, "exteriorConstruction": { "title": "Exterior construction", "type": "array", "description": "One material per line, for example Brick or Stucco.", "items": { "type": "string" } }, "streetSuffixes": { "title": "Street suffixes", "type": "array", "description": "One suffix per line, for example St, Ave or Circ.", "items": { "type": "string" } }, "unitNumbers": { "title": "Unit numbers", "type": "array", "description": "One unit number per line.", "items": { "type": "string" } }, "lockers": { "title": "Locker", "type": "array", "description": "One locker value per line. Condominium listings.", "items": { "type": "string" } }, "driveways": { "title": "Driveway", "type": "array", "description": "One driveway value per line, for example Private or Mutual.", "items": { "type": "string" } }, "balconies": { "title": "Balcony", "type": "array", "description": "One balcony value per line, for example Open or Enclosed.", "items": { "type": "string" } }, "dens": { "title": "Den", "type": "array", "description": "Whether the listing has a den. Boards publish this as Y or N.", "items": { "type": "string" } }, "agents": { "title": "Agent names or IDs", "type": "array", "description": "One agent name or ID per line, which is how to pull one agent's whole book.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "string", "description": "Full text search across the listing. Also the keyword filter in agents and offices modes." }, "searchFields": { "title": "Fields to search", "type": "string", "description": "Which fields the keyword search looks at, as a comma separated list. Narrowing it makes a keyword search far more precise." }, "hasImages": { "title": "Has images", "type": "boolean", "description": "Leave this alone to ignore it. Ticked keeps only listings with photographs." }, "hasAgents": { "title": "Has agent details", "type": "boolean", "description": "Leave this alone to ignore it. Ticked keeps only listings the board publishes agent contact details for." }, "filterOperator": { "title": "Combine filters with", "enum": [ "AND", "OR" ], "type": "string", "description": "Whether a listing must match every filter or any of them.", "default": "AND" }, "sortBy": { "title": "Sort by", "enum": [ "updatedOnDesc", "createdOnDesc", "repliersUpdatedOnDesc", "listPriceAsc", "listPriceDesc", "soldPriceDesc", "soldDateDesc", "listDateAsc", "listDateDesc", "sqftDesc", "bedsDesc", "bathsDesc", "yearBuiltDesc", "distanceAsc", "listPricePerSqFtAsc", "listPricePerSqFtDesc", "soldPricePerSqFtDesc", "random" ], "type": "string", "description": "Listing search and similar listings modes.", "default": "repliersUpdatedOnDesc" }, "fields": { "title": "Fields to return", "type": "string", "description": "A comma separated list of fields, which cuts the response down when you only need a few. Leave empty for the full record." }, "includeLocations": { "title": "Include location detail", "type": "boolean", "description": "Listing details mode. Adds the resolved location objects for the listing." }, "listPriceRange": { "title": "Similar listing price window", "minimum": 1, "type": "integer", "description": "Similar listings mode. How far either side of the subject's list price a similar listing may be." }, "statistics": { "title": "Statistics", "type": "array", "description": "Market statistics mode. The provider's own statistic names: a prefix of avg, med, min, max, sum, sd or cnt, then the measure. Add a grp prefix to group the result by period.", "items": { "type": "string" } }, "aggregates": { "title": "Aggregate fields", "type": "string", "description": "Market statistics mode. A comma separated list of fields to count distinct values for, which is how to discover what a board actually publishes in a field." }, "groupAggregates": { "title": "Group statistics by the aggregates", "type": "boolean", "description": "Market statistics mode. Computes each statistic once per aggregate value rather than once overall." }, "buildingNames": { "title": "Building names", "type": "array", "description": "Building search. One building name per line.", "items": { "type": "string" } }, "streetNames": { "title": "Street names", "type": "array", "description": "Building search. One street name per line.", "items": { "type": "string" } }, "buildingDealType": { "title": "Building listings side", "enum": [ "sale", "lease" ], "type": "string", "description": "Building search. Whether to weigh the building by its sale or its lease listings." }, "locationSearches": { "title": "Location searches", "type": "array", "description": "Locations mode. One partial place name per line switches the mode to autocomplete, which is what a location picker needs. Leave empty to list locations by the city, area and neighbourhood filters instead.", "items": { "type": "string" } }, "locationClassifications": { "title": "Location classifications", "type": "array", "description": "Locations mode. One classification per line, which is how to ask for only schools, or only neighbourhoods.", "items": { "type": "string" } }, "withBoundaries": { "title": "Include boundaries", "type": "boolean", "description": "Locations mode. Adds each location's polygon, which is what you need to draw it on a map." }, "agentName": { "title": "Agent name", "type": "string", "description": "Agents mode. A partial agent name to search for." }, "agentId": { "title": "Agent ID", "type": "string", "description": "Agents mode. One agent ID to read." }, "brokerage": { "title": "Brokerage", "type": "string", "description": "Agents mode. A partial brokerage name." }, "officeId": { "title": "Office ID", "type": "string", "description": "Agents and offices modes. One office ID." }, "hasEmail": { "title": "Only agents with an email", "type": "boolean", "description": "Agents mode. Ticked keeps only agents the board publishes an email address for." }, "maxResults": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "The most rows this run will save and charge for. This is the spending control on both sides.", "default": 1000 }, "pageSize": { "title": "Results per request", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many rows to ask for at a time, up to the provider's ceiling of 100.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 1200, "type": "integer", "description": "How fast to call the provider. Lower this if your plan is metered tightly.", "default": 300 }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Only set this if the provider has given you a different host. Leave empty to use the documented one." }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key for the MLS listings provider. This actor is bring your own key: it never uses anyone else's credentials, and the key is stored as a secret." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }