Bridge Interactive API Reference

Quick reference for working with Bridge/RESO Web API (OData).

Base URL

https://api.bridgedataoutput.com/api/v2/OData/{dataset_id}/

Common datasets:

test — Sandbox/test data
Your actual dataset ID (provided by Bridge)

Authentication

Pass token as query parameter:

?access_token=YOUR_TOKEN

Or as header:

Authorization: Bearer YOUR_TOKEN

Common Endpoints

Resource	Path	Description
Property	`/Property`	Listings
Media	`/Media`	Photos (or expand with Property)
Member	`/Member`	Agents
Office	`/Office`	Brokerages
OpenHouse	`/OpenHouse`	Upcoming open houses

OData Query Parameters

Parameter	Description	Example
`$filter`	Filter results	`StandardStatus eq 'Active'`
`$select`	Choose fields	`ListingKey,ListPrice,City`
`$top`	Limit results (max 200)	`200`
`$skip`	Pagination offset	`200`
`$orderby`	Sort results	`ModificationTimestamp desc`
`$expand`	Include related data	`Media`
`$count`	Include total count	`true`

Filter Operators

Operator	Description	Example
`eq`	Equals	`City eq 'Miami'`
`ne`	Not equals	`Status ne 'Closed'`
`gt`	Greater than	`ListPrice gt 500000`
`ge`	Greater than or equal	`Bedrooms ge 3`
`lt`	Less than	`ListPrice lt 1000000`
`le`	Less than or equal	`YearBuilt le 2020`
`and`	Logical AND	`City eq 'Miami' and Bedrooms ge 2`
`or`	Logical OR	`City eq 'Miami' or City eq 'Miami Beach'`
`contains()`	String contains	`contains(City, 'Miami')`

Date/Time Filters

ISO 8601 format for timestamps:

ModificationTimestamp gt 2024-01-15T00:00:00Z

Example Queries

Get Active Listings

/Property?$filter=StandardStatus eq 'Active'&$top=200

Incremental Sync (modified after timestamp)

/Property?$filter=ModificationTimestamp gt 2024-01-15T12:00:00Z&$orderby=ModificationTimestamp asc&$top=200

With Media Expanded

/Property?$expand=Media&$top=200

Specific Fields Only

/Property?$select=ListingKey,ListPrice,City,BedroomsTotal&$top=200

Count Total

/Property?$count=true&$top=1

Response Structure

{
  "@odata.context": "...",
  "@odata.count": 2847,
  "@odata.nextLink": "https://api.bridgedataoutput.com/api/v2/OData/test/Property?$skip=200",
  "value": [
    {
      "ListingKey": "123456",
      "ListingId": "A123456",
      "StandardStatus": "Active",
      "ModificationTimestamp": "2024-01-15T14:30:00Z",
      "PropertyType": "Condominium",
      "ListPrice": 750000,
      "BedroomsTotal": 2,
      "BathroomsTotalInteger": 2,
      "LivingArea": 1250,
      "City": "Miami Beach",
      "StateOrProvince": "FL",
      "PostalCode": "33139",
      "UnparsedAddress": "123 Ocean Dr #4A",
      "SubdivisionName": "South Beach",
      "BuildingName": "The Ocean Tower",
      "Latitude": 25.7617,
      "Longitude": -80.1918,
      "PublicRemarks": "Stunning ocean view...",
      "Media": [
        {
          "MediaKey": "m123",
          "MediaURL": "https://...",
          "Order": 1,
          "MediaCategory": "Photo"
        }
      ]
    }
  ]
}

Common RESO Fields

Core Identifiers

RESO Field	Description
`ListingKey`	Primary key (unique across system)
`ListingId`	MLS number (user-facing)
`StandardStatus`	Active, Pending, Closed, etc.
`ModificationTimestamp`	Last modified (for sync)
`OriginalEntryTimestamp`	First listed

Property Details

RESO Field	Description
`PropertyType`	Condominium, Single Family, etc.
`PropertySubType`	More specific type
`BedroomsTotal`	Bedroom count
`BathroomsTotalInteger`	Bathroom count (integer)
`BathroomsFull`	Full bathrooms
`BathroomsHalf`	Half bathrooms
`LivingArea`	Square footage
`LotSizeSquareFeet`	Lot size
`YearBuilt`	Year constructed

Pricing

RESO Field	Description
`ListPrice`	Current asking price
`ClosePrice`	Final sale price (if closed)
`OriginalListPrice`	Initial list price
`PricePerSquareFoot`	Calculated $/sqft

Location

RESO Field	Description
`UnparsedAddress`	Full address string
`StreetNumber`	Street number
`StreetName`	Street name
`UnitNumber`	Apt/unit number
`City`	City name
`StateOrProvince`	State code
`PostalCode`	ZIP code
`CountyOrParish`	County
`SubdivisionName`	Neighborhood
`BuildingName`	Condo/building name
`Latitude`	GPS latitude
`Longitude`	GPS longitude

Description

RESO Field	Description
`PublicRemarks`	Marketing description
`PrivateRemarks`	Agent-only notes (not public!)
`Directions`	Driving directions

Dates

RESO Field	Description
`ListingContractDate`	Date listing agreement signed
`OnMarketDate`	Date went active
`CloseDate`	Sale closing date
`ExpirationDate`	Listing expiration

Agent/Office

RESO Field	Description
`ListAgentKey`	Listing agent ID
`ListAgentFullName`	Agent name
`ListOfficeName`	Brokerage name
`BuyerAgentKey`	Buyer agent (if closed)

Pagination Strategy

Bridge limits to 200 results per request.

Using `$skip`

let skip = 0;
let hasMore = true;

while (hasMore) {
  const response = await fetch(`${baseUrl}/Property?$top=200&$skip=${skip}`);
  const data = await response.json();

  // Process data.value

  hasMore = data.value.length === 200;
  skip += 200;
}

Using `@odata.nextLink`

let url = `${baseUrl}/Property?$top=200`;

while (url) {
  const response = await fetch(url);
  const data = await response.json();

  // Process data.value

  url = data['@odata.nextLink'] || null;
}

Rate Limits

Check your Bridge subscription for specific limits
Generally safe: 1-2 requests/second for bulk operations
Add delay between pages: await sleep(100)

Error Handling

Common Errors

Status	Meaning	Action
401	Invalid token	Check token, refresh if OAuth
403	Access denied	Check dataset permissions
404	Resource not found	Check dataset ID
429	Rate limited	Back off, retry with delay
500	Server error	Retry with backoff

Retry Strategy

async function fetchWithRetry(url, maxRetries = 3) {
  for (let attempt = 1; attempt <= maxRetries; attempt++) {
    try {
      const response = await fetch(url);

      if (response.status === 429) {
        // Rate limited - wait and retry
        await sleep(1000 * attempt);
        continue;
      }

      if (!response.ok) {
        throw new Error(`HTTP ${response.status}`);
      }

      return await response.json();
    } catch (error) {
      if (attempt === maxRetries) throw error;
      await sleep(1000 * Math.pow(2, attempt - 1));
    }
  }
}

Testing Connection

Quick test to verify credentials:

GET /Property?$top=1&$count=true

Success response includes @odata.count with total listings.

Bridge API Reference