idx_get_account_info
Get account info
The IDX Broker client account this access key belongs to: company and contact details and account settings (access keys and passwords are never returned). The reply also shows how many of the key's hourly API accesses are used. GET /clients/accountinfo.
Takes no parameters.
idx_get_account_type
Get account type
The IDX Broker plan of the account (Lite or Platinum). It sets the hourly API limit: 300 accesses per key on Lite, 500 on Platinum. GET /clients/accounttype.
Takes no parameters.
idx_list_agents
List agents
Agents on a multi-user IDX Broker account (id, name, office, contact details, category, language, login dates). Filter by one field or by a time window. GET /clients/agents.
Parametersfieldsintervaldate_typefilter_fieldfilter_valuestart_datetime
idx_list_offices
List offices
Offices on a multi-user IDX Broker account. Filter by one field or by a time window. GET /clients/offices.
Parametersfieldsintervaldate_typefilter_fieldfilter_valuestart_datetime
List the account's leads (website registrants) with contact details, status, agent owner, and last viewed listings and searches. A reply holds up to 500 leads; pass offset to page on and look for pagination information in the reply. Filter by a time window on signup, edit, login or activity date. Uses one of the key's hourly API accesses. GET /leads/lead.
Parametersfieldsoffsetsort_byintervaldate_typestart_datetime
One lead by id with its details, last 5 viewed listings and searches, and the total number of listings viewed. GET /leads/lead/{leadID}.
Parametersfieldslead_idrequired
idx_list_lead_notes
List lead notes
Notes on a lead, or one note when note_id is given. GET /leads/note/{leadID}[/{noteID}].
Parametersfieldslead_idrequirednote_idintervaldate_typestart_datetime
idx_list_lead_searches
List lead saved searches
Saved property searches of a lead (or one search when search_id is given), with the results URL of each. GET /leads/search/{leadID}[/{searchID}].
Parametersfieldslead_idrequiredintervaldate_typesearch_idstart_datetime
idx_list_lead_saved_properties
List lead saved properties
Properties a lead saved (or one when property_id is given). GET /leads/property/{leadID}[/{propertyID}].
Parametersfieldslead_idrequiredintervaldate_typeproperty_idstart_datetime
idx_get_lead_traffic
Get lead traffic
Website traffic history of one lead: date, page, referrer and IP of each visit (at most 5,000 rows per request; use interval/offset/limit to narrow it). GET /leads/leadtraffic/{leadID}.
Parameterslimitfieldsoffsetlead_idrequiredintervalstart_datetime
idx_list_featured_listings
List featured listings
The account's featured (active) listings with address, price, status, photos and agent. Only the account's own listings are returned, never general MLS data. GET /clients/featured.
Parameterslimitfieldsoffsetintervaldate_typedisclaimersstart_datetime
idx_list_sold_pending_listings
List sold and pending listings
The account's sold and pending listings, that is those removed from the MLS feed. GET /clients/soldpending.
Parameterslimitfieldsoffsetintervaldate_typedisclaimersstart_datetime
idx_list_off_market_listings
List off-market listings
The account's off-market listings. GET /clients/offmarket.
Parameterslimitfieldsoffsetintervaldate_typedisclaimersstart_datetime
idx_list_supplemental_listings
List supplemental listings
The account's supplemental (non-MLS) listings with a basic set of fields. GET /clients/supplemental.
Parameterslimitfieldsoffsetintervaldate_typedisclaimersstart_datetime
idx_list_saved_links
List saved links
Saved links (pre-built property search pages) of the account with id, name and URL. GET /clients/savedlinks.
Parameterslimitfieldsoffsetintervalstart_datetime
idx_get_saved_link_count
Count properties of a saved link
The total number of properties a saved link currently matches. GET /clients/savedlinks/{savedLinkID}/count.
Parameterssaved_link_idrequired
idx_list_widgets
List widgets
The JavaScript widgets on the account with id, name, URL and options. GET /clients/widgets.
Parameterslimitfieldsoffset
One JavaScript widget with its settings. GET /clients/widgets/{id}.
Parametersfieldswidget_idrequired
idx_list_system_links
List system links
The system pages of the account's site (search, featured, contact...) with name, id and URL, which can be linked to directly. GET /clients/systemlinks.
Parametersfields
idx_list_approved_mls
List approved MLSs
The MLSs approved for display on the account, with their IDX ids (such as a001) and names. Use the id in the other MLS tools. GET /mls/approvedmls.
Parametersfields
idx_get_mls_age
Get MLS data age
When an MLS feed was last downloaded and processed and when its images were last gathered (UTC). GET /mls/age/{idxID}.
Parametersfieldsidx_idrequired
idx_list_mls_property_types
List MLS property types
Property types of an MLS with the IDX type id, the MLS name, the parent type and subtypes. GET /mls/propertytypes/{idxID}.
Parametersfieldsidx_idrequiredfilter_fieldfilter_value
idx_list_mls_search_fields
List MLS search fields
The fields of an MLS that can be searched under MLS rules: field name, display name and the property types they belong to. GET /mls/searchfields/{idxID}.
Parametersfieldsidx_idrequiredfilter_fieldfilter_value
idx_list_mls_locations
List MLS cities, counties or postal codes
Cities, counties or postal codes present in an MLS's data, with ids and a count of occurrences. Filter fields: cities = cityID, cityName, stateAbrv, mlsPtID; counties = countyID, countyName, stateAbrv, mlsPtID; postalcodes = id, stateAbrv, mlsPtID. GET /mls/{cities|counties|postalcodes}/{idxID}.
Parameterskindrequiredfieldsidx_idrequiredfilter_fieldfilter_value
idx_create_lead
Create lead
WRITE: creates a new lead in the IDX Broker account (and may trigger the account's own lead notifications). Needs a correctly formatted email with a valid MX record; IDX rejects bad addresses with a server error. Extra fields go in `fields` by their IDX name, as seen on a lead returned by idx_get_lead. Returns the new lead id. PUT /leads/lead.
Parametersemailrequiredfieldslast_namerequiredfirst_namerequired
idx_add_lead_note
Add lead note
WRITE: adds a note to a lead (visible to the account's agents). Returns the new note id. PUT /leads/note/{leadID}.
Parametersnoterequiredlead_idrequired
idx_update_lead
Update lead
WRITE: changes fields of an existing lead; the given values replace the stored ones. Only pass what must change. Field names are the IDX lead field names as seen on a lead returned by idx_get_lead (for example firstName, lastName, email, phone, status). POST /leads/lead/{leadID}.
Parametersfieldsrequiredlead_idrequired