IMS API Documentation

curl -X POST https://ims-api.restats.com/authorization/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=api" \
  -d "grant_type=client_credentials"

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "token_type": "Bearer",
  "expires_in": 9000,
  "scope": "api"
}

Authorization: Bearer YOUR_ACCESS_TOKEN

GET /v1/{resource}?$filter={filter}&$select={fields}&$top={limit} HTTP/1.1
Host: ims-api.restats.com
Authorization: Bearer YOUR_ACCESS_TOKEN

curl -X GET "https://ims-api.restats.com/v1/MlsCatalog?\$search=Aiken" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "count": 1,
  "value": [
    {
      "MlsKey": 572,
      "MlsCatalogId": 572,
      "MlsName": "UnlockMLS - Austin Board of Realtors",
      "MlsShortCode": "ABOR",
      "City": "Austin",
      "State": "TX",
      "Database": "AUSTIN TX",
      "Mapped": true
    }
  ]
}

{
  "FirstName": "Jane",
  "LastName": "Avery",
  "OfficeName": "Avery Realty Group",
  "OfficeAddress": "100 Congress Ave",
  "City": "Austin",
  "StateCode": "TX",
  "EthicsAccepted": true,
  "credentials": [
    {
      "MlsName": "UnlockMLS - Austin Board of Realtors",
      "MlsId": "ABOR-44821",
      "MlsWebAddress": "https://matrix.abor.com",
      "Username": "javery",
      "Password": "...",
      "mls": { "MlsKey": 572 }
    }
  ]
}

{
  "SubmissionId": "sub_aabbccddee11",
  "SubmittedAt": 1791140559495,
  "BrokerMatchedExisting": false,
  "Requests": [
    {
      "Mls": "UnlockMLS - Austin Board of Realtors",
      "Database": "AUSTIN TX",
      "Status": "auto_approved",
      "Reason": null
    }
  ]
}

curl -X GET "https://ims-api.restats.com/v1/Credentials?\$status=pending" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "count": 1,
  "value": [
    {
      "RequestId": "apr_6f5e4d3c2b1a",
      "SubmissionId": "sub_1122334455aa",
      "Mls": "UnlockMLS - Austin Board of Realtors",
      "MlsKey": 572,
      "Database": "AUSTIN TX",
      "Status": "Pending",
      "Detail": "Awaiting approval. Your credentials have been received and this database is pending activation on your subscription.",
      "ActionRequired": false,
      "RequestedAt": 1791237100563,
      "DecidedAt": null
    }
  ]
}

{
  "RequestId": "apr_1a2b3c4d5e6f",
  "Mls": "UnlockMLS - Austin Board of Realtors",
  "Database": "AUSTIN TX",
  "Status": "Approved",
  "Detail": null,
  "ActionRequired": false,
  "Result": {
    "Outcome": "Approved",
    "DecidedAt": 1791331751000,
    "Database": "AUSTIN TX",
    "DataFrom": "2024-01-01",
    "DataUntil": null,
    "Note": null
  }
}

curl -X GET "https://ims-api.restats.com/v1/Credentials?\$requestId=apr_1a2b3c4d5e6f" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

curl -X GET "https://ims-api.restats.com/v1/Subscription" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "count": 2,
  "ExpectedThrough": "2026-09",
  "DateField": "CloseDate",
  "value": [
    {
      "Database": "GREENVILLE SC",
      "Active": true,
      "Brokers": 2,
      "DataFrom": "2021-01-01",
      "DataUntil": null,
      "LatestData": "2026-09-30",
      "UpToDate": true,
      "MonthsBehind": 0,
      "CheckedAt": 1791237100563
    },
    {
      "Database": "TWIN CITIES MN",
      "Active": true,
      "Brokers": 3,
      "DataFrom": null,
      "DataUntil": null,
      "LatestData": "2026-07-31",
      "UpToDate": false,
      "MonthsBehind": 2,
      "CheckedAt": 1791237100563
    }
  ]
}

curl -X GET "https://ims-api.restats.com/v1/Users" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "count": 2,
  "value": [
    {
      "UserId": "apu_7c1d4e9a2b",
      "Name": "Jane Brooks",
      "Office": "Brooks Realty",
      "Active": true,
      "Databases": 2,
      "DatabasesServing": 2,
      "AddedOn": "2026-10-05 19:15:02"
    },
    {
      "UserId": "apu_3f85b06c71",
      "Name": "Sam Ortiz",
      "Office": "Brooks Realty",
      "Active": false,
      "Databases": 1,
      "DatabasesServing": 0,
      "AddedOn": "2026-10-06 18:21:03"
    }
  ]
}

curl -X POST "https://ims-api.restats.com/v1/Users" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "UserId": "apu_7c1d4e9a2b",
    "Active": false
  }'

{
  "UserId": "apu_7c1d4e9a2b",
  "Active": false,
  "DatabasesStopped": ["TWIN CITIES MN"],
  "DatabasesStillAvailable": ["SOCAL CA"],
  "DatabasesServing": [],
  "DatabasesAwaitingReview": [],
  "RequestIds": []
}

{
  "UserId": "apu_7c1d4e9a2b",
  "Active": true,
  "DatabasesServing": ["SOCAL CA"],
  "DatabasesAwaitingReview": ["TWIN CITIES MN"],
  "DatabasesStopped": [],
  "DatabasesStillAvailable": [],
  "RequestIds": ["apr_1a2b3c4d5e6f"]
}

GET /v1/Property?$filter=OriginatingSystemName eq 'TRREB' and ListPrice gt 500000

$filter=OriginatingSystemName eq 'TRREB' and ListPrice gt 500000

$filter=OriginatingSystemName eq 'TRREB' and ListPrice gt 300000 and ListPrice lt 800000 and CloseDate ge '2024 -01-01'

$filter=OriginatingSystemName eq 'TRREB' and (ListPrice gt 500000 or ClosePrice gt 600000)

$select=ListingId,ListPrice,UnparsedAddress,CloseDate

$orderby=ListPrice desc

$orderby=CloseDate desc,ListPrice asc

$top=50

$top=100&$skip=100

GET /v1/Property?$filter=OriginatingSystemName eq 'TRREB' and ListPrice gt 400000 and ListPrice lt 600000&$select=ListingId,ListPrice,UnparsedAddress&$orderby=ListPrice desc&$top=50&$skip=0

# Step 1: Get access token
TOKEN_RESPONSE=$(curl -s -X POST https://ims-api.restats.com/authorization/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=api" \
  -d "grant_type=client_credentials")

# Extract token
ACCESS_TOKEN=$(echo $TOKEN_RESPONSE | grep -o '"access_token":"[^"]*' | cut -d'"' -f4)

# Step 2: Query properties
curl -X GET "https://ims-api.restats.com/v1/Property?\$filter=OriginatingSystemName eq 'TRREB' and ListPrice gt 500000&\$top=10" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

# Configuration
BASE_URL = "https://ims-api.restats.com"
CLIENT_ID = "YOUR_CLIENT_ID"
CLIENT_SECRET = "YOUR_CLIENT_SECRET"

# Step 1: Get access token
token_response = requests.post(
    f"{BASE_URL}/authorization/token",
    data={
        "client_id": CLIENT_ID,
        "client_secret": CLIENT_SECRET,
        "scope": "api",
        "grant_type": "client_credentials"
    }
)

if token_response.status_code == 200:
    access_token = token_response.json()["access_token"]

    # Step 2: Query properties
    headers = {"Authorization": f"Bearer {access_token}"}
    params = {
        "$filter": "OriginatingSystemName eq 'TRREB' and ListPrice gt 500000",
        "$select": "ListingId,ListPrice,UnparsedAddress,ListOfficeEmail,BuyerOfficeEmail",
        "$top": 10
    }

    data_response = requests.get(
        f"{BASE_URL}/v1/Property",
        headers=headers,
        params=params
    )

    if data_response.status_code == 200:
        properties = data_response.json()["value"]
        print(f"Found {len(properties)} properties")
        for prop in properties:
            print(f"  {prop['ListingId']}: ${prop['ListPrice']:,.0f} - {prop['UnparsedAddress']}")
    else:
        print(f"Error: {data_response.status_code} - {data_response.text}")
else:
    print(f"Authentication failed: {token_response.status_code}")

const fetch = require('node-fetch');

// Configuration
const BASE_URL = 'https://ims-api.restats.com';
const CLIENT_ID = 'YOUR_CLIENT_ID';
const CLIENT_SECRET = 'YOUR_CLIENT_SECRET';

async function getIMSData() {
    try {
        // Step 1: Get access token
        const tokenResponse = await fetch(`${BASE_URL}/authorization/token`, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/x-www-form-urlencoded'
            },
            body: new URLSearchParams({
                client_id: CLIENT_ID,
                client_secret: CLIENT_SECRET,
                scope: 'api',
                grant_type: 'client_credentials'
            })
        });

        if (!tokenResponse.ok) {
            throw new Error(`Authentication failed: ${tokenResponse.status}`);
        }

        const { access_token } = await tokenResponse.json();

        // Step 2: Query properties
        const params = new URLSearchParams({
            '$filter': "OriginatingSystemName eq 'TRREB' and ListPrice gt 500000",
            '$select': 'ListingId,ListPrice,UnparsedAddress,ListOfficeEmail',
            '$top': '10'
        });

        const dataResponse = await fetch(
            `${BASE_URL}/v1/Property?${params}`,
            {
                headers: {
                    'Authorization': `Bearer ${access_token}`
                }
            }
        );

        if (!dataResponse.ok) {
            throw new Error(`Data request failed: ${dataResponse.status}`);
        }

        const data = await dataResponse.json();
        console.log(`Found ${data.value.length} properties`);
        data.value.forEach(prop => {
            console.log(`  ${prop.ListingId}: $${prop.ListPrice.toLocaleString()} - ${prop.UnparsedAddress}`);
        });

    } catch (error) {
        console.error('Error:', error.message);
    }
}

getIMSData();

 $clientId,
    'client_secret' => $clientSecret,
    'scope' => 'api',
    'grant_type' => 'client_credentials'
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$tokenResponse = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode == 200) {
    $tokenData = json_decode($tokenResponse, true);
    $accessToken = $tokenData['access_token'];

    // Step 2: Query properties
    $filterQuery = http_build_query([
        '$filter' => "OriginatingSystemName eq 'TRREB' and ListPrice gt 500000",
        '$select' => 'ListingId,ListPrice,UnparsedAddress',
        '$top' => '10'
    ]);

    $ch = curl_init($baseUrl . '/v1/Property?' . $filterQuery);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer ' . $accessToken
    ]);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $dataResponse = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($httpCode == 200) {
        $data = json_decode($dataResponse, true);
        echo "Found " . count($data['value']) . " properties\n";
        foreach ($data['value'] as $prop) {
            echo "  {$prop['ListingId']}: \${$prop['ListPrice']} - {$prop['UnparsedAddress']}\n";
        }
    } else {
        echo "Data request failed: HTTP $httpCode\n";
    }
} else {
    echo "Authentication failed: HTTP $httpCode\n";
}

?>

{
  "value": [
    {
      "ListingId": "C123456",
      "UnparsedAddress": "123 Main Street, Toronto, ON",
      "ListPrice": 599000.00,
      "ClosePrice": 595000.00,
      "CloseDate": "2024-01-15",
      "ListAgentMlsId": "AG12345",
      "BuyerAgentMlsId": "AG67890",
      "ListOfficeMlsId": "OF111",
      "BuyerOfficeMlsId": "OF222",
      "ListOfficeEmail": "listings@realestate-office.com",
      "BuyerOfficeEmail": "buyers@realty-group.com",
      "ModificationTimestamp": "2024-01-20T15:30:00"
    },
    {
      "ListingId": "C123457",
      "UnparsedAddress": "456 Oak Avenue, Toronto, ON",
      "ListPrice": 725000.00,
      "ClosePrice": 720000.00,
      "CloseDate": "2024-01-18",
      "ListAgentMlsId": "AG23456",
      "BuyerAgentMlsId": "AG78901",
      "ListOfficeMlsId": "OF333",
      "BuyerOfficeMlsId": "OF444",
      "ListOfficeEmail": "list@torontorealty.com",
      "BuyerOfficeEmail": "contact@buyersagency.com",
      "ModificationTimestamp": "2024-01-21T10:15:00"
    }
  ]
}

{
  "error": {
    "code": 401,
    "message": "OriginatingSystemName must be sent"
  }
}

{
  "error": "Bearer Token is missing"
}

{
  "error": "Invalid credentials"
}

{
  "error": {
    "code": 401,
    "message": "OriginatingSystemName must be sent"
  }
}

{
  "error": {
    "code": 401,
    "message": "Column InvalidFieldName is not allowed."
  }
}

{
  "error": "$top value can not exceed 5000"
}

{
  "error": "Resource can not be found"
}

{
  "error": "Rate limit exceeded: 1050/1000 requests per hour",
  "retry_after": 3600
}

$select=ListingId,ListPrice,UnparsedAddress

page_size = 100
page = 1
skip = (page - 1) * page_size

params = {
    '$filter': "OriginatingSystemName eq 'TRREB'",
    '$top': page_size,
    '$skip': skip
}

import time

def make_request_with_retry(url, headers, max_retries=3):
    for attempt in range(max_retries):
        response = requests.get(url, headers=headers)

        if response.status_code == 200:
            return response.json()
        elif response.status_code == 429:  # Rate limit
            retry_after = int(response.headers.get('Retry-After', 60))
            time.sleep(retry_after)
        else:
            print(f"Error: {response.status_code}")
            break

    return None

$filter=OriginatingSystemName eq 'TRREB' and ModificationTimestamp ge '2024-01-01T00:00:00'
$orderby=ModificationTimestamp asc