Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Sandbox

The IDX API Sandbox returns 50 records of the demo records for application development and testing.

Sandbox Endpoint is: https://idx.realtyfeed.com/api/mls/sandbox/mlg_demo/search

To use that, send the following value as the Authorization header of a request:

Token ead605f1928a7a388e47ea7ebb711e800c39522b

A sample request is: curl -X GET --header 'Accept: application/json' --header 'Authorization: Token ead605f1928a7a388e47ea7ebb711e800c39522b' 'https://idx.realtyfeed.com/api/mls/sandbox/mlg_demo/search?status=Active'

The filter parameters

No

Field name

type

description

example

1

min_updated_at

DateTime

When property update greater than given time.

min_updated_at=2019-12-10 or min_updated_at=2020-02-01 13:15:11

2

max_updated_at

DateTime

When property update less than given time.

max_updated_at=2019-12-10 or max_updated_at=2020-02-01 13:15:11

3

country

String

Country ISO code

country=CA or country=USA

4

state

String

Full name of state

state=Ontario

5

city

String

Full name of city

city=Toronto

6

street

String

Full name of street

street=Fairfield

7

agent_id

String

Id of real state agent

agent_id=281519716

8

office_id

String

Id of real state office

office_id=256010106

9

zipcode

String

Full Zip Code

zipcode=33523

10

office_name

String

Full name of office

office_name=Concordia Realty LLC

11

min_price

integer

When property price greater than given time

min_price=6200

12

max_price

integer

When property price less than given time

max_price=7200

13

office_name_contains

String

Part name of office

office_name_contains=LLC

14

city_contains

String

Part name of city

city_contains=On

15

state_contains

String

Part name of state

state_contains=On

16

city_in

List

List of cities (separated by comma ,)

city_in=ENGLEWOOD,DADE%20CITY,VENICE,LAKELAND

17

state_in

List

List of states (separated by comma ,)

state_in=HARBOURSIDE,SANDSPUR,DOVE%20MEADOW,ANDRIS

18

office_name_in

List

List of office names (separated by comma ,)

office_name_in=WAGNER%20REALTY,SAN%20ANN%20REALTY

19

property_type

String

Full text of property type

property_type=Residential%20Lease

20

property_type_in

List

List of property types (separated by comma ,)

property_type_in=Residential,Land

23

status

String

This status is different by each mls server (Active or A)

status=Active

24

status_in

List

List of statuses (separated by comma ,)

status_in=Active,Pending

note :

1- You can use multiple filters at same time : (?status=A&property_type_in=Condo%20Townhouse,Comm%20Element%20Condo,Co-Op%20Apt&min_updated_at=2020-02-01 13:15:11)

2- Each MLS server has a different dataset.

Ordering

By default, oldest records appear first. use orderby parameter + created_at / updated_at to override the default functionality.

Sample: ?status=Active&orderby=updated_at desc

...