{"info":{"_postman_id":"0bb864ac-8811-469d-a84d-b8a25d3646a2","name":"Spark Web API Queries","description":"<html><head></head><body><h3 id=\"this-is-a-basic-collection-of-request-illustrating-how-to-interact-with-both-our-spark-api-and-reso-web-api\">This is a basic collection of request illustrating how to interact with both our <a href=\"http://sparkplatform.com/docs/overview/api\">Spark API</a> and <a href=\"http://sparkplatform.com/docs/reso/overview\">RESO Web API</a>.</h3>\n<hr>\n<h4 id=\"please-be-sure-to-select-your-preferred-layout-and-coding-language-at-the-top-left-corner-of-this-screen\"><strong>Please be sure to select your preferred layout and coding language at the top left corner of this screen.</strong></h4>\n<img src=\"https://content.pstmn.io/c7c6c79f-4ff4-4bd1-8e7d-013bad04dd05/UG9zdG1hbiBTY3JlZW5zaG90LnBuZw==\" width=\"1277\" height=\"189\">\n\n<hr>\n<h4 id=\"you-can-view-additional-query-examples-by-clicking-on-the-highlighted-area-in-the-screenshot-below\"><strong>You can view additional query examples by clicking on the highlighted area in the screenshot below.</strong></h4>\n<img src=\"https://content.pstmn.io/2407f62d-cf37-4128-befb-c23aa6799af9/UXVlcnkgZXhhbXBsZXMucG5n\" width=\"2096\" height=\"537\"></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25548936","collectionId":"0bb864ac-8811-469d-a84d-b8a25d3646a2","publishedId":"2s935snM26","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-09T19:06:11.000Z"},"item":[{"name":"Spark API","item":[{"name":"Get Accounts","item":[{"name":"All Accounts","id":"86c04889-ae8f-47f3-ba8a-4a502b084251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/accounts?","urlObject":{"protocol":"https","path":["v1","accounts"],"host":["replication","sparkapi","com"],"query":[{"key":"","value":null}],"variable":[]}},"response":[{"id":"b73c7956-0536-4771-97c6-2b1819ebea47","name":"Filter UserType","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/accounts?_filter=UserType eq 'Member'","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","accounts"],"query":[{"key":"_filter","value":"UserType eq 'Member'"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fa4db374-4d36-456e-82d8-3362741ee564","name":"Filter specific member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/accounts?_filter=(UserType eq 'Member') And (Name eq 'Insert_Member_Name')","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","accounts"],"query":[{"key":"_filter","value":"(UserType eq 'Member') And (Name eq 'Insert_Member_Name')"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9f26f5fd-95a4-43ca-9e57-a9980231cc95","name":"Filter specific member contact info","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/accounts?_filter=(UserType eq 'Member') And (Name eq 'Insert_Members_Name')&_select=Name,Emails,Phones","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","accounts"],"query":[{"key":"_filter","value":"(UserType eq 'Member') And (Name eq 'Insert_Members_Name')"},{"key":"_select","value":"Name,Emails,Phones"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"c9849609-698f-43db-90be-0d7b20eb4f4e","name":"Filter specific office","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/accounts?_filter=(UserType eq 'Office') And (Name eq 'Insert_Office_Name')","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","accounts"],"query":[{"key":"_filter","value":"(UserType eq 'Office') And (Name eq 'Insert_Office_Name')"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"62a02f5e-819f-4e8b-ac70-db513d1a23b9","name":"Filter office contact info","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/accounts?_filter=UserType eq 'Office' And (Name eq 'Insert_Office_Name')_select=Name,Phones,Emails","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","accounts"],"query":[{"key":"_filter","value":"UserType eq 'Office' And (Name eq 'Insert_Office_Name')_select=Name,Phones,Emails"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"5d9343d9-3b0b-4217-b8d2-32be8bb5cacf","name":"Filter all members in specific office","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/accounts?_filter=UserType eq 'Member' And (Office eq 'Insert_Office_Name')","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","accounts"],"query":[{"key":"_filter","value":"UserType eq 'Member' And (Office eq 'Insert_Office_Name')"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"39e344e8-ed2e-430b-bfbf-801af4be6001","name":"Filter Member & Multiple Offices","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/accounts?_filter=UserType eq 'Member' and (OfficeId eq '1234','1234')","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","accounts"],"query":[{"key":"_filter","value":"UserType eq 'Member' and (OfficeId eq '1234','1234')"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"86c04889-ae8f-47f3-ba8a-4a502b084251"},{"name":"Individual Account","id":"2a37b03b-780e-4e74-9957-6bf73fe8335e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/accounts/<insert_Id_here>","urlObject":{"protocol":"https","path":["v1","accounts","<insert_Id_here>"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a37b03b-780e-4e74-9957-6bf73fe8335e"},{"name":"Accounts: Associations","id":"38711d25-8585-457f-80b4-650890bc162e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/accounts/<Account.Id>/associations","description":"<p>The Accounts Associations service lists the association data for a given user.<br /><a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_associations\">http://sparkplatform.com/docs/api_services/my_account/accounts_associations</a></p>\n","urlObject":{"protocol":"https","path":["v1","accounts","<Account.Id>","associations"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"38711d25-8585-457f-80b4-650890bc162e"},{"name":"Accounts: Profile","id":"0458729f-4d7d-4e67-a562-d6e2600ab75d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/accounts/<Account.Id>/profile","description":"<p>The Profile sub-service allows management of the profile data associated with the active user.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/my_account/profile\">http://sparkplatform.com/docs/api_services/my_account/profile</a></p>\n","urlObject":{"protocol":"https","path":["v1","accounts","<Account.Id>","profile"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0458729f-4d7d-4e67-a562-d6e2600ab75d"}],"id":"98423c3f-c4ef-4405-8549-b8d07011fece","description":"<h5 id=\"the-accounts-service-provides-access-to-user-settings-and-profile-information\">The Accounts service provides access to user settings and profile information.</h5>\n<p><a href=\"http://sparkplatform.com/docs/api_services/my_account\">http://sparkplatform.com/docs/api_services/my_account</a></p>\n","_postman_id":"98423c3f-c4ef-4405-8549-b8d07011fece"},{"name":"PUT/POST Accounts","item":[{"name":"PUT Account","id":"8a9d05f5-f3da-4f3b-a1fd-6905c1f01662","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://replication.sparkapi.com/v1/accounts/<Account.Id>","urlObject":{"protocol":"https","path":["v1","accounts","<Account.Id>"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"1df10cf9-327d-451e-a221-575737c644c2","name":"Modify Names","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"D\": {\n        \"FirstName\": \"Charles\",\n        \"MiddleName\": \"Alexander \",\n        \"LastName\": \"Theg\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"https://replication.sparkapi.com/v1/accounts/<Account.Id>"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"1282884f-5db2-45f1-a7eb-70898aaa0886","name":"Modify Settings","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\"Settings\": {\n    \"Brokerload\": {\n        \"Level\": \"Member\",\n        \"PartialAccess\": false,\n        \"AddListing\": true,\n        \"ChangeListing\": true,\n        \"PriceChange\": true,\n        \"Media\": true,\n        \"Photos\": true,\n        \"Documents\": true,\n        \"Videos\": true,\n        \"VirtualTours\": true,\n        \"StatusChange\": true,\n        \"OpenHousesTours\": true,\n        \"MapLocation\": true,\n        \"Supplement\": true,\n        \"Remarks\": true,\n        \"Supra\": true,\n        \"SentriLock\": true\n    },\n    \"SearchRestrictions\": {\n        \"Associations\": false,\n        \"MlsStatus\": [\n            \"Active\",\n            \"CPR Testing Coming Soon\",\n            \"Pending\",\n            \"Closed\",\n            \"Rented\",\n            \"Expired\",\n            \"Withdrawn\",\n            \"Cancelled\",\n            \"Coming Soon\"\n        ],\n        \"PostalCode\": null,\n        \"PropertyTypes\": [\n            \"A\",\n            \"B\",\n            \"C\",\n            \"D\",\n            \"E\",\n            \"F\",\n            \"G\",\n            \"H\",\n            \"I\",\n            \"J\"\n        ]\n    },\n    \"SystemAccess\": false,\n    \"Visible\": true,\n    \"VirtualTourProvider\": false,\n    \"RosterOnly\": false,\n    \"FbsIdxCustomer\": false,\n    \"FbsBillable\": true,\n    \"MlsSystemAccess\": true,\n    \"Enabled\": false,\n    \"SuperUser\": {\n        \"Users\": []\n    },\n    \"FlexmlsProducts\": [\n        \"DesktopIdx\",\n        \"MobileIdx\",\n        \"Floplan\"\n    ]\n},","options":{"raw":{"language":"json"}}},"url":"https://replication.sparkapi.com/v1/accounts/<Account.Id>"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8a9d05f5-f3da-4f3b-a1fd-6905c1f01662"},{"name":"POST Account","id":"0cf8b4ff-3c4f-4726-b530-a551143772a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://replication.sparkapi.com/v1/accounts/<Account.Id>","urlObject":{"protocol":"https","path":["v1","accounts","<Account.Id>"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0cf8b4ff-3c4f-4726-b530-a551143772a8"}],"id":"228465af-81e8-4449-9937-5f94bf606e04","description":"<h5 id=\"the-accounts-service-provides-access-to-user-settings-and-profile-information\">The Accounts service provides access to user settings and profile information.</h5>\n<p><a href=\"http://sparkplatform.com/docs/api_services/my_account\">http://sparkplatform.com/docs/api_services/my_account</a></p>\n<p><strong>General</strong></p>\n<p>We have two APIs: the <a href=\"http://sparkplatform.com/docs/api_services/read_first\">Spark API</a> and our <a href=\"http://sparkplatform.com/docs/reso/overview\">RESO Web API</a>. The Spark API is what you'll use to make account updates: it can support writes and its account data most closely resembles what's in Flexmls, since there's no translation to standard RESO Data Dictionary fields. Here are the <a href=\"http://sparkplatform.com/docs/api_services/my_account\">docs for the /account service</a>.</p>\n<p>FBS use a \"tech ID\" as the system key. That is a 26-digit integer string, available as an account's \"Id\" field, and is unique within an MLS. This is the proper way to identify accounts. There is also a \"ShortId\" field, which is the member's identifier in the MLS which they may know. <strong>NB:</strong> \"ShortId\" is <em>not</em> a unique identifier for accounts. When a user changes offices, a new, pared-back account with only bare-bones data is created to house their old listings from their former office. That old account is set as inactive and not visible as soon as it's created, and it shares the same \"ShortId\" as the active account in the new office.</p>\n<p>The Spark API's <a href=\"http://sparkplatform.com/docs/api_services/my_account\">accounts</a> index service requires a \"UserType\" filter be included:</p>\n<p>GET <a href=\"https://replication.sparkapi.com/v1/accounts?_filter=UserType\">https://replication.sparkapi.com/v1/accounts?_filter=UserType</a> eq 'Member'</p>\n<p>GET <a href=\"https://replication.sparkapi.com/v1/accounts?_filter=UserType\">https://replication.sparkapi.com/v1/accounts?_filter=UserType</a> eq 'Office'</p>\n<p>By default, only active and visible members and offices are returned. To get <em>all</em> accounts back, you'll need to include a filter on \"Visible\". Here's an example of pulling all accounts:</p>\n<p>GET <a href=\"https://replication.sparkapi.com/v1/accounts?_filter=UserType\">https://replication.sparkapi.com/v1/accounts?_filter=UserType</a> eq 'Member' and (Visible eq true or Visible eq false)</p>\n<p>When you set a member inactive, you'll generally want to update the \"Active\" <em>and</em> the \"Visible\" field to false.</p>\n<p>Here is the <a href=\"http://sparkplatform.com/docs/api_services/my_account#expansions\">list of expansions</a> that can be included with requests for account data. Of particular note are the \"Settings\" and \"LoginName\" expansions:</p>\n<p>GET <a href=\"https://replication.sparkapi.com/v1/accounts?_filter=UserType\">https://replication.sparkapi.com/v1/accounts?_filter=UserType</a> eq 'Member'&amp;_expand=Settings,LoginName</p>\n<p>Some expansions have a \"Single Record Only\" limitation (noted in the docs), which means when you use them you either have to put a specific account's tech ID in the <a href=\"http://sparkplatform.com/docs/api_services/my_account#RetrieveAccountInfoById\">request path directly</a>, or else include a \"_limit=1\" parameter.</p>\n<h2 id=\"post-requests\">POST Requests</h2>\n<p>Creating a new account is achieved by <a href=\"https://sparkplatform.com/docs/api_services/my_account#RetrieveAccountInfoForAllUsers\">posting to the account index endpoint</a> with JSON body data:</p>\n<p>POST <a href=\"https://replication.sparkapi.com/v1/accounts\">https://replication.sparkapi.com/v1/accounts</a></p>\n<p>It's important to note, the <strong>OwnerId</strong> field is not applicable during the account creation process.</p>\n<h2 id=\"put-requests\">PUT Requests</h2>\n<p>Updating an existing account is achieved by PUTting to an account-specific request path with JSON body data:</p>\n<p>PUT <a href=\"https://replication.sparkapi.com/v1/accounts/20190826160135933324000000\">https://replication.sparkapi.com/v1/accounts/20190826160135933324000000</a></p>\n<p>Your HTTP requests must have the following headers:</p>\n<ul>\n<li><p>\"X-SparkApi-User-Agent\" set to an arbitrary string (e.g. \"Tangilla\")</p>\n</li>\n<li><p>\"Content-Type\" set to \"application/json\"</p>\n</li>\n</ul>\n<p>All body data must be valid JSON and wrapped in a \"D\" attribute, like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\nACCOUNT DATA HERE\n    }\n}\n\n</code></pre>\n<p><strong>Member names</strong></p>\n<p>For member accounts, don't directly modify the \"Name\" field. Instead, modify the \"FirstName\", \"MiddleName\", and \"LastName\" fields, and those will in turn populate the \"Name\" field.</p>\n<p>Example POST/PUT data:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"FirstName\": \"Charles\",\n        \"MiddleName\": \"Alexander \",\n        \"LastName\": \"Theg\"\n    }\n}\n\n</code></pre>\n<p><strong>Phone numbers</strong></p>\n<p>A user can have multiple phone numbers associated with their account, e.g.:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">\"Phones\": [\n    {\n        \"Id\": \"20211028205707882518000000\",\n        \"Name\": \"Office\",\n        \"Primary\": true,\n        \"Type\": \"Office\",\n        \"Number\": \"098-765-4321\",\n        \"InternationalCode\": null,\n        \"AreaCode\": \"098\",\n        \"Prefix\": \"765\",\n        \"LineNumber\": \"4321\",\n        \"Extension\": null\n    },\n    {\n        \"Id\": \"20211028205707882517000000\",\n        \"Name\": \"pager\",\n        \"Primary\": false,\n        \"Type\": \"Pager\",\n        \"Number\": \"123-456-7890\",\n        \"InternationalCode\": null,\n        \"AreaCode\": \"123\",\n        \"Prefix\": \"456\",\n        \"LineNumber\": \"7890\",\n        \"Extension\": null\n    }\n],\n\n</code></pre>\n<ul>\n<li><p>Only one phone number at a time can be designated as the primary phone (include \"Primary\": true with the record). If a phone record is entered and it's the only existing phone number, it will default to primary.</p>\n</li>\n<li><p>The Spark API's <a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_meta\">/accounts/meta</a> service will list all the valid phone \"Type\"s set up in Flexmls. <strong>NB:</strong> it includes \"Primary\" but that is a bug - do not upload records with a phone type of \"Primary\" as those will not come through properly in Flexmls. Instead, designate a different \"Type\" and include \"Primary\": true with your POST or PUT data.</p>\n<ul>\n<li>\"Type\" field must also be unique per user.</li>\n</ul>\n</li>\n<li><p>Do not write directly to the \"Number\" field for phone records. Instead, update the constituent fields from which the \"Number\" field is assembled: \"AreaCode\", \"Prefix\", and \"LineNumber\".</p>\n</li>\n<li><p>Do not write to the \"ProfileDisplay\" field: it is not writable and can cause failures.</p>\n</li>\n<li><p>When adding a new phone number, you <strong>must</strong> send in all existing phone data as part of your PUT request body data. PUTing a single new phone record in will erase all other existing phone records.</p>\n</li>\n</ul>\n<p>Example POST/PUT data:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Phones\": [\n            {\n                \"Name\": \"Office\",\n                \"Type\": \"Office\",\n                \"Primary\": true  \n                \"AreaCode\": \"907\",\n                \"Prefix\": \"279\",\n                \"LineNumber\": \"8235\",\n            }\n        ]\n    }\n}\n\n</code></pre>\n<p><strong>Emails</strong></p>\n<p>Accounts can have multiple email addresses associated with them:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">\"Emails\": [\n    {\n        \"Id\": \"20220303234240455293000000\",\n        \"Name\": \"Primary email\",\n        \"Primary\": true,\n        \"Type\": \"Office\",\n        \"Address\": \"atheg@fbsdata.com\"\n    },\n    {\n        \"Id\": \"20220303234240455292000000\",\n        \"Name\": \"Secondary email\",\n        \"Primary\": false,\n        \"Type\": \"Home\",\n        \"Address\": \"api-support@fbsdata.com\"\n    }\n],\n\n</code></pre>\n<ul>\n<li><p>Only one email at time can be designated as the primary. If a record is entered and it's the only existing email, it will default to primary.</p>\n</li>\n<li><p>All \"Address\" fields must be unique per user.</p>\n</li>\n<li><p>The Spark API's <a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_meta\">/accounts/meta</a> service will list all the valid email \"Type\"s set up in Flexmls.</p>\n</li>\n<li><p>Do not write to the \"ProfileDisplay\" field: it is not writable and can cause failures.</p>\n</li>\n<li><p>When adding a new email, you <strong>must</strong> send in all existing email data as part of your PUT request body data. PUTing a single new email record in will erase all other existing emails.</p>\n</li>\n</ul>\n<p>Example POST/PUT data:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Emails\": [\n            {\n                \"Name\": \"Primary email\",\n                \"Primary\": true,\n                \"Type\": \"Office\",\n                \"Address\": \"atheg@fbsdata.com\"\n            }\n        ]\n    }\n}\n\n</code></pre>\n<p><strong>Addresses</strong></p>\n<p>Accounts can have multiple addresses associated with them:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">\"Addresses\": [\n    {\n        \"Id\": \"20220303205746216161000000\",\n        \"Name\": \"Primary work\",\n        \"Primary\": true,\n        \"Type\": \"Office\",\n        \"Address\": \"1234 Cambert Rd, Sterling, CA 91332\",\n        \"Street1\": \"1234 Cambert Rd\",\n        \"Street2\": null,\n        \"City\": \"Sterling\",\n        \"Region\": \"CA\",\n        \"PostalCode\": \"91332\"\n    },\n    {\n        \"Id\": \"20220303210755340201000000\",\n        \"Name\": \"Secondary work\",\n        \"Primary\": false,\n        \"Type\": \"Office\",\n        \"Address\": \"1601 Baywood Ln, Davis, CA 95618\",\n        \"Street1\": \"1601 Baywood Ln\",\n        \"Street2\": null,\n        \"City\": \"Davis\",\n        \"Region\": \"CA\",\n        \"PostalCode\": \"95618\"\n    }\n],\n\n</code></pre>\n<ul>\n<li><p>Only one address at a time can be designated as primary (include \"Primary\": true with the record). If an address is entered and it's the only existing address, it will default to primary.</p>\n</li>\n<li><p>The Spark API's <a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_meta\">/accounts/meta</a> service will list all the valid address \"Type\"s set up in Flexmls.</p>\n<ul>\n<li>\"Type\" field must be unique per user.</li>\n</ul>\n</li>\n<li><p>Do not write directly to the \"Address\" field. Instead, update the constituent fields: \"Street1\", \"Street2\", \"City\", \"Region\", and \"PostalCode\"</p>\n</li>\n<li><p>Do not write to the \"ProfileDisplay\" field: it is not writable and can cause failures.</p>\n</li>\n<li><p>When adding a new address, you <strong>must</strong> send in all existing address data as part of your PUT request body data. PUTing a single new record in will erase all other existing address records.</p>\n</li>\n<li><p>If you use the same \"Name\" value for two addresses, it'll drop one, even if the details are different. \"Name\" field must be unique per user. E.g. you can't have two different addresses with \"Name\": \"Adam's address\", but you can have multiple addresses of the same type.</p>\n</li>\n</ul>\n<p><strong>Example POST/PUT data</strong>:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Addresses\": [\n            {\n                \"Name\": \"Secondary work\",\n                \"Primary\": false,\n                \"Type\": \"Office\",\n                \"Street1\": \"1601 Baywood Ln\",\n                \"Street2\": null,\n                \"City\": \"Davis\",\n                \"Region\": \"CA\",\n                \"PostalCode\": \"95618\"\n            }\n        ]\n    }\n}\n\n</code></pre>\n<p><strong>Websites</strong></p>\n<p>Accounts can have multiple websites associated with them.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">\"Websites\": [\n    {\n        \"Id\": \"20220304002746757047000000\",\n        \"Name\": \"Main office website\",\n        \"Primary\": true,\n        \"ProfileDisplay\": true,\n        \"Uri\": \"https://flexmls.com\",\n        \"Type\": \"Office\"\n    }\n],\n\n</code></pre>\n<ul>\n<li><p>Only one website can be designated as the primary. If there's only one existing website, it will default to primary.</p>\n</li>\n<li><p>The Spark API's <a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_meta\">/accounts/meta</a> service will list all the valid website \"Type\"s set up in Flexmls.</p>\n</li>\n<li><p>Do not write to the \"ProfileDisplay\" field: it is not writable and can cause failures.</p>\n</li>\n<li><p>When adding a new website, you <strong>must</strong> send in all existing website data as part of your PUT request body data. PUTing a single new website record will erase all other existing websites.</p>\n</li>\n</ul>\n<p><strong>Example POST/PUT data:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Websites\": [\n            {\n                \"Name\": \"Main office website\",\n                \"Primary\": true,\n                \"Uri\": \"https://flexmls.com\",\n                \"Type\": \"Office\"\n            }\n        ]\n    }\n}\n\n</code></pre>\n<p><strong>Tags</strong></p>\n<p>The \"Tags\" field allows you to set the \"Member Type\" or \"Office Type\" for an account. The name is a misnomer that implies a different use, and while the Spark API will technically accept multiple tags, that's not how it's used. Accounts should always have one single tag noting the account type - no more and no less. Flexmls uses the same list of tags for both members and offices. The list of tags set up in Flexmls is available via the <a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_meta\">/accounts/meta</a> service.</p>\n<p>Example POST/PUT request data:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Tags\": [\n            \"Designated REALTOR Participant\"\n        ]\n    }\n}\n\n</code></pre>\n<p><strong>Settings</strong></p>\n<p>The \"Settings\" has contains many important account settings. Here's an example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">\"Settings\": {\n    \"Brokerload\": {\n        \"Level\": \"Member\",\n        \"PartialAccess\": false,\n        \"AddListing\": true,\n        \"ChangeListing\": true,\n        \"PriceChange\": true,\n        \"Media\": true,\n        \"Photos\": true,\n        \"Documents\": true,\n        \"Videos\": true,\n        \"VirtualTours\": true,\n        \"StatusChange\": true,\n        \"OpenHousesTours\": true,\n        \"MapLocation\": true,\n        \"Supplement\": true,\n        \"Remarks\": true,\n        \"Supra\": true,\n        \"SentriLock\": true\n    },\n    \"SearchRestrictions\": {\n        \"Associations\": false,\n        \"MlsStatus\": [\n            \"Active\",\n            \"CPR Testing Coming Soon\",\n            \"Pending\",\n            \"Closed\",\n            \"Rented\",\n            \"Expired\",\n            \"Withdrawn\",\n            \"Cancelled\",\n            \"Coming Soon\"\n        ],\n        \"PostalCode\": null,\n        \"PropertyTypes\": [\n            \"A\",\n            \"B\",\n            \"C\",\n            \"D\",\n            \"E\",\n            \"F\",\n            \"G\",\n            \"H\",\n            \"I\",\n            \"J\"\n        ]\n    },\n    \"SystemAccess\": false,\n    \"Visible\": true,\n    \"VirtualTourProvider\": false,\n    \"RosterOnly\": false,\n    \"FbsIdxCustomer\": false,\n    \"FbsBillable\": true,\n    \"MlsSystemAccess\": true,\n    \"Enabled\": false,\n    \"SuperUser\": {\n        \"Users\": []\n    },\n    \"FlexmlsProducts\": [\n        \"DesktopIdx\",\n        \"MobileIdx\",\n        \"Floplan\"\n    ]\n},\n\n</code></pre>\n<p>When writing to fields in the \"Settings\" hash, <strong>as well as the \"Active\" field,</strong> you need to wrap them in a \"Settings\" object. Example POST/PUT data:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Settings\": {\n            \"Active\": true,\n            \"SystemAccess\": true,\n            \"FbsBillable\": true,\n            \"BrokerLoad\": {\n                \"Level\": \"Member\"\n            }\n        }\n    }\n}\n\n</code></pre>\n<ul>\n<li><p>\"SystemAccess\" is derived from the \"Active\", \"Enabled\", and \"MlsSystemAccess\" fields. All three must by set to true for \"SystemAccess to also be true; otherwise, it is false.</p>\n<ul>\n<li><p>\"Active\" can be set directly in Flexmls</p>\n</li>\n<li><p>\"Enabled\" comes from the \"System Access\" Flexmls field</p>\n</li>\n<li><p>\"MlsSystemAccess\" comes from the Flexmls \"MLS Status\" field. Whether or not this is surfaced in Flexmls is determined by an MLS preference, and not all MLSs use this field. It's enabled when there is a need to allow both MLS-level users <em>and</em> association-level users to turn on or off member access.</p>\n</li>\n</ul>\n</li>\n<li><p>\"FbsBillable\" should usually be set to true for all non-test accounts</p>\n</li>\n<li><p>FbsBillable will default to false if it's not provided</p>\n</li>\n<li><p>If you provide a null value for \"FbsBillable\" that will be interpreted as a false value:</p>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Settings\": {\n            \"FbsBillable\": null\n        }\n    }\n}\n\n</code></pre>\n<ul>\n<li>BrokerLoad: documentation on BrokerLoad and the possible \"Level\" values can be found <a href=\"https://sparkplatform.com/docs/api_services/my_account#brokerload\">here</a>. For general use, you will only need to set the \"BrokerLoad\".\"Level\" field. This must be wrapped in a \"Settings\" object:</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Settings\": {\n            \"Brokerload\": {\n                \"Level\": \"Office\"\n            }\n        }\n    }\n\n</code></pre>\n<ul>\n<li><p>Visible will default to true if it's not provided at all, e.g. for a new account.</p>\n<ul>\n<li>You'll get a 500 error if you try to POST or PUT a null value for Visible:</li>\n</ul>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Settings\": {\n            \"Visible\": null\n        }\n    }\n}\n\n</code></pre>\n<p><strong>Associations</strong></p>\n<p>While most members belong to a single association, members can belong to multiple ones. Basic association data is returned as a matter of course with account data, but for additional association information, including which association is the primary one for a given account, include an \"_expand=Association\" parameter with your request:</p>\n<p>GET <code>https://replication.sparkapi.com/v1/accounts/20190826160135933324000000?_expand=Associations​</code></p>\n<p>Portion of response:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">\"Associations\": [\n    {\n        \"Id\": \"20160202165906972207000000\",\n        \"Name\": \"Fargo Association of Realtors\",\n        \"AssociationId\": \"FG1\",\n        \"Primary\": true\n    }\n]\n\n</code></pre>\n<ul>\n<li><p>A full list of the associations set up in an MLS is available from the <a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_meta\">/accounts/meta</a> service.</p>\n</li>\n<li><p>Only one association at a time can be designated as primary (include \"Primary\": true with the record). If an association is entered and it's the only one, it will default to primary.</p>\n</li>\n<li><p>When adding a new association to an account, you <strong>must</strong> send in all existing associations as part of your PUT request body data. PUTing a single new association in will erase all other existing association records.</p>\n</li>\n<li><p>Updates to associations use the association \"Name\" rather than \"Id\" or \"AssociationId\".</p>\n</li>\n</ul>\n<p>Example POST/PUT data:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Associations\": {\n            \"Name\": \"Mid Carolina Regional MLS\",\n            \"Primary\": true\n        }\n    }\n}\n\n</code></pre>\n<p><strong>Misc</strong></p>\n<p>There are some fields that we allow writes to only when initially creating a new account. If you attempt to updates these fields for existing accounts, the update will either fail, or else the update will appear to work but the data will be overwritten very soon afterwards with the old data from Flexmls. Here are the some of the more important of these fields (may not be exhaustive):</p>\n<ul>\n<li><p>LoginName: can be set for new account but not updated; if a PUT change succeeds, it'll revert back</p>\n</li>\n<li><p>ShortId: can be set for new account but not updated; if a PUT change succeeds, it'll revert back. <strong>Note: the Spark API currently accepts a null ShortId value, but you should</strong> <em><strong>always</strong></em> <strong>provide a ShortId when creating a new account.</strong></p>\n</li>\n<li><p>UserType: Member, Office, or Mls</p>\n</li>\n<li><p>UserLevel: Member, Office, Mls, Company, Association</p>\n</li>\n<li><p>MlsId: this is the system key for the entire MLS system; there's no reason to ever change this</p>\n</li>\n</ul>\n<p><strong>Designating an agent or broker to an office</strong></p>\n<p>It is essential for the agent/broker account to be a member of the office before assigning them as the Designated Agent/Broker. Failure to do so will result in the following error message:</p>\n<p><code>\"Validation failed: OwnerId cannot be designated as an owner of this office.\"</code></p>\n<p>Once you have ensured the account is a member of the office, you need to include the <strong>OwnerId</strong> attribute within your request. The OwnerId needs to contain the designated agent/broker ID as it's value. Additionally, the OwnerId attribute has to be nested under the <strong>Settings</strong> attribute in order to set the designated agent/broker.</p>\n<p>PUT request containing the office ID: <code>https://replication.sparkapi.com/v1/accounts/20220622174123733666000000</code></p>\n<p><a href=\"https://replication.sparkapi.com/v1/accounts/20220622174123733666000000%3C/p\"></a></p>\n<p>Request Body with OwnerId belonging to the designated agent/broker:</p>\n\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Name\": \"Dunder Mifflin Office\",\n        \"Settings\": {\n            \"OwnerId\": \"20220622174311096119000000\"\n            }\n    }\n}\n\n</code></pre>\n<p><strong>Designating a child office to a company office</strong></p>\n<p>To designate an office as a child office, you must include the OfficeId and CompanyId of the intended company office within the JSON body.</p>\n<p><em>Include the tech ID for the child office account</em></p>\n<p><code>https://replication.sparkapi.com/v1/accounts/20241007164529498076000000</code></p>\n<p>**JSON Body  </p>\n<p>**<em>Include the company office tech ID for the OfficeId and CompanyId fields</em></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Name\": \"Dunder Mifflin Child Office\",\n        \"UserType\": \"Office\",\n        \"OfficeId\":\"20241007164529498076000000\",\n        \"CompanyId\": \"20220622174123733666000000\"\n    }\n}\n\n</code></pre>\n<p><strong>Designating an agent or broker to multiple offices</strong></p>\n<p>A designated agent/broker can be added to multiple child offices by including the \"OwnerId\" field within \"Settings\".  </p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"Name\": \"Dunder Mifflin Child Office\",\n        \"UserType\": \"Office\",\n        \"OfficeId\": \"20241007164529498076000000\",\n        \"CompanyId\": \"20220622174123733666000000\",\n        \"Settings\": {\n            \"OwnerId\": \"20220622174311096119000000\"\n        }\n    }\n}\n\n</code></pre>\n<p><b>Reassign members to a new office</b></p>\n\n<p>The Spark API supports assigning members to a new office. Previously, that was an operation that could only be done in Flexmls. Here's an example of what that looks like:</p>\n\n<p>PUT <code>https://replication.sparkapi.com/v1/accounts/20190826160135933324000000</code></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"D\": {\n        \"OfficeId\": \"20090501160142129962000000\"\n    }\n}\n\n</code></pre>\n<p>Assigning a member account to a new office actually creates a brand new copy of the member's account - in the old office, inactive, not in lists, and with barebones data - then the agent's old listings are assigned to it.</p>\n<p><strong>Teams</strong></p>\n<p>The \"Team\" hash isn't modifiable via the API, though you can get data back about teams via the Spark API. Assigning team members to team accounts and changing team leaders isn't possible via the API, and those functions, as well as designating an account a team account, need to be done via Flexmls. You can create the team account as a regular account via the API, but the last step - adding the option to the account to turn it into a team account - must be done in Flexmls.</p>\n<p>There's an explanation of the fields in the \"Team\" hash in the <a href=\"http://sparkplatform.com/docs/api_services/my_account#expansions\">expansions section</a> of the <a href=\"http://sparkplatform.com/docs/api_services/my_account\">accounts</a> service docs. Here are the two accounts sub-services relating to teams:</p>\n<ul>\n<li><p><a href=\"http://sparkplatform.com/docs/api_services/my_account#teams\">All Teams</a></p>\n</li>\n<li><p><a href=\"http://sparkplatform.com/docs/api_services/my_account#team\">Accounts on a Team</a></p>\n</li>\n</ul>\n<p>Teams are just a special kind of member account (member, not office). You can get the \"Team\" hash back for any account by including \"_expand=Team\" with your request. Be aware, though, that the team expansion can only be used when accessing a single listing directly with a 26-digit ID, e.g.:</p>\n<p>GET <a href=\"https://replication.sparkapi.com/v1/accounts/20210217235023409805000000\">https://replication.sparkapi.com/v1/accounts/20210217235023409805000000</a></p>\n<p>The \"Team\" expansion can't be used with filtered accounts searches, e.g.:</p>\n<p>GET <a href=\"https://replication.sparkapi.com/v1/accounts?_filter=UserType\">https://replication.sparkapi.com/v1/accounts?_filter=UserType</a> eq 'Member' and LoginName eq 'sdaveni'&amp;_expand=Team</p>\n<p>Team accounts will have their \"Team\".\"Owner\" field set to true. This is not to be confused with the \"Team\".\"LeaderId\" field, which lists the ID of the user who leads the team. The team and the team leader are two separate accounts. Here's an example of the \"Team\" hash:</p>\n<p>GET <a href=\"https://replication.sparkapi.com/v1/accounts/20210217235023409805000000?_expand=Team\">https://replication.sparkapi.com/v1/accounts/20210217235023409805000000?_expand=Team</a></p>\n<p>Part of response:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">\"Team\": {\n    \"Id\": \"20210217235023409805000000\",\n    \"ResourceUri\": \"/v1/accounts/teams/20210217235023409805000000\",\n    \"Owner\": true,\n    \"LeaderId\": \"20190826160135933324000000\"\n},\n\n</code></pre>\n","_postman_id":"228465af-81e8-4449-9937-5f94bf606e04"},{"name":"Get Listings","item":[{"name":"All Listings","id":"d27a64b4-6972-4fae-9ac0-7a47022a5875","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings","urlObject":{"protocol":"https","path":["v1","listings"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"e1bc5c0d-d549-446a-b87b-bc196dfb84ae","name":"Filter Multiple Field Values","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_filter=ListingId eq ('Insert_ListingId','Insert_ListingId')&_select=ListingId","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_filter","value":"ListingId eq ('Insert_ListingId','Insert_ListingId')"},{"key":"_select","value":"ListingId"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"55d59a35-7e01-4545-b344-e6148fd0ec2f","name":"Expand Custom Fields","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?&_expand=CustomFields&_limit=1","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":null,"value":null},{"key":"_expand","value":"CustomFields"},{"key":"_limit","value":"1"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c3d71f49-7235-41f3-9cf1-01392b93ab83","name":"Filter Timestamps","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_filter=ModificationTimestamp gt 2018-11-07T16:53:43Z&_select=ModificationTimestamp","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_filter","value":"ModificationTimestamp gt 2018-11-07T16:53:43Z"},{"key":"_select","value":"ModificationTimestamp"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"59e92e1f-e5b5-43ac-9abd-315c6a127972","name":"Expand Rooms","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_filter=ListingId eq 'Insert_ListingId'&_expand=Rooms&_select=\"Rooms\",ListingId","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_filter","value":"ListingId eq 'Insert_ListingId'"},{"key":"_expand","value":"Rooms"},{"key":"_select","value":"\"Rooms\",ListingId"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6808d36a-2507-440f-84ed-c752fa547a4c","name":"MLSs that share data","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_filter=(ListingId eq '<Insert_ListingId_from_one_MLS>') and (MlsId eq 'Insert MlsId from data sharing MLS')&_select=ListingId","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_filter","value":"(ListingId eq '<Insert_ListingId_from_one_MLS>') and (MlsId eq 'Insert MlsId from data sharing MLS')"},{"key":"_select","value":"ListingId"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b061934d-18cf-4d0a-bd50-de323dfd9939","name":"Pagination and Pages","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_pagination=1&_page=2","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_pagination","value":"1"},{"key":"_page","value":"2"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"0f7e85ad-ffbf-419a-918e-18ec18082af9","name":"Filter CustomFields","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_expand=CustomFields&_select=\"General Property Info\".\"Sub-Type\"&_filter=\"General Property Info\".\"Sub-Type\" eq 'Detached Single Family'","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_expand","value":"CustomFields"},{"key":"_select","value":"\"General Property Info\".\"Sub-Type\""},{"key":"_filter","value":"\"General Property Info\".\"Sub-Type\" eq 'Detached Single Family'"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2b249f31-2851-455d-aafa-0717a8390b0a","name":"Filter contains","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_select=UnparsedAddress&_filter=UnparsedAddress Eq contains('City_Name, FL 12345')","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_select","value":"UnparsedAddress"},{"key":"_filter","value":"UnparsedAddress Eq contains('City_Name, FL 12345')"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d27a64b4-6972-4fae-9ac0-7a47022a5875"},{"name":"Listing Documents","id":"8cd153b9-0a7a-49ab-816d-0bcb925f0609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/<Insert_ListingKey>/documents","description":"<p>The Listing Documents service allows management and retrieval for listing documents.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/listing_documents\">http://sparkplatform.com/docs/api_services/listings/listing_documents</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","<Insert_ListingKey>","documents"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cd153b9-0a7a-49ab-816d-0bcb925f0609"},{"name":"Listing History","id":"22c5f83c-f8eb-4df8-86b8-15b0ae562831","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/<Insert_ListingKey>/history","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/listings/history\">http://sparkplatform.com/docs/api_services/listings/history</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","<Insert_ListingKey>","history"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"22c5f83c-f8eb-4df8-86b8-15b0ae562831"},{"name":"Listing Photos","id":"0aa74439-e073-4b23-927e-b28d623d462b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/<Insert_ListingKey>/photos","description":"<p>The Listing Photos service returns data about listing photos for a specific listing to be retrieved. URIs to various photo sizes are returned rather than image files.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/photos\">http://sparkplatform.com/docs/api_services/listings/photos</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","<Insert_ListingKey>","photos"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"6f8dda8d-1847-4948-bb6a-ecc55e71ced1","name":"Bulk Listing Photos","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_expand=Photos&_select=ListingId,Photos","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_expand","value":"Photos"},{"key":"_select","value":"ListingId,Photos"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0aa74439-e073-4b23-927e-b28d623d462b"},{"name":"Listing Videos","id":"bbba058c-5a1c-400b-b00d-22455abfe51d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/<Insert_ListingKey>/videos","description":"<p>The Listing Videos sub-service retrieval of URIs to videos associated with a specified listing.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/videos\">http://sparkplatform.com/docs/api_services/listings/videos</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","<Insert_ListingKey>","videos"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"0e6c4c90-44a4-4cdf-8e9e-b48735aed18a","name":"Bulk Listing Photos","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_expand=Photos&_select=ListingId,Photos","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_expand","value":"Photos"},{"key":"_select","value":"ListingId,Photos"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bbba058c-5a1c-400b-b00d-22455abfe51d"},{"name":"MLS Datashare Listings","id":"7fe48a00-97ec-45a6-9ead-ff0998c67a00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings?_filter=MlsId eq '<Insert_MlsId>'","description":"<p>If you are subscribed to an MLS that participates in a datashare, this query allows you to retrieve listings from that datashare.</p>\n<p>You can pull a list of MlsId values by using the following query - <a href=\"https://replication.sparkapi.com/v1/standardfields/MlsId\">https://replication.sparkapi.com/v1/standardfields/MlsId</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings"],"host":["replication","sparkapi","com"],"query":[{"key":"_filter","value":"MlsId eq '<Insert_MlsId>'"}],"variable":[]}},"response":[],"_postman_id":"7fe48a00-97ec-45a6-9ead-ff0998c67a00"},{"name":"Virtual Tours","id":"93611e65-b846-4c5f-af56-711949cae832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/Insert_ListingKey/virtualtours?","description":"<p>The Virtual Tours sub-service retrieval of URIs to virtual tours associated with a specified listing.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/virtual_tours\">http://sparkplatform.com/docs/api_services/listings/virtual_tours</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","Insert_ListingKey","virtualtours"],"host":["replication","sparkapi","com"],"query":[{"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"93611e65-b846-4c5f-af56-711949cae832"}],"id":"c72a062f-5699-4fc0-8ba2-8e723be14195","description":"<h5 id=\"the-listings-api-is-used-to-retrieve-listing-information-enter-new-listings-and-updating-existing-listing-data-and-run-searches-on-listings\">The Listings API is used to retrieve listing information, enter new listings and updating existing listing data, and run searches on listings.</h5>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings\">http://sparkplatform.com/docs/api_services/listings</a></p>\n","_postman_id":"c72a062f-5699-4fc0-8ba2-8e723be14195"},{"name":"Incomplete Listings","item":[{"name":"All Incomplete Listings","id":"7e803b5f-f794-4a6c-9eff-67378ac327bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/incomplete","urlObject":{"protocol":"https","path":["v1","listings","incomplete"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e803b5f-f794-4a6c-9eff-67378ac327bb"}],"id":"f18a9c9c-c7d7-4b48-bf44-ee06f57a002e","description":"<h4 id=\"incomplete-listings-are-drafts-of-listings-not-yet-entered-into-the-system\">Incomplete listings are drafts of listings not yet entered into the system.</h4>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/incomplete\">http://sparkplatform.com/docs/api_services/listings/incomplete</a></p>\n","_postman_id":"f18a9c9c-c7d7-4b48-bf44-ee06f57a002e"},{"name":"Get Metadata","item":[{"name":"Accounts Metadata","id":"ad9aa561-df31-433c-877a-cadb751a1e41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/accounts/meta","description":"<p>The Accounts Metadata service describes the allowable values for searching and updating various account and profile fields, often varying by MLS. Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/my_account/accounts_meta\">http://sparkplatform.com/docs/api_services/my_account/accounts_meta</a></p>\n","urlObject":{"protocol":"https","path":["v1","accounts","meta"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad9aa561-df31-433c-877a-cadb751a1e41"},{"name":"Photos Metadata","id":"e6019586-0d10-4a56-9d53-1669c0f90dfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/photos/meta","description":"<p>The Photos Metadata service describes the defined <code>Tags</code> and <code>Privacy</code> values for <a href=\"http://sparkplatform.com/docs/api_services/listings/photos\">listing photos</a>.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/photos_meta\">http://sparkplatform.com/docs/api_services/listings/photos_meta</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","photos","meta"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6019586-0d10-4a56-9d53-1669c0f90dfb"},{"name":"Videos Metadata","id":"67a39aab-d062-4f3f-ac7b-ec78338cc919","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/videos/meta","description":"<p>The Videos Metadata service describes the defined <code>Privacy</code> values for <a href=\"http://sparkplatform.com/docs/api_services/listings/videos\">listing videos</a>.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/videos_meta\">http://sparkplatform.com/docs/api_services/listings/videos_meta</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","videos","meta"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"67a39aab-d062-4f3f-ac7b-ec78338cc919"},{"name":"Virtual Tours Metadata","id":"7e456715-50a6-41da-a8d0-5859330b6508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/virtualtours/meta","description":"<p>The Videos Metadata service describes the defined <code>Privacy</code> values for <a href=\"http://sparkplatform.com/docs/api_services/listings/videos\">listing videos</a>.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/videos_meta\">http://sparkplatform.com/docs/api_services/listings/videos_meta</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","virtualtours","meta"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e456715-50a6-41da-a8d0-5859330b6508"},{"name":"Documents Metadata","id":"8a2e8782-3dba-4a07-8e1b-67bd9e385bb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/documents/meta","description":"<p>The Documents Metadata service describes the allowable values for <a href=\"http://sparkplatform.com/docs/api_services/listings/listing_documents\">listing documents</a>, which varies by MLS.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/documents_meta\">http://sparkplatform.com/docs/api_services/listings/documents_meta</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","documents","meta"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a2e8782-3dba-4a07-8e1b-67bd9e385bb0"},{"name":"Custom Fields","id":"fdc0ff06-5804-4edb-981f-b05638be9fe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/customfields","description":"<p>The Custom Fields API allows retrieval of grouped lists of supported custom fields.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/custom_fields\">http://sparkplatform.com/docs/api_services/custom_fields</a></p>\n","urlObject":{"protocol":"https","path":["v1","customfields"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fdc0ff06-5804-4edb-981f-b05638be9fe3"},{"name":"Custom Field Groups","id":"d484c09f-48b1-46f3-834f-1a19125af9d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/customfields/groups","description":"<p>Displays groups of supported custom fields.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/custom_fields/groups\">http://sparkplatform.com/docs/api_services/custom_fields/groups</a></p>\n","urlObject":{"protocol":"https","path":["v1","customfields","groups"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d484c09f-48b1-46f3-834f-1a19125af9d3"},{"name":"Property Type Labels","id":"3fa9cc8d-f7b5-4cf6-8fbd-4f475e74d832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/standardfields/PropertyTypeLabel","description":"<p>The Property Types service returns a list of possible listing property types for the current user’s MLS.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/standard_fields\">http://sparkplatform.com/docs/api_services/standard_fields</a></p>\n","urlObject":{"protocol":"https","path":["v1","standardfields","PropertyTypeLabel"],"host":["replication","sparkapi","com"],"query":[{"disabled":true,"key":"ApiUser","value":""}],"variable":[]}},"response":[],"_postman_id":"3fa9cc8d-f7b5-4cf6-8fbd-4f475e74d832"},{"name":"Get MLS Standard Fields","id":"80174a67-f047-413c-9386-21ed64d9f579","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/mls/<Insert_MlsId>/standardfields","description":"<p>The Standard Fields API allows retrieval of a list of supported standard fields and list items. Of special note is the <code>MlsId</code> field, which informs which other MLSs the current user may search.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/standard_fields\">http://sparkplatform.com/docs/api_services/standard_fields</a></p>\n","urlObject":{"protocol":"https","path":["v1","mls","<Insert_MlsId>","standardfields"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"80174a67-f047-413c-9386-21ed64d9f579"},{"name":"Flexmls: Listing Field List Meta Translations","id":"9c41fe85-715e-4baf-a851-e3e5d38ebad7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/flexmls/propertytypes/<PropertyType.MlsCode>/fields/fieldslists/translation","description":"<p>This service provides a dictionary that translates the <code>FieldList.Value</code> for <a href=\"http://sparkplatform.com/docs/api_services/standard_fields\">standard</a> and <a href=\"http://sparkplatform.com/docs/api_services/custom_fields\">custom fields</a> to their corresponding values in Flexmls Web.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/flexmls/listing_meta_translations\">http://sparkplatform.com/docs/api_services/flexmls/listing_meta_translations</a></p>\n","urlObject":{"protocol":"https","path":["v1","flexmls","propertytypes","<PropertyType.MlsCode>","fields","fieldslists","translation"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c41fe85-715e-4baf-a851-e3e5d38ebad7"},{"name":"Flexmls: Listing Meta Origins","id":"966d480f-fa44-47ea-a61c-6eac63360b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/flexmls/propertytypes/<PropertyType.MlsCode>/origins","description":"<p>This service exposes the relationship between <a href=\"http://sparkplatform.com/docs/api_services/standard_fields\">standard</a> and <a href=\"http://sparkplatform.com/docs/api_services/custom_fields\">custom</a> fields, specifically which custom fields a standard field is composed of, and which standard fields a custom field contributes to. It is important to distinguish this service from <a href=\"http://sparkplatform.com/docs/api_services/flexmls/listing_meta_translations\">translations</a> which includes only fields that directly translate in a one-to-one fashion and does not account for fields derived from many source fields.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/flexmls/listing_meta_translations\">http://sparkplatform.com/docs/api_services/flexmls/listing_meta_translations</a></p>\n","urlObject":{"protocol":"https","path":["v1","flexmls","propertytypes","<PropertyType.MlsCode>","origins"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"966d480f-fa44-47ea-a61c-6eac63360b2e"},{"name":"Flexmls: Listing Meta Translations","id":"2e25cf9d-9069-4215-adf1-5741b7b87f28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/flexmls/propertytypes/<PropertyType.MlsCode>/translations","description":"<p>This service provides a dictionary that translates <a href=\"http://sparkplatform.com/docs/api_services/standard_fields\">standard</a> and <a href=\"http://sparkplatform.com/docs/api_services/custom_fields\">custom fields</a> to their corresponding field data used by Flexmls Web.</p>\n<p>Please note, this query does not display actual listing data.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/flexmls/listing_meta_translations\">http://sparkplatform.com/docs/api_services/flexmls/listing_meta_translations</a></p>\n","urlObject":{"protocol":"https","path":["v1","flexmls","propertytypes","<PropertyType.MlsCode>","translations"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"043562d2-d0fa-4deb-8e7c-d06b85dc5c28","name":"Flexmls: Listing Meta Translations","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/flexmls/propertytypes/A/translations"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2e25cf9d-9069-4215-adf1-5741b7b87f28"},{"name":"Get MLS Data Share","id":"c3f13606-9b14-4618-b04a-37da14d7eca0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/standardfields/MlsId","description":"<p>This query will allow you to pull a list of MlsIds belonging to the MLSs that are allowed to pull listings from the MLS that participates in datashare.\"</p>\n<p>Please note, this query does not display actual listing data.</p>\n","urlObject":{"protocol":"https","path":["v1","standardfields","MlsId"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"871587a1-fa38-4112-9e75-4f5189be9cff","name":"Pull MLS Datashare Listings","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/listings?_filter=MlsId eq '<Insert_MlsId>'","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","listings"],"query":[{"key":"_filter","value":"MlsId eq '<Insert_MlsId>'"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c3f13606-9b14-4618-b04a-37da14d7eca0"}],"id":"f7c58300-cd1e-489a-a700-78dc7b36cb44","description":"<h5 id=\"a-list-of-different-queries-to-display-metadata-these-queries-do-not-display-actual-listing-data\">A list of different queries to display metadata. These queries do not display actual listing data.</h5>\n","_postman_id":"f7c58300-cd1e-489a-a700-78dc7b36cb44"},{"name":"Get Standard Fields","item":[{"name":"All Standard Fields","id":"6744dcc5-1525-40b9-933c-afd474cfacf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/standardfields","description":"<p>This query will pull all of the standard fields for the MLS your API key is subscribed to.</p>\n<p>This is not to be confused with <code>https://replication.sparkapi.com/v1/mls//standardfields</code> which pulls all of the standard fields MLSs that participate in datashare with the MLS your API key is subscribed to.</p>\n<p>EndFragment</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/standard_fields\">http://sparkplatform.com/docs/api_services/standard_fields</a></p>\n","urlObject":{"protocol":"https","path":["v1","standardfields"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"88a6c217-70fc-4b40-93c3-64071a6496c1","name":"FieldList Values","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/standardfields/<Insert_Standard Field>/FieldList"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6744dcc5-1525-40b9-933c-afd474cfacf6"},{"name":"MLS Datashare Standard Fields","id":"a731e464-d7fc-47ea-997a-74a0afe00697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/mls/<Insert_MlsId>/standardfields ","description":"<p>This query will pull all of the standard fields for the MLS that participates in datashare with the MLS your API key is subscribed to.</p>\n<p>This is not to be confused with <code>https://replication.sparkapi.com/v1/standardfields</code> which will pull all of the standard fields only for the MLS your API key is subscribed to.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/standard_fields\">http://sparkplatform.com/docs/api_services/standard_fields</a></p>\n","urlObject":{"protocol":"https","path":["v1","mls","<Insert_MlsId>","standardfields "],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"9f833c11-555b-4794-bc24-89bc8138feba","name":"FieldList Values","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/standardfields/<Insert_Standard Field>/FieldList"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a731e464-d7fc-47ea-997a-74a0afe00697"}],"id":"a71a0cc8-671a-4c37-9775-96112fc895b2","description":"<h5 id=\"the-standard-fields-api-allows-retrieval-of-a-list-of-supported-standard-fields-and-list-items-of-special-note-is-the-mlsid-field-which-informs-which-other-mlss-the-current-user-may-search\">The Standard Fields API allows retrieval of a list of supported standard fields and list items. Of special note is the <code>MlsId</code> field, which informs which other MLSs the current user may search.</h5>\n","_postman_id":"a71a0cc8-671a-4c37-9775-96112fc895b2"},{"name":"Get Open Houses","item":[{"name":"All Open Houses","id":"58f2bb80-0b51-4c36-8acb-865b521f8686","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/openhouses","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/listings/open_houses\">http://sparkplatform.com/docs/api_services/listings/open_houses</a></p>\n","urlObject":{"protocol":"https","path":["v1","openhouses"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"3c224922-e7f6-449b-b938-f3dad1536e75","name":"Individual Open House Event","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/openhouses/<Insert_OpenHouse.Id>"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0ca3a4a6-1071-4665-a57d-084b6e81ffb8","name":"Open Houses by Listing","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/<Insert_ListingKey>/openhouses/all"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5fe885fc-e226-4d40-8b27-0b58819ebe42","name":"Open House by listing & Id","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/<Insert_ListingKey>/openhouses/<OpenHouse.Id>"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"58f2bb80-0b51-4c36-8acb-865b521f8686"}],"id":"94fd2e4d-567b-4c8b-bddd-7985197d290c","description":"<h5 id=\"the-open-houses-sub-resource-returns-data-about-upcoming-open-houses-scheduled-for-a-listing\">The Open Houses sub-resource returns data about upcoming open houses scheduled for a listing.</h5>\n","_postman_id":"94fd2e4d-567b-4c8b-bddd-7985197d290c"},{"name":"Advanced Use","item":[{"name":"Newsfeeds","item":[{"name":"Developers: News Feed Webhooks","id":"13385c23-e43d-4dda-8c45-5d564995f13e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/developers/newsfeeds/webhooks","description":"<p>When creating <a href=\"http://sparkplatform.com/docs/api_services/newsfeed\">news feeds</a>, developers can register webhooks to receive POST requests for <a href=\"http://sparkplatform.com/docs/api_services/newsfeed/schedule\">event notifications</a> in place of the typical e-mail or <a href=\"http://sparkplatform.com/docs/api_services/devices\">device</a> push notification.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/developers/newsfeed_webhooks\">http://sparkplatform.com/docs/api_services/developers/newsfeed_webhooks</a></p>\n","urlObject":{"protocol":"https","path":["v1","developers","newsfeeds","webhooks"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"13385c23-e43d-4dda-8c45-5d564995f13e"},{"name":"Newsfeeds","id":"a973c3f4-beda-45de-ac3a-64789d4af70e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<p>A news feed is a subscription to a data point or actions of interest, such as the results of a <a href=\"http://sparkplatform.com/docs/api_services/saved_searches\">saved search</a>. These subscriptions generate <a href=\"http://sparkplatform.com/docs/api_services/newsfeed/events\">news feed events</a>.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/newsfeed\">http://sparkplatform.com/docs/api_services/newsfeed</a></p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"a973c3f4-beda-45de-ac3a-64789d4af70e"}],"id":"bc80fb5e-b9e3-4570-a522-44e19944929f","_postman_id":"bc80fb5e-b9e3-4570-a522-44e19944929f","description":""},{"name":"Contacts","item":[{"name":"All Contacts","id":"2904cb63-2e06-4832-8f43-dc45ca7b4d89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/contacts","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/contacts\">http://sparkplatform.com/docs/api_services/contacts</a></p>\n","urlObject":{"protocol":"https","path":["v1","contacts"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2904cb63-2e06-4832-8f43-dc45ca7b4d89"},{"name":"Contacts: Activity","id":"07c2cce8-c6de-4f41-9394-c5e4fcab896a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/contacts/<Contact.Id>/activity","description":"<p>This service summarizes various contact activity data points, such as the number of emails sent to and opened by the contact.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/contacts/activity\">http://sparkplatform.com/docs/api_services/contacts/activity</a></p>\n","urlObject":{"protocol":"https","path":["v1","contacts","<Contact.Id>","activity"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"07c2cce8-c6de-4f41-9394-c5e4fcab896a"},{"name":"Contacts: Export","id":"34688692-e5f8-46f9-bfe0-c2f225226a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/contacts/export/all","description":"<p>The export sub-service allows a set of all contacts under control of the current account to be exported based on the time the resources were last modified.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/contacts/export\">http://sparkplatform.com/docs/api_services/contacts/export</a></p>\n","urlObject":{"protocol":"https","path":["v1","contacts","export","all"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"34688692-e5f8-46f9-bfe0-c2f225226a5a"},{"name":"Contact Tags","id":"2c856cf1-3887-430b-a516-058e24f21e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/contacts/tags","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/contacts/tags\">http://sparkplatform.com/docs/api_services/contacts/tags</a></p>\n","urlObject":{"protocol":"https","path":["v1","contacts","tags"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c856cf1-3887-430b-a516-058e24f21e3c"},{"name":"Contacts: Portal/VOW Accounts","id":"9fce4b5f-1171-48db-93b1-f98d3f0ce091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/contacts/<Contact.Id>/portal","description":"<p>The Portal account sub-service provides access to consumer account information. These accounts are automatically created when a contact is created or edited, but older contacts may not yet have a corresponding consumer account.<br /><a href=\"http://sparkplatform.com/docs/api_services/contacts/vow\">http://sparkplatform.com/docs/api_services/contacts/vow</a></p>\n","urlObject":{"protocol":"https","path":["v1","contacts","<Contact.Id>","portal"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9fce4b5f-1171-48db-93b1-f98d3f0ce091"}],"id":"71863959-5bc6-497f-b36e-adf89bfd2037","_postman_id":"71863959-5bc6-497f-b36e-adf89bfd2037","description":""},{"name":"Map / Geo Related","item":[{"name":"Overlays","id":"85a0aab4-82ef-4cb4-9e49-05c75f07763d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/overlays","description":"<p>The Overlays service returns Overlays, which are collections of <a href=\"http://sparkplatform.com/docs/api_services/overlays/shapes\">Shapes</a>, for use in searching and display.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/overlays\">http://sparkplatform.com/docs/api_services/overlays</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","overlays"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"85a0aab4-82ef-4cb4-9e49-05c75f07763d"},{"name":"Overlays: Shapes","id":"52cec435-99fe-43f2-873b-efaeb87ab256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/overlays/shapes","description":"<p>The Overlays: Shapes service returns Shapes that are present in <a href=\"http://sparkplatform.com/docs/api_services/overlays\">Overlays</a>.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/overlays/shapes\">http://sparkplatform.com/docs/api_services/overlays/shapes</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","overlays","shapes"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"52cec435-99fe-43f2-873b-efaeb87ab256"},{"name":"Listings Clusters","id":"bbd11fdf-ee96-4ff8-8c06-30f4cd0bca1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/clusters","description":"<p>Allows retrieval of clustered listings as bounded to a given location. A typical use case for this service is to retrieve clusters for a given location and map them. At that point, a user could drill down into a given cluster using a <a href=\"http://sparkplatform.com/docs/examples/location_searches_using_polygons\">location search</a> returning the listings that comprised the cluster.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/clusters\">http://sparkplatform.com/docs/api_services/listings/clusters</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","clusters"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbd11fdf-ee96-4ff8-8c06-30f4cd0bca1e"},{"name":"Flexmls: Mapping: Layers","id":"c9213320-7d49-4e8b-99db-fc9f6604e9ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/flexmls/mapping/layers","description":"<p>The Flexmls: Mapping: Layers service provides the tile layers available on the flexmls map server.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/flexmls/mapping/layers\">http://sparkplatform.com/docs/api_services/flexmls/mapping/layers</a></p>\n","urlObject":{"protocol":"https","path":["v1","flexmls","mapping","layers"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9213320-7d49-4e8b-99db-fc9f6604e9ed"},{"name":"Flexmls: Mapping: Shapegen","id":"0192272a-521d-4114-a63a-0eb310dbc244","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/flexmls/mapping/shapegen","description":"<p>The Flexmls: Mapping: Shapegen service provides a way for apps that use SparkQL <a href=\"http://sparkplatform.com/docs/api_services/listings\">Listing</a> filters to generate shapefiles via the Shapegen process.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/flexmls/mapping/shapegen\">http://sparkplatform.com/docs/api_services/flexmls/mapping/shapegen</a></p>\n","urlObject":{"protocol":"https","path":["v1","flexmls","mapping","shapegen"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0192272a-521d-4114-a63a-0eb310dbc244"}],"id":"0434197e-d0f3-4bcd-a0a7-a7374f114f1e","description":"<p>Anything involving maps or geolocation.</p>\n","_postman_id":"0434197e-d0f3-4bcd-a0a7-a7374f114f1e"},{"name":"Market Statistics","item":[{"name":"Absorption","id":"38725885-241d-4e5c-9bfb-bf26d800af1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/marketstatistics/absorption","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/market_statistics#MarketStatisticsAPI-common\">Common parameters</a> plus the following:</p>\n<h3 id=\"get-request\">GET Request</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Required</th>\n<th>Expected</th>\n<th>Notes</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Options</code></td>\n<td>No</td>\n<td><br />  <br />Comma-separated string with one or many of the following options:  <br />  <br />- <code>AbsorptionRate</code>  <br />  <br /></td>\n<td>The default if no <code>Options</code> parameter is specified is <code>AbsorptionRate</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["v1","marketstatistics","absorption"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"5162d461-d1c2-4c1f-9fd5-2c2141eb9131","name":"Absorption","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/absorption?Options=AbsorptionRate","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","absorption"],"query":[{"key":"Options","value":"AbsorptionRate"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"0846d3fa-265e-4d96-9ce6-704adf78c01d","name":"Absorption Location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/absorption?Options=AbsorptionRate&LocationField=City&LocationValue=Phoenix","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","absorption"],"query":[{"key":"Options","value":"AbsorptionRate"},{"key":"LocationField","value":"City"},{"key":"LocationValue","value":"Phoenix"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"38725885-241d-4e5c-9bfb-bf26d800af1e"},{"name":"Inventory","id":"48563983-b52c-421a-b8d4-563dda32b1db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/marketstatistics/inventory","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/market_statistics#MarketStatisticsAPI-common\">Common parameters</a> plus the following:</p>\n<h3 id=\"get-request\">GET Request</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Required</th>\n<th>Expected</th>\n<th>Notes</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Options</code></td>\n<td>No</td>\n<td><br />  <br />Comma-separated string with one or many of the following options:  <br />  <br />- <code>ActiveListings</code>  <br />- <code>NewListings</code>  <br />- <code>PendedListings</code>  <br />- <code>SoldListings</code>  <br />  <br /></td>\n<td>The default if no <code>Options</code> parameter is specified is <code>ActiveListings,NewListings</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["v1","marketstatistics","inventory"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"684f1307-6b33-46a6-9a8c-2e14ee0aa02c","name":"Inventory","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/marketstatistics/inventory&Options=ActiveListings"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"d358a776-c4b8-4a28-af2f-517d2b98c391","name":"Inventory Location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/inventory?Options=ActiveListings&LocationField=City&LocationValue=Phoenix","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","inventory"],"query":[{"key":"Options","value":"ActiveListings"},{"key":"LocationField","value":"City"},{"key":"LocationValue","value":"Phoenix"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"48563983-b52c-421a-b8d4-563dda32b1db"},{"name":"Price","id":"06bf683a-43aa-4728-8d6d-6741d8393ee8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/marketstatistics/price","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/market_statistics#MarketStatisticsAPI-common\">Common parameters</a> plus the following:</p>\n<h3 id=\"get-request\">GET Request</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Required</th>\n<th>Expected</th>\n<th>Notes</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Options</code></td>\n<td>No</td>\n<td><br />  <br />Comma-separated string with one or many of the following options:  <br />  <br />- <code>ActiveAverageListPrice</code>  <br />- <code>NewAverageListPrice</code>  <br />- <code>PendedAverageListPrice</code>  <br />- <code>SoldAverageListPrice</code>  <br />- <code>SoldAverageSoldPrice</code>  <br />- <code>ActiveMedianListPrice</code>  <br />- <code>NewMedianListPrice</code>  <br />- <code>PendedMedianListPrice</code>  <br />- <code>SoldMedianListPrice</code>  <br />- <code>SoldMedianSoldPrice</code>  <br />  <br /></td>\n<td>The default if no <code>Options</code> parameter is specified is <code>ActiveAverageListPrice, ActiveMedianListPrice, NewAverageListPrice, NewMedianListPrice</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["v1","marketstatistics","price"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"236c33fd-5208-4e64-bbd0-a34ae4a899c4","name":"Price","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/price?Options=ActiveAverageListPrice","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","price"],"query":[{"key":"Options","value":"ActiveAverageListPrice"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"601dbd9a-8710-42f7-891f-ac804e680205","name":"Price Location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/price?Options=ActiveAverageListPrice&LocationField=City&LocationValue=Phoenix","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","price"],"query":[{"key":"Options","value":"ActiveAverageListPrice"},{"key":"LocationField","value":"City"},{"key":"LocationValue","value":"Phoenix"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"06bf683a-43aa-4728-8d6d-6741d8393ee8"},{"name":"Ratio","id":"ae920d9a-6e3e-47ff-8800-c03fa375a252","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/marketstatistics/ratio","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/market_statistics#MarketStatisticsAPI-common\">Common parameters</a> plus the following:</p>\n<h3 id=\"get-request\">GET Request</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Required</th>\n<th>Expected</th>\n<th>Notes</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Options</code></td>\n<td>No</td>\n<td><br />  <br />Comma-separated string with one or many of the following options:  <br />  <br />- <code>SaleToOriginalListPriceRatio</code>  <br />- <code>SaleToListPriceRatio</code>  <br />  <br /></td>\n<td>The default if no <code>Options</code> parameter is specified is <code>SaleToOriginalListPriceRatio</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["v1","marketstatistics","ratio"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"5deb379b-2814-48dd-a012-65e9e96ff656","name":"Ratio","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/ratio?Options=SaleToOriginalListPriceRatio","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","ratio"],"query":[{"key":"Options","value":"SaleToOriginalListPriceRatio"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7d0730c1-1cbe-47a9-9e6e-6a53d47938f0","name":"Ratio Location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/ratio?LocationField=City&LocationValue=Phoenix","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","ratio"],"query":[{"key":"LocationField","value":"City"},{"key":"LocationValue","value":"Phoenix"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ae920d9a-6e3e-47ff-8800-c03fa375a252"},{"name":"Days On Market","id":"d080dafb-5b6c-4f5e-a7e5-628575547004","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/marketstatistics/dom","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/market_statistics#MarketStatisticsAPI-common\">Common parameters</a> plus the following:</p>\n<h3 id=\"get-request\">GET Request</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Required</th>\n<th>Expected</th>\n<th>Notes</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Options</code></td>\n<td>No</td>\n<td><br />  <br />Comma-separated string with one or many of the following options:  <br />  <br />- <code>AverageDom</code>  <br />- <code>AverageCdom</code>  <br />  <br /></td>\n<td>The default if no <code>Options</code> parameter is specified is <code>AverageDom</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["v1","marketstatistics","dom"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"16116d5b-c26a-41c5-aab6-4ab77ecf31e6","name":"Days On Market","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/dom?Options=AverageDom","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","dom"],"query":[{"key":"Options","value":"AverageDom"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"1c15574a-e6ed-4b8d-aef6-adf992628282","name":"Days On Market Location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/dom?LocationField=City&LocationValue=Phoenix","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","dom"],"query":[{"key":"LocationField","value":"City"},{"key":"LocationValue","value":"Phoenix"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d080dafb-5b6c-4f5e-a7e5-628575547004"},{"name":"Volume","id":"b520f02b-0fbd-406d-9c45-2943a1adcf1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/marketstatistics/volume","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/market_statistics#MarketStatisticsAPI-common\">Common parameters</a> plus the following:</p>\n<h3 id=\"get-request\">GET Request</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Required</th>\n<th>Expected</th>\n<th>Notes</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Options</code></td>\n<td>No</td>\n<td><br />  <br />Comma-separated string with one or many of the following options:  <br />  <br />- <code>ActiveListVolume</code>  <br />- <code>NewListVolume</code>  <br />- <code>PendedListVolume</code>  <br />- <code>SoldListVolume</code>  <br />- <code>SoldSaleVolume</code>  <br />  <br /></td>\n<td>The default if no <code>Options</code> parameter is specified is <code>ActiveListVolume,NewListVolume</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["v1","marketstatistics","volume"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"64daa490-5b04-4cd2-a5c5-ad45e799fb63","name":"Volume","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/volume?Options=ActiveListVolume","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","volume"],"query":[{"key":"Options","value":"ActiveListVolume"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"5decb603-8104-49b4-90de-18402aca7aa4","name":"Volume Location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/v1/marketstatistics/volume?Options=ActiveListVolume,NewListVolume,SoldSaleVolume&LocationField=City&LocationValue=Phoenix ","protocol":"https","host":["replication","sparkapi","com"],"path":["v1","marketstatistics","volume"],"query":[{"key":"Options","value":"ActiveListVolume,NewListVolume,SoldSaleVolume"},{"key":"LocationField","value":"City"},{"key":"LocationValue","value":"Phoenix "}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b520f02b-0fbd-406d-9c45-2943a1adcf1b"}],"id":"f23aabb9-38b3-4074-9f22-a84d9d789086","description":"<p>The Market Statistics API returns summary listing data about the market in specified geographical locations for display in a table, a graph, or other uses. Note that the data returns date fields, but the day is not significant; the data is actually for the month and year, not the day, month, and year.</p>\n<p>Please note if you want to search by location, both LocationField and LocationValue must be supplied.</p>\n<p>The Options parameter values are determined by the specific market stat you are drilling into.</p>\n<p>There isn't a way to search by date.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/market_statistics\">http://sparkplatform.com/docs/api_services/market_statistics</a></p>\n","_postman_id":"f23aabb9-38b3-4074-9f22-a84d9d789086"},{"name":"Listings: FloPlans","id":"63adc866-9c83-4e64-a118-ba2c33f099ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/listings/<Insert_ListingKey>/floplans","description":"<p>FloPlans are images of the layout, or 'flow', for a listing. Not all MLSs are integrated with this product. Users in an MLS with this feature enabled will have <code>FloPlans</code> present in the <code>Settings.FlexmlsProducts</code> attribute for their <a href=\"http://sparkplatform.com/docs/api_services/my_account\">account</a>. If available, this data will also be available as a <a href=\"http://sparkplatform.com/docs/api_services/listings/floorplans\">floor plan</a>.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listings/floplans\">http://sparkplatform.com/docs/api_services/listings/floplans</a></p>\n","urlObject":{"protocol":"https","path":["v1","listings","<Insert_ListingKey>","floplans"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63adc866-9c83-4e64-a118-ba2c33f099ad"},{"name":"Listing Carts","id":"ee7ccef7-3432-4dc4-9e03-292a13e03642","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/contacts/<Contact.Id>/listingcarts","description":"<p>Listing Carts are a personal collection of listings that can be modified or used as search criteria.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/listing_carts\">http://sparkplatform.com/docs/api_services/listing_carts</a></p>\n","urlObject":{"protocol":"https","path":["v1","contacts","<Contact.Id>","listingcarts"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee7ccef7-3432-4dc4-9e03-292a13e03642"},{"name":"All Saved Searches","id":"190c95ae-536f-4352-a37b-6e7943ee9c2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/v1/savedsearches","description":"<p>The Saved Searches service allows retrieval and management of saved searches for the current user.</p>\n<p><a href=\"http://sparkplatform.com/docs/api_services/saved_searches\">http://sparkplatform.com/docs/api_services/saved_searches</a></p>\n","urlObject":{"protocol":"https","path":["v1","savedsearches"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"190c95ae-536f-4352-a37b-6e7943ee9c2c"}],"id":"2680461c-1bb5-4daa-8420-da6343e4f161","_postman_id":"2680461c-1bb5-4daa-8420-da6343e4f161","description":""}],"id":"f9c4cefe-ee16-4f6c-88b9-7af5f8630d4f","description":"<p><a href=\"http://sparkplatform.com/docs/api_services/read_first\">Spark API Overview Documentation</a></p>\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2826f018-0c01-4909-8d75-03cd80ff1a0a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c2fd495f-edc9-42fc-bbe0-5b01338d7a35"}}],"_postman_id":"f9c4cefe-ee16-4f6c-88b9-7af5f8630d4f"},{"name":"RESO Web API","item":[{"name":"Get Green Verification","item":[{"name":"Green Verification for a property","id":"7d378a95-97dc-48e2-8e09-841807c996ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('Insert_ListingKey')/GreenVerification","urlObject":{"protocol":"https","path":["Reso","OData","Property('Insert_ListingKey')","GreenVerification"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d378a95-97dc-48e2-8e09-841807c996ed"}],"id":"39550174-9ff6-4555-a878-f6b13f80f21d","description":"<h5 id=\"the-green-verification-resource-accesses-green-verification-fields-for-a-given-property-fbs-recommends-utilizing-the-expand-parameter-to-access-these-records-the-subresources-listed-below-should-only-be-used-if-the-expand-parameter-will-not-accommodate-your-use-case\">The Green Verification resource accesses green verification fields for a given <a href=\"http://sparkplatform.com/docs/reso/properties\">Property</a>. FBS recommends utilizing the <a href=\"http://sparkplatform.com/docs/reso/request_parameters#expansion\">$expand</a> parameter to access these records. The subresources listed below should only be used if the $expand parameter will not accommodate your use case.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/green_verification\">http://sparkplatform.com/docs/reso/green_verification</a></p>\n","_postman_id":"39550174-9ff6-4555-a878-f6b13f80f21d"},{"name":"Get Lookup","item":[{"name":"Lookup field values","id":"f9251733-30d4-4920-a882-ff95a47db155","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Lookup","urlObject":{"protocol":"https","path":["Reso","OData","Lookup"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"fd19378c-45d8-410c-8f13-a818b8be94eb","name":"LookupName","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Lookup?$filter=LookupName eq 'MemberType'","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Lookup"],"query":[{"key":"$filter","value":"LookupName eq 'MemberType'"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7769e30f-5606-4108-b833-d0ff4f180701","name":"LookupValue","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Lookup?$filter=LookupValue eq 'Association Staff'","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Lookup"],"query":[{"key":"$filter","value":"LookupValue eq 'Association Staff'"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"348f1573-4999-4682-bce2-dc6fb94ddb9e","name":"LegacyODataValue","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Lookup?$filter=LegacyODataValue eq 'Insert_LegacyODataValue'","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Lookup"],"query":[{"key":"$filter","value":"LegacyODataValue eq 'Insert_LegacyODataValue'"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"354ddc4f-39a7-4f3c-a1c7-b6e52028e429","name":"ModificationTimestamp","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Lookup?$filter=ModificationTimestamp gt '2003-04-01T19:01:02Z'","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Lookup"],"query":[{"key":"$filter","value":"ModificationTimestamp gt '2003-04-01T19:01:02Z'"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"613ec598-a945-47b1-876d-9b51104f81c4","name":"LookupKey","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Lookup?$filter=LookupKey eq 'Insert_Key'","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Lookup"],"query":[{"key":"$filter","value":"LookupKey eq 'Insert_Key'"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f9251733-30d4-4920-a882-ff95a47db155"}],"id":"8243881d-d9c4-48ac-8f41-980631de78c9","description":"<h1 id=\"lookup-description\">Lookup Description</h1>\n<h5 id=\"the-lookup-service-lists-all-possible-values-for-fields-which-have-a-discrete-list-of-defined-values\">The Lookup service lists all possible values for fields which have a discrete list of defined values.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/lookup\">http://sparkplatform.com/docs/reso/lookup</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Attribute</th>\n<th>Data Type</th>\n<th>Searchable</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>LookupName</code></td>\n<td><a href=\"http://sparkplatform.com/docs/supporting-documentation/search-and-paging-syntax/#data_types_character\">Character</a></td>\n<td>Yes</td>\n<td>The name of the RESO Web API field to which the lookup value belongs.</td>\n</tr>\n<tr>\n<td><code>LookupValue</code></td>\n<td><a href=\"http://sparkplatform.com/docs/supporting-documentation/search-and-paging-syntax/#data_types_character\">Character</a></td>\n<td>Yes</td>\n<td>The field value that will appear in the RESO Web API payload. This will replace the <code>LegacyODataValue</code>.</td>\n</tr>\n<tr>\n<td><code>StandardLookupValue</code></td>\n<td><a href=\"http://sparkplatform.com/docs/supporting-documentation/search-and-paging-syntax/#data_types_character\">Character</a></td>\n<td>Yes</td>\n<td>The corresponding <a href=\"https://ddwiki.reso.org/display/DDW16\">RESO Data Dictionary</a> term, when applicable.</td>\n</tr>\n<tr>\n<td><code>LegacyODataValue</code></td>\n<td><a href=\"http://sparkplatform.com/docs/supporting-documentation/search-and-paging-syntax/#data_types_character\">Character</a></td>\n<td>Yes</td>\n<td>The value currently delivered in the RESO Web API payload, including encoded <code>b__</code> lookup values.</td>\n</tr>\n<tr>\n<td><code>ModificationTimestamp</code></td>\n<td><a href=\"http://sparkplatform.com/docs/supporting-documentation/search-and-paging-syntax/#data_types_datetime\">Datetime</a></td>\n<td>Yes</td>\n<td>The time and date when the field value was last modified.</td>\n</tr>\n<tr>\n<td><code>LookupKey</code></td>\n<td><a href=\"http://sparkplatform.com/docs/supporting-documentation/search-and-paging-syntax/#data_types_character\">Character</a></td>\n<td>No</td>\n<td>The unique system key for the field value.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"8243881d-d9c4-48ac-8f41-980631de78c9"},{"name":"Get Media","item":[{"name":"All Media for a Property","id":"72d1541d-5f6f-4a87-9fd5-c224b7443aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('<Insert_ListingKey>')/Media","urlObject":{"protocol":"https","path":["Reso","OData","Property('<Insert_ListingKey>')","Media"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"72d1541d-5f6f-4a87-9fd5-c224b7443aa9"},{"name":"Specific Media Record for a Property","id":"b48b186c-d6ef-406a-9f27-d8e7494fae22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('<Insert_ListingKey>')/Media('<MediaKey>')","urlObject":{"protocol":"https","path":["Reso","OData","Property('<Insert_ListingKey>')","Media('<MediaKey>')"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b48b186c-d6ef-406a-9f27-d8e7494fae22"},{"name":"$select Media Fields","id":"459928a8-a11e-4369-86b7-b6d044990375","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property/Media?$expand=Media($select=ResourceRecordKey,Order,MediaURL,PreferredPhotoYN)","description":"<p>You can also use $top, $skip, etc within those paranthesis (and/or in conjunction). For example:<code>$expand=Media($select=ResourceRecordKey,Order,MediaURL,PreferredPhotoYN;$top=1)</code></p>\n","urlObject":{"protocol":"https","path":["Reso","OData","Property","Media"],"host":["replication","sparkapi","com"],"query":[{"key":"$expand","value":"Media($select=ResourceRecordKey,Order,MediaURL,PreferredPhotoYN)"}],"variable":[]}},"response":[],"_postman_id":"459928a8-a11e-4369-86b7-b6d044990375"}],"id":"a4747e7b-0c89-4b8a-ae75-d2767c3e4e8f","description":"<h5 id=\"the-media-resource-accesses-photos-videos-documents-and-virtual-tours-for-a-given-property-fbs-recommends-utilizing-the-expand-parameter-to-access-these-records-the-subresources-listed-below-should-only-be-used-if-the-expand-parameter-will-not-accommodate-your-use-case\">The Media resource accesses photos, videos, documents and virtual tours for a given <a href=\"http://sparkplatform.com/docs/reso/properties\">Property</a>. FBS recommends utilizing the <a href=\"http://sparkplatform.com/docs/reso/request_parameters#expansion\">$expand</a> parameter to access these records. The subresources listed below should only be used if the $expand parameter will not accommodate your use case.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/media\">http://sparkplatform.com/docs/reso/media</a></p>\n","_postman_id":"a4747e7b-0c89-4b8a-ae75-d2767c3e4e8f"},{"name":"Get Metadata","item":[{"name":"All Metadata","id":"27b0da2d-6a19-4f82-9733-f706a897a9f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/$metadata","description":"<p>Get Metadata for the Web API feed. Note that the metadata returned will vary depending on the role of the key you supply as well as the MLS you connect to.</p>\n","urlObject":{"protocol":"https","path":["Reso","OData","$metadata"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"27b0da2d-6a19-4f82-9733-f706a897a9f7"}],"id":"f94ab1f3-3c91-4202-8cf2-c97d5a6275e0","_postman_id":"f94ab1f3-3c91-4202-8cf2-c97d5a6275e0","description":""},{"name":"Get Member","item":[{"name":"All Members","id":"f35bd7b3-67c3-4d41-9fd5-677a7b697b3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Member","urlObject":{"protocol":"https","path":["Reso","OData","Member"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"ab13f5a4-5394-4d95-98be-7ffec903f407","name":"Filter Active Members","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Member?$filter=MemberStatus eq 'Active'","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Member"],"query":[{"key":"$filter","value":"MemberStatus eq 'Active'"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f35bd7b3-67c3-4d41-9fd5-677a7b697b3b"}],"id":"2f92aa51-2aa8-43ea-a18a-f63dceea037d","description":"<h5 id=\"the-member-resource-accesses-the-same-data-as-sparks-accounts-service-when-that-service-applies-a-_filter-of-usertype-eq-member\">The Member resource accesses the same data as Spark's <a href=\"http://sparkplatform.com/docs/api_services/my_account\">accounts service</a>, when that service applies a <code>_filter</code> of <code>UserType Eq 'Member'</code>.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/members\">http://sparkplatform.com/docs/reso/members</a></p>\n","_postman_id":"2f92aa51-2aa8-43ea-a18a-f63dceea037d"},{"name":"Get Office","item":[{"name":"All Offices","id":"24a0d5aa-aa5a-42c0-bed2-fed6ea36ca54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Office","urlObject":{"protocol":"https","path":["Reso","OData","Office"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"39d99aec-75cb-4a8d-92cd-3659ce0d1543","name":"Filter Active Offices","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Office?$filter=OfficeStatus eq 'Active'","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Office"],"query":[{"key":"$filter","value":"OfficeStatus eq 'Active'"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"24a0d5aa-aa5a-42c0-bed2-fed6ea36ca54"}],"id":"9ce9452b-8c4b-4072-b804-f3c911ff0bef","description":"<h5 id=\"the-office-resource-accesses-the-same-data-as-sparks-accounts-service-when-that-service-applies-a-_filter-of-usertype-eq-office\">The Office resource accesses the same data as Spark's <a href=\"http://sparkplatform.com/docs/api_services/my_account\">accounts service</a>, when that service applies a <code>_filter</code> of <code>UserType Eq 'Office'</code>.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/offices\">http://sparkplatform.com/docs/reso/offices</a></p>\n","_postman_id":"9ce9452b-8c4b-4072-b804-f3c911ff0bef"},{"name":"Get Open Houses","item":[{"name":"All Open Houses","id":"dc83f001-5689-4636-8ad1-24239158838b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/OpenHouse","urlObject":{"protocol":"https","path":["Reso","OData","OpenHouse"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"13ec64ff-a765-4698-bbe9-2b15566b056f","name":"Filter Start/EndTime","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/OpenHouse?$filter=OpenHouseStartTime lt 2023-02-09T19:00:00Z&$select=OpenHouseStartTime,OpenHouseEndTime","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","OpenHouse"],"query":[{"key":"$filter","value":"OpenHouseStartTime lt 2023-02-09T19:00:00Z"},{"key":"$select","value":"OpenHouseStartTime,OpenHouseEndTime"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2dddefe5-b3b6-41ca-bece-e87798685a93","name":"All OpenHouses for a Property","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('Insert_ListingKey')/OpenHouse"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6074b3bc-611f-4d55-94fb-30d3543a5eb2","name":"Specific OpenHouse Record","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/OpenHouse/('Insert_OpenHouseKey')"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"584150b5-1bc0-4c2c-a8a6-87dad5f96a98","name":"Specific OpenHouse Record for a Property","originalRequest":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('Insert ListingKey')/OpenHouse('Insert_OpenHouseKey')"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"dc83f001-5689-4636-8ad1-24239158838b"}],"id":"957087a6-4fc7-43d7-835c-219351338688","description":"<h5 id=\"the-openhouse-resource-returns-upcoming-open-house-data-either-for-all-property-listings-in-the-current-users-mls-or-for-a-given-property\">The OpenHouse resource returns upcoming open house data, either for all Property listings in the current user's MLS, or for a given <a href=\"http://sparkplatform.com/docs/reso/properties\">Property</a>.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/openhouses\">http://sparkplatform.com/docs/reso/openhouses</a></p>\n","_postman_id":"957087a6-4fc7-43d7-835c-219351338688"},{"name":"Get Power Production","item":[{"name":"Power Production for a property","id":"f7dfe24d-668c-4679-b68e-e3a94e31badd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('<Insert_ListingKey>')/PowerProduction","urlObject":{"protocol":"https","path":["Reso","OData","Property('<Insert_ListingKey>')","PowerProduction"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7dfe24d-668c-4679-b68e-e3a94e31badd"}],"id":"8394e622-54b0-4e35-8ebd-e4425ecd925a","description":"<h5 id=\"the-powerproduction-resource-accesses-the-power-production-fields-for-a-given-property-fbs-recommends-utilizing-the-expand-parameter-to-access-these-records-the-subresources-listed-below-should-only-be-used-if-the-expand-parameter-will-not-accommodate-your-use-case\">The PowerProduction resource accesses the power production fields for a given <a href=\"http://sparkplatform.com/docs/reso/properties\">Property</a>. FBS recommends utilizing the <a href=\"http://sparkplatform.com/docs/reso/request_parameters#expansion\">$expand</a> parameter to access these records. The subresources listed below should only be used if the $expand parameter will not accommodate your use case.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/power_production\">http://sparkplatform.com/docs/reso/power_production</a></p>\n","_postman_id":"8394e622-54b0-4e35-8ebd-e4425ecd925a"},{"name":"Get Property","item":[{"name":"All Properties","id":"30f83882-fc0a-4f85-8a52-f73c3e272516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property","description":"<p>Get available Property resources, without specifying any filter, top, or limit</p>\n","urlObject":{"protocol":"https","path":["Reso","OData","Property"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[{"id":"4a964c9d-d3d5-42d4-bdc4-cd0abfffcc43","name":"Expand Media","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Property?$expand=Media","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Property"],"query":[{"key":"$expand","value":"Media"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e8786056-5f21-43f6-a2ca-3762eb92fa03","name":"Filter ListPrice","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Property?$filter=ListPrice gt 100000&$orderby=ListPrice desc","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Property"],"query":[{"key":"$filter","value":"ListPrice gt 100000"},{"key":"$orderby","value":"ListPrice desc"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fe114f1b-47f7-4ee1-81c3-5074d152e948","name":"Filter Multiple ListingIds","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Property?$filter=ListingId in ('Insert_ListingId','Insert_ListingId')&$select=ListingId","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Property"],"query":[{"key":"$filter","value":"ListingId in ('Insert_ListingId','Insert_ListingId')"},{"key":"$select","value":"ListingId"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f434989e-45b2-4e0a-825b-0b5bf0403b5a","name":"Filter contains","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Property?$filter=contains(UnparsedAddress, 'Sesame St.')","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Property"],"query":[{"key":"$filter","value":"contains(UnparsedAddress, 'Sesame St.')"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"63dc79f9-2b42-4019-afff-5b77ed39152f","name":"Geolocation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://replication.sparkapi.com/Reso/OData/Property?$expand=Media&$top=20&$filter=MlsStatus eq 'Active' and PropertyType eq 'A' and geo.intersects(Location, geography'POLYGON(  (-109.426294921875 34.12862905578196, -114.589869140625 34.12862905578196, -114.589869140625 32.845902595235415, -109.426294921875 32.845902595235415, -109.426294921875 34.12862905578196))')","protocol":"https","host":["replication","sparkapi","com"],"path":["Reso","OData","Property"],"query":[{"key":"$expand","value":"Media"},{"key":"$top","value":"20"},{"key":"$filter","value":"MlsStatus eq 'Active' and PropertyType eq 'A' and geo.intersects(Location, geography'POLYGON(  (-109.426294921875 34.12862905578196, -114.589869140625 34.12862905578196, -114.589869140625 32.845902595235415, -109.426294921875 32.845902595235415, -109.426294921875 34.12862905578196))')"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"30f83882-fc0a-4f85-8a52-f73c3e272516"}],"id":"85fb4714-fbbd-4f10-9867-b3e4cbdc7c6d","description":"<h5 id=\"the-property-resource-accesses-the-same-data-as-sparks-listings-service\">The Property resource accesses the same data as Spark's <a href=\"http://sparkplatform.com/docs/api_services/listings\">listings service</a></h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/properties\">http://sparkplatform.com/docs/reso/properties</a></p>\n","_postman_id":"85fb4714-fbbd-4f10-9867-b3e4cbdc7c6d"},{"name":"Get Room","item":[{"name":"All Rooms","id":"0b370200-d154-4ef4-b55e-487820ad2eb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('<Insert_ListingKey>')/Room","urlObject":{"protocol":"https","path":["Reso","OData","Property('<Insert_ListingKey>')","Room"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b370200-d154-4ef4-b55e-487820ad2eb3"}],"id":"a85d6a04-a6db-4734-9241-85f8ddc5ffe6","description":"<h5 id=\"the-room-resource-accesses-room-data-for-a-given-property-fbs-recommends-utilizing-the-expand-parameter-to-access-these-records-the-subresources-listed-below-should-only-be-used-if-the-expand-parameter-will-not-accommodate-your-use-case\">The Room resource accesses room data for a given <a href=\"http://sparkplatform.com/docs/reso/properties\">Property</a>. FBS recommends utilizing the <a href=\"http://sparkplatform.com/docs/reso/request_parameters#expansion\">$expand</a> parameter to access these records. The subresources listed below should only be used if the $expand parameter will not accommodate your use case.</h5>\n<p><a href=\"http://sparkplatform.com/docs/reso/rooms\">http://sparkplatform.com/docs/reso/rooms</a></p>\n","_postman_id":"a85d6a04-a6db-4734-9241-85f8ddc5ffe6"},{"name":"Get Unit","item":[{"name":"All Units","id":"a64b2b0c-cd9b-4a43-b719-f02e920de0be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://replication.sparkapi.com/Reso/OData/Property('<Insert_ListingKey>')/Unit","urlObject":{"protocol":"https","path":["Reso","OData","Property('<Insert_ListingKey>')","Unit"],"host":["replication","sparkapi","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a64b2b0c-cd9b-4a43-b719-f02e920de0be"}],"id":"056cd5f0-237e-4809-ae8d-b5cb25e2e8df","description":"<p>The Unit resource accesses unit data for a given <a href=\"http://sparkplatform.com/docs/reso/properties\">Property</a>. FBS recommends utilizing the <a href=\"http://sparkplatform.com/docs/reso/request_parameters#expansion\">$expand</a> parameter to access these records. The subresources listed below should only be used if the $expand parameter will not accommodate your use case.</p>\n<p><a href=\"http://sparkplatform.com/docs/reso/units\">http://sparkplatform.com/docs/reso/units</a></p>\n","_postman_id":"056cd5f0-237e-4809-ae8d-b5cb25e2e8df"}],"id":"58804743-9c90-439a-aa95-0bff08093fb1","description":"<h2 id=\"reso-web-api-overview-documentation\"><a href=\"http://sparkplatform.com/docs/reso/overview\">RESO Web API Overview Documentation</a></h2>\n<h3 id=\"review-the-odata-url-conventions-for-a-comprehensive-list-of-logical-operators-compatible-with-our-reso-web-api\">Review the <a href=\"https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html\">OData URL Conventions</a> for a comprehensive list of logical operators compatible with our RESO Web API.</h3>\n","_postman_id":"58804743-9c90-439a-aa95-0bff08093fb1"}],"event":[{"listen":"prerequest","script":{"id":"7a44ff30-19f7-4a25-8a21-878610ca43d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f8475f86-c29f-42bb-8ebe-9bb366800775","type":"text/javascript","exec":[""]}}]}