{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"SiftMap API","description":"Guides and API reference for the DataSift (REISift) Core API and SiftMap API."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"siftmap-api","__idx":0},"children":["SiftMap API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SiftMap is the nationwide property layer: search any US property by location and criteria, read its full record, and add the ones you want to your DataSift account. Saved map filters can feed matching properties into your account automatically."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SiftMap requests use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://map.reisift.io"]}," and the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Api-Key"]}," header as other DataSift requests. Full reference: the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/datasift"},"children":["SiftMap group in the DataSift API reference"]},". Criteria keys: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/siftmap-filters"},"children":["SiftMap filter reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"search-properties","__idx":1},"children":["Search properties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /properties/search/"]}," takes a location, criteria, or both:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://map.reisift.io/properties/search/ \\\n  -H \"Authorization: Api-Key YOUR_OPEN_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"addresses\": [{\"type\": \"county\", \"search\": \"Franklin\", \"state\": \"OH\"}],\n    \"filters\": {\n      \"type_single_family\": true,\n      \"value_max\": 700000,\n      \"extra_mls_status\": [\"not_listed\"],\n      \"distressors_include\": \"is_vacant_property\",\n      \"distressors_include_min_match\": 1\n    },\n    \"size\": 25,\n    \"result_index\": 0\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Locations to search: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"type\": \"state\" | \"county\" | \"city\" | \"zip\" | \"address\", \"search\": \"...\", \"state\": \"OH\"}"]},". County and city need ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["polygon"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A map area: a closed ring of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"lat\": ..., \"lon\": ...}"]}," points."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Property criteria. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/siftmap-filters"},"children":["filter reference"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Results per page. Keep it at 25-100."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result_index"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero-based index of the first result (offset)."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provide at least one of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["polygon"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},". The response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"result_index\": 0,\n  \"total_pages\": 155,\n  \"page_results\": 25,\n  \"total_results\": 3853,\n  \"polygon\": [],\n  \"data\": [\n    {\n      \"id\": \"102752166\",\n      \"address\": \"123 Main St, Columbus, OH 43207\",\n      \"county\": \"Franklin\", \"state\": \"OH\", \"fips\": \"39049\",\n      \"bedrooms\": 2, \"bathrooms\": 2, \"squareFeet\": 936.0,\n      \"estimatedValue\": 85000.0, \"equityPercent\": 100,\n      \"absenteeOwner\": true, \"mlsActive\": false,\n      \"saved\": false, \"saved_uuid\": null,\n      \"investor_on_market_score\": 78, \"realtor_score\": 19\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saved"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saved_uuid"]}," tell you whether the property is already in your account. Unknown filter keys are ignored, so check ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_results"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size: 1"]}," when you change criteria."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"property-details","__idx":2},"children":["Property details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /properties/detail/{property_id}/"]}," returns the full nationwide record for one property: building and lot, tax and assessment, sale and mortgage history, MLS history, owner portfolio, distressors with dates, and scores. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["property_id"]}," is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from search results."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-properties-to-your-account","__idx":3},"children":["Add properties to your account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Adding properties creates property records in your account and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["consumes property usage credits"]},". Always quote first; quotes store and charge nothing."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Body"},"children":["Body"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/properties/add-properties/quote/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"ids\": [\"102752166\", ...]}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/properties/add-properties/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same as above"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/properties/add-properties-by-query/quote/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"query\": <search body>}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/properties/add-properties-by-query/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same as above"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A quote tells you how many properties are already in your account, how many are new, and how many are billable:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\"total\": 25, \"in_account\": 3, \"new\": 22, \"already_fetched\": 0, \"billable\": 22, \"cost\": null, \"shortfall\": null}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For add-by-query, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query.result_index"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query.size"]}," bound which results are added. These endpoints return errors as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"success\": false, \"message\": \"...\", \"details\": {\"ids\": [\"This field is required.\"]}}"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After an add, records arrive in your account; verify with the DataSift API (for example the target list's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties-count"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"map-filters","__idx":4},"children":["Map filters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A SiftMap filter is a saved nationwide search. With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_add_enabled"]},", the platform snapshots matching properties and feeds them into your account with your chosen lists and tags applied - a standing data feed defined entirely by API."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/filters/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List saved filters (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page_size"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ordering"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_active"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/filters/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a filter"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/filters/{id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detail"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/filters/{id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/filters/{id}/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/filters/{id}/favorite/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mark or unmark favorite (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"is_favorite\": true}"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET / PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/filters/settings/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account-level filter settings"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create payload fields: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," (required), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter_data"]}," (required: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"filters\": {...}, \"addresses\": [...]}"]},", see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/siftmap-filters"},"children":["filter reference"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_active"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_add_enabled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email_enabled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["replace_owners_enabled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lists"]}," (list names to apply), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}," (tag names to apply), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit_type"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hourly"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daily"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weekly"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["monthly"]},") to throttle how many records auto-add per period."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"auto-add-rules-the-api-enforces","__idx":5},"children":["Auto-add rules the API enforces"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creating or enabling an auto-add filter runs a matching-property count on the server and checks two things: the account has SiftMap Pro, and the count fits within the snapshot property cap. A too-broad filter is rejected with a validation error rather than silently truncated. While a snapshot job runs, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter_data"]}," updates are blocked and duplicate snapshot jobs are prevented."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"the-safe-build-pattern","__idx":6},"children":["The safe build pattern"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create the filter with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_add_enabled: false"]}," and the target ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter_data"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read it back and confirm ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter_data"]}," is stored as intended."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set a conservative ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit_type"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["PATCH ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_add_enabled: true"]},". A validation error here means the filter matches too many properties; tighten it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify the feed: watch the target list's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties-count"]}," in the DataSift API and spot-read a few arriving records."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"map-heatmap","__idx":7},"children":["Map heatmap"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /properties/grid/"]}," returns property counts bucketed into a geotile grid, for drawing heatmaps. It takes the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," as search plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["precision"]}," (zoom level) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bounds"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["north"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["south"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["east"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["west"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"fair-use","__idx":8},"children":["Fair use"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SiftMap requests are subject to the limits described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/rate-limits"},"children":["Rate limits"]},". The intended pattern is: search, drill into some property details, then add the properties you want. Pulling large volumes of property details without adding them to your account is not allowed. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/acceptable-use"},"children":["Acceptable use"]},"."]}]},"headings":[{"value":"SiftMap API","id":"siftmap-api","depth":1},{"value":"Search properties","id":"search-properties","depth":2},{"value":"Property details","id":"property-details","depth":2},{"value":"Add properties to your account","id":"add-properties-to-your-account","depth":2},{"value":"Map filters","id":"map-filters","depth":2},{"value":"Auto-add rules the API enforces","id":"auto-add-rules-the-api-enforces","depth":3},{"value":"The safe build pattern","id":"the-safe-build-pattern","depth":3},{"value":"Map heatmap","id":"map-heatmap","depth":2},{"value":"Fair use","id":"fair-use","depth":2}],"frontmatter":{"seo":{"title":"SiftMap API"}},"lastModified":"2026-11-05T20:56:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/siftmap-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}