Created
July 19, 2018 19:47
-
-
Save antonioortegajr/afa5504e7d3ce641e7a15301fc1f6f02 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # as a demonstration of an API spec in YAML | |
| swagger: '2.0' | |
| info: | |
| title: IDX Broker API | |
| description: Valid API key required. | |
| version: "1.5.0" | |
| # the domain of the service | |
| host: check.antonioortegajr.com | |
| # array of all schemes that your API supports | |
| schemes: | |
| - https | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| # will be prefixed to all paths | |
| basePath: /wp-json/swagger-proxy/v1 | |
| #API endpoints | |
| paths: | |
| #clients component | |
| /clients/accountinfo: | |
| get: | |
| summary: Get client account information. | |
| description: Get your IDX Broker account info such as clientName, address, phone email, last accessed, etc.. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Your account info. | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| post: | |
| summary: Post client account information. | |
| description: Post your IDX Broker account info such as clientName, address, phone email, last accessed, etc.. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: displayName | |
| in: query | |
| description: Client name. | |
| required: true | |
| type: string | |
| - name: address | |
| in: query | |
| description: Client address. | |
| required: true | |
| type: string | |
| - name: city | |
| in: query | |
| description: Client city. | |
| required: true | |
| type: string | |
| - name: stateProvince | |
| in: query | |
| description: Client state or province. | |
| required: true | |
| type: string | |
| - name: zipCode | |
| in: query | |
| description: Client zip code. | |
| required: true | |
| type: string | |
| - name: phone1 | |
| in: query | |
| description: Client phone. | |
| required: true | |
| type: string | |
| tags: | |
| - Clients | |
| responses: | |
| 204: | |
| description: Success. | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/accounttype: | |
| get: | |
| summary: Your account type. | |
| description: Get your IDX Broker account type. This does not return JSON or XML. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Your account type. Platinum or Lite | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/agents: | |
| get: | |
| summary: Agent information | |
| description: View agent information on a multi-user account. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["agentID", "officeID", "category", "language", "agentName"] | |
| type: string | |
| - name: dateType | |
| in: query | |
| description: There are several dates associated with an agent, this will specify what is being used to return information. | |
| required: false | |
| enum: ["accountCreated", "lastLoginDate"] | |
| type: string | |
| - $ref: "#/parameters/filterValue" | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Empty return | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/apiversion: | |
| get: | |
| summary: Default API version | |
| description: Get the default API version. This does not return JSON or XML | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/cities/{listID}: | |
| get: | |
| summary: Client city list data. ID required in this tester, but not in your scripting. | |
| description: Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - in: path | |
| name: listID | |
| description: If no ID is given a list of IDs is returned. | |
| required: true | |
| type: number | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Valid API call with nothing to retrun | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/citieslistname: | |
| get: | |
| summary: IDs and names for each of a client's city lists | |
| description: Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS Note that this method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/counties/{listID}: | |
| get: | |
| summary: Counties information. ID required in this tester, but not in your scripting. | |
| description: Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - in: path | |
| name: listID | |
| description: If no ID is given a list of IDs is returned. | |
| required: true | |
| type: number | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/countieslistname: | |
| get: | |
| summary: IDs and names for each of a client's counties lists | |
| description: Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: dynamicURL is required. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. Invalid savedLinkID or pageID will result in 500 error | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/dynamicwrapperurl: | |
| post: | |
| summary: Update dynamic wrapper url | |
| description: Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: dynamicURL | |
| in: query | |
| description: dynamic wrapper url. | |
| required: true | |
| type: string | |
| - name: savedLinkID | |
| in: query | |
| description: saved link ID if setting dynamic wrapper url for a specific saved link. | |
| required: false | |
| type: string | |
| - name: pageID | |
| in: query | |
| description: age ID if setting dynamic wrapper url for a specific page. | |
| required: false | |
| type: string | |
| tags: | |
| - Clients | |
| responses: | |
| 204: | |
| description: Success | |
| 400: | |
| description: dynamicURL is required. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: Invalid savedLinkID or pageID will result in 500. error | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/featured: | |
| get: | |
| summary: Featured Listings | |
| description: | |
| Listing data. Only listings belonging to the agent(s) on an IDX Broker Account is available. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - $ref: "#/parameters/limit" | |
| - $ref: "#/parameters/disclaimers" | |
| - $ref: "#/parameters/offset" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success, nothing to return. | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/listallowedfields/{idxID}/{listingID}: | |
| get: | |
| summary: allowed returnable fields for a given listingID. | |
| description: Returns the allowed returnable fields for a given listingID. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - $ref: "#/parameters/listingID" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/listcomponents: | |
| get: | |
| summary: componant information | |
| description: View componant information. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/listmethods: | |
| get: | |
| summary: all available methods in the current API component | |
| description: A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/offices: | |
| get: | |
| summary: offices information | |
| description: IDX data for an office. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/postalcodes/{listID}: | |
| get: | |
| summary: client's postalcode lists | |
| description: Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note that this method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: listID | |
| in: path | |
| required: true | |
| description: The numeric id of a client zipcode listID. | |
| type: number | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/postalcodeslistname: | |
| get: | |
| summary: postalcode information | |
| description: Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/savedlinks: | |
| get: | |
| summary: saved links information | |
| description: Get saved links for a given client account. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Empty Retrurn | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| tags: | |
| - Clients | |
| put: | |
| summary: Create a new client saved link | |
| description: Create a new client saved link. | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: This action is not allowed if the client has more than 1000 saved links. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/savedlinks/{savedLinksID}/count: | |
| post: | |
| summary: Update an existing client's saved link | |
| description: Update an existing client's saved link. This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: savedLinksID | |
| in: path | |
| required: true | |
| description: The numaric id of a client savedlink list. | |
| type: number | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: if no POST data is supplied, then a list of updatable fields with format information is returned | |
| 204: | |
| description: Empty return | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| delete: | |
| summary: Remove a new client saved link | |
| description: Remove a new client saved link. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: savedLinksID | |
| in: path | |
| required: true | |
| type: number | |
| responses: | |
| 204: | |
| description: Empty response | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| tags: | |
| - Clients | |
| /clients/soldpending: | |
| get: | |
| summary: sold and pending properties information | |
| description: Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/supplemental/{listingID}: | |
| delete: | |
| summary: remove a supplemental listing | |
| description: Remove a supplemental listing from the account. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: listingID | |
| in: path | |
| required: true | |
| description: The numaric id of a client supplemental listingID. | |
| type: number | |
| tags: | |
| - Clients | |
| responses: | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| post: | |
| summary: Update an existing supplemental listing. | |
| description: Update an existing supplemental listing. If updating images, existing images are deleted and the new images are inserted instead for the listing. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: listingID | |
| in: path | |
| required: true | |
| description: The numaric id of a client supplemental listing. | |
| type: number | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: if no POST data is supplied, then a list of updatable fields with format information is returned | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/supplemental: | |
| get: | |
| summary: supplemental properties information | |
| description: Get supplemental properties information for a given client account. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| put: | |
| summary: Create a new supplemental listing | |
| description: Create a new supplemental listing. | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: This action is not allowed if the client has more than 1000 supplmental listings. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/systemlinks: | |
| get: | |
| summary: system pages | |
| description: Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/widgetsrc: | |
| get: | |
| summary: URLs for javascript widgets | |
| description: Gather all the URLs for javascript widgets on the user account. These widgets can then be placed on the user's main site via the included URLs. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/wrappercache: | |
| delete: | |
| summary: clear wrapper cache | |
| description: clear wrapper cache. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Clients | |
| responses: | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /clients/zipcodes/{listID}: | |
| get: | |
| summary: zipcodes available in each of a client's zipcode lists | |
| description: Returns the zipcodes available in each of a client's zipcode lists. Since a client can build any number of zipcode lists this method requires the ID of which list you want to view. To get a list of all zipcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: listID | |
| in: path | |
| required: true | |
| description: The numeric id of a client zipcode listID. | |
| type: number | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Clients | |
| responses: | |
| 200: | |
| description: All zipcodes in a given list or, if a list ID is not provided, a list of list IDs. | |
| schema: | |
| type: string | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| #leads component | |
| /leads/bulklead: | |
| post: | |
| summary: Update an existing client's saved links | |
| description: Update an existing client's saved link. This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| put: | |
| summary: Update an existing client's saved link. | |
| description: Update an existing client's saved link. This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/leadID: | |
| delete: | |
| summary: Remove a lead system wide | |
| description: This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| get: | |
| summary: information for one or multiple lead | |
| description: Get information for one or multiple leads. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Empty return | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| post: | |
| summary: Update the information for one lead | |
| description: Update the information for one lead specified by the primary request ID. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads: | |
| put: | |
| summary: Create a new lead | |
| description: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/listcomponents: | |
| get: | |
| summary: list of all API components available | |
| description: This is a simple, access anywhere, method for getting a list of all API components available. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/listmethods: | |
| get: | |
| summary: Listing all available methods in the current API component | |
| description: A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/note/{leadID}/{noteID}: | |
| delete: | |
| summary: Remove a lead note | |
| description: Remove a lead note. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: noteID | |
| in: path | |
| required: true | |
| description: The numeric id of a client note ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| get: | |
| summary: Get notes for a lead | |
| description: Get notes for a lead. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: noteID | |
| in: path | |
| required: true | |
| description: The numeric id of a client note ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Empty return | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| post: | |
| summary: Update notes information for one lead | |
| description: Update the notes information for one lead specified by the primary request ID. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: noteID | |
| in: path | |
| required: true | |
| description: The numeric id of a client note ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/note/{leadID}: | |
| put: | |
| summary: Create a new lead note | |
| description: Create a new lead note. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/property/{leadID}/{propertyID}: | |
| delete: | |
| summary: Remove a lead saved property | |
| description: Remove a lead saved property. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: propertyID | |
| in: path | |
| required: true | |
| description: The numeric id of a client saved property ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 204: | |
| description: Empty return | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| get: | |
| summary: Get saved properties for a lead | |
| description: Get saved properties for a lead. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: propertyID | |
| in: path | |
| required: true | |
| description: The numeric id of a client saved property ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned. | |
| 204: | |
| description: Empty return | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| post: | |
| summary: Update an existing lead's saved property | |
| description: Update an existing lead's saved property. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: propertyID | |
| in: path | |
| required: true | |
| description: The numeric id of a client saved property ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/property/{leadID}: | |
| put: | |
| summary: Create a new lead property | |
| description: Create a new lead property. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/search/{leadID}/{searchID}: | |
| delete: | |
| summary: Remove a lead property | |
| description: Remove a lead property. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: searchID | |
| in: path | |
| required: true | |
| description: The numeric id of a client saved search ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| get: | |
| summary: Get searches for a lead | |
| description: Get searches for a lead. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: searchID | |
| in: path | |
| required: true | |
| description: The numeric id of a client saved search ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Empty return | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| post: | |
| summary: Update an existing lead's saved search | |
| description: Update an existing lead's saved search. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| - name: searchID | |
| in: path | |
| required: true | |
| description: The numeric id of a client saved search ID. | |
| type: number | |
| tags: | |
| - Leads | |
| responses: | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /leads/search/{leadID}: | |
| put: | |
| summary: Create a new lead note | |
| description: Create a new lead note. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/leadID" | |
| tags: | |
| - Leads | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| #mls component | |
| /mls/age/{idxID}: | |
| get: | |
| summary: Last MLS refresh | |
| description: Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed. Dates/times given are UTC | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/approvedmls: | |
| get: | |
| summary: approved MLSs | |
| description: This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account. Note this method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/cities/{idxID}: | |
| get: | |
| summary: Cities in an MLS | |
| description: All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["cityID", "cityName", "mlsPtID"] | |
| type: string | |
| - $ref: "#/parameters/filterValue" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/counties/{idxID}: | |
| get: | |
| summary: Counties in an MLS | |
| description: All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["countyID", "countyName", "mlsPtID"] | |
| type: string | |
| - $ref: "#/parameters/filterValue" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/listcomponents: | |
| get: | |
| summary: List of all MLS API components | |
| description: This is a simple, access anywhere, method for getting a list of all API components available. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/listmethods: | |
| get: | |
| summary: List of all MLS API methods | |
| description: A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/postalcodes/{idxID}: | |
| get: | |
| summary: All postal codes represented in the current set of MLS data | |
| description: All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["id", "stateAbrv", "mlsPtID"] | |
| type: string | |
| - $ref: "#/parameters/filterValue" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/prices/{idxID}: | |
| get: | |
| summary: total of properties listed in a given MLS | |
| description: The sum total of properties listed in a given MLS as well as sums for each property type in the MLS. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/propertycount/{idxID}: | |
| get: | |
| summary: Total number of listings available for a given city, county, or zipcode. | |
| description: Gives a total number of listings available for a given city, county, or zipcode. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: countType | |
| in: query | |
| description: Specify if you are looking for the count of a city, county, or zipcode. | |
| required: false | |
| enum: ["city", "county", "zipcode"] | |
| type: string | |
| - name: countSpecifier | |
| in: query | |
| description: The numeric city ID, county ID, or zipcode for which you want to get a property count. | |
| required: false | |
| type: number | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/propertytypes/{idxID}: | |
| get: | |
| summary: Property type information for all types | |
| description: Gives the property type information for all types that are available on a given MLS. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["mlsPtID", "mlsPropertyType"] | |
| type: string | |
| - $ref: "#/parameters/filterValue" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/searchfields/{idxID}: | |
| get: | |
| summary: Seach Fields Data | |
| description: All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["mlsPtID", "parentPtID"] | |
| type: string | |
| - $ref: "#/parameters/filterValue" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/searchfieldvalues/{idxID}: | |
| get: | |
| summary: Seach Field Values | |
| description: Field values in a given MLS that are currently allowed to be searched according to MLS guidelines. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["mlsPtID", "parentPtID"] | |
| type: string | |
| - name: mlsPtID | |
| in: query | |
| description: The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. | |
| required: false | |
| type: number | |
| - name: name | |
| in: query | |
| description: mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. | |
| required: false | |
| type: string | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /mls/zipcodes/{idxID}: | |
| get: | |
| summary: All zip codes represented in the current set of MLS data | |
| description: All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/ancillarykey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["zipcode", "stateAbrv", "mlsPtID"] | |
| type: string | |
| - $ref: "#/parameters/filterValue" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - MLS | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| #partners component | |
| /partners/aggregatedagents: | |
| get: | |
| summary: Get a list of all agents for your clients. | |
| description: Get a list of all agents for your clients. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| - $ref: "#/parameters/offset" | |
| - $ref: "#/parameters/limit" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedfeatured: | |
| get: | |
| summary: Get a list of featured MLS properties. | |
| description: Get a list of featured MLS properties. Output fields may or may not be populated depending on how the information was entered into the IDX system. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: dateType | |
| in: query | |
| description: There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. | |
| required: false | |
| enum: ["dateAdded", "dateModified"] | |
| type: string | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - $ref: "#/parameters/rf" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| - $ref: "#/parameters/offset" | |
| - $ref: "#/parameters/limit" | |
| - $ref: "#/parameters/disclaimers" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedleads: | |
| get: | |
| summary: Get a list of all leads. | |
| description: Get a list of featured MLS properties. For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: dateType | |
| in: query | |
| description: There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. | |
| required: false | |
| enum: ["subscribeDate", "lastEdited", "lastLoginDate", "lastPropertyUpdateDate", "lastActivityDate"] | |
| type: string | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - $ref: "#/parameters/rf" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedleadtraffic: | |
| get: | |
| summary: Get a list of all leads traffic history. | |
| description: Get a list of all leads traffic history. For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedlistingstatus: | |
| get: | |
| summary: MLS listings (not supplemental) by client account ID. | |
| description: This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: filterField | |
| in: query | |
| description: The field to use when filtering output.. | |
| required: false | |
| enum: ["status"] | |
| type: string | |
| - name: filterValue | |
| in: query | |
| description: The field to use when filtering output.. | |
| required: false | |
| enum: ["active", "unknown", "sold", "pending", "contigent"] | |
| type: string | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedproperties: | |
| get: | |
| summary: All lead saved properties. | |
| description: Get a list of all lead saved properties. For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - name: dateType | |
| in: query | |
| description: here are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. | |
| required: false | |
| enum: ["created", "lastEdited"] | |
| type: string | |
| - $ref: "#/parameters/rf" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| - $ref: "#/parameters/offset" | |
| - $ref: "#/parameters/limit" | |
| - $ref: "#/parameters/disclaimers" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedsearches: | |
| get: | |
| summary: All lead saved searches. | |
| description: Get a list of all lead saved searches. For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - name: dateType | |
| in: query | |
| description: here are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. | |
| required: false | |
| enum: ["created", "lastEdited"] | |
| type: string | |
| - $ref: "#/parameters/rf" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| - $ref: "#/parameters/offset" | |
| - $ref: "#/parameters/limit" | |
| - $ref: "#/parameters/disclaimers" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedsoldpending: | |
| get: | |
| summary: Sold/pending MLS properties. | |
| description: Get a list of sold/pending MLS properties. Output fields may or may not be populated depending on how the information was entered into the IDX system. We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - name: dateType | |
| in: query | |
| description: here are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. | |
| required: false | |
| enum: ["dateAdded", "dateModified"] | |
| type: string | |
| - $ref: "#/parameters/rf" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| - $ref: "#/parameters/offset" | |
| - $ref: "#/parameters/limit" | |
| - $ref: "#/parameters/disclaimers" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/aggregatedsupplemental: | |
| get: | |
| summary: Supplemental (non-MLS) properties | |
| description: Get a list of supplemental (non-MLS) properties. Output fields may or may not be populated depending on how the information was entered into the IDX system. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/interval" | |
| - $ref: "#/parameters/startDatetime" | |
| - name: dateType | |
| in: query | |
| description: here are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. | |
| required: false | |
| enum: ["dateAdded", "dateModified"] | |
| type: string | |
| - $ref: "#/parameters/rf" | |
| - $ref: "#/parameters/clientChunk" | |
| - $ref: "#/parameters/includeDisabledAccounts" | |
| - $ref: "#/parameters/offset" | |
| - $ref: "#/parameters/limit" | |
| - $ref: "#/parameters/disclaimers" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 204: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/apiversion: | |
| get: | |
| summary: Get the default api version. | |
| description: Get the default api version. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/availablemls: | |
| get: | |
| summary: List of available MLSs with their fees. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/clients: | |
| get: | |
| summary: Client List | |
| description: A list of clients available to a given partner. The list of clients can be filtered by GET values. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - name: filterField | |
| in: query | |
| description: Field to use when filtering output. | |
| required: false | |
| enum: ["accountStatus", "accountID"] | |
| type: string | |
| - name: filterValue | |
| in: query | |
| description: The value by which to filter. Conditional on use of filterField. | |
| required: false | |
| type: string | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/listcomponents: | |
| get: | |
| summary: List of all API components available | |
| description: This is a simple, access anywhere, method for getting a list of all API components available. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/listmethods: | |
| get: | |
| summary: Listing all available methods | |
| description: A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| /partners/propertytypes/{idxID}: | |
| get: | |
| summary: Names and IDs of all available property types. | |
| description: Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member. The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. | |
| parameters: | |
| - $ref: "#/parameters/accesskey" | |
| - $ref: "#/parameters/apiversion" | |
| - $ref: "#/parameters/outputtype" | |
| - $ref: "#/parameters/idxID" | |
| - $ref: "#/parameters/rf" | |
| tags: | |
| - Partners | |
| responses: | |
| 200: | |
| description: Success. | |
| 400: | |
| description: Required parameter missing or invalid. | |
| 401: | |
| description: accesskey not valid or revoked. | |
| 403: | |
| description: URL provided is not using SSL (HTTPS). | |
| 404: | |
| description: Invalid API component specified. | |
| 405: | |
| description: Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component. | |
| 406: | |
| description: accesskey not provided | |
| 409: | |
| description: Duplicate unique data detected. | |
| 412: | |
| description: Account is over it's hourly access limit. | |
| 413: | |
| description: Requested entity too large. | |
| 416: | |
| description: Requested time range not satisfiable. | |
| 417: | |
| description: There are more saved links in the account than allowed through the API. | |
| 500: | |
| description: General system error. Please try again later or contact IDX support. | |
| 503: | |
| description: Scheduled or emergency API maintenance will result in 503 errors. | |
| 521: | |
| description: Temporary error. There is a possibility that not all API methods are affected. | |
| #default paramaters | |
| parameters: | |
| accesskey: | |
| name: accesskey | |
| in: header | |
| description: REQUIRED Your API Key. | |
| required: true | |
| type: string | |
| minLength: 22 | |
| maxLength: 22 | |
| ancillarykey: | |
| #This key is referred to as both ancillary and Partner key. | |
| name: ancillarykey | |
| in: header | |
| description: Your Developer Partner API Key. | |
| required: false | |
| type: string | |
| minLength: 22 | |
| maxLength: 22 | |
| apiversion: | |
| name: apiversion | |
| in: header | |
| description: Version of the API to call. (Only 1.4.0 is supported in this tester) | |
| required: false | |
| type: string | |
| default: "1.4.0" | |
| outputtype: | |
| name: outputtype | |
| in: header | |
| description: Request JSON or XML. (Only JSON is supported in this tester) | |
| required: false | |
| enum: ["json", "xml"] | |
| type: string | |
| default: "json" | |
| interval: | |
| name: interval | |
| in: query | |
| description: The number of hours worth of data to return. | |
| required: false | |
| type: number | |
| startDatetime: | |
| name: startDatetime | |
| in: query | |
| description: The date and time to from which the interval counts back. This is the date and time closest to now from which you want agent information. Example for all agents created on New Year's Day provided. | |
| required: false | |
| enum: ["2016-01-01 23:59:59"] | |
| type: string | |
| limit: | |
| name: limit | |
| in: query | |
| description: Items to skip from the beginning. | |
| required: false | |
| type: number | |
| offset: | |
| name: offset | |
| in: query | |
| description: Items to skip from the beginning. | |
| required: false | |
| type: number | |
| filterValue: | |
| name: filterValue | |
| in: query | |
| description: The value by which to filter. Conditional on use of filterField | |
| required: false | |
| type: string | |
| rf: | |
| name: rf | |
| in: query | |
| description: Array of fields to return in the output. | |
| required: false | |
| type: string | |
| enum: ["rf[]=\\*", "rf=\\*"] | |
| idxID: | |
| name: idxID | |
| in: path | |
| description: The IDX id of a mls. | |
| required: true | |
| type: string | |
| minLength: 4 | |
| maxLength: 4 | |
| clientChunk: | |
| name: clientChunk | |
| in: query | |
| description: Limit the results data to 400 clients. Example - clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. | |
| required: false | |
| type: number | |
| includeDisabledAccounts: | |
| name: includeDisabledAccounts | |
| in: query | |
| description: By default disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. | |
| required: false | |
| type: boolean | |
| leadID: | |
| name: leadID | |
| in: path | |
| description: The idx id of a lead. | |
| required: true | |
| type: string | |
| minLength: 4 | |
| listingID: | |
| name: listingID | |
| in: path | |
| description: The idx id of a property listing. | |
| required: true | |
| type: string | |
| minLength: 1 | |
| disclaimers: | |
| name: disclaimers | |
| in: query | |
| description: Include MLS disclaimer/courtesy in the response. | |
| required: false | |
| type: boolean |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment