Request asynchronous read collection

curl --request POST \
  --url https://realtycrawl.dev/v1/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "operation": "listings.search",
  "params": {
    "platforms": [
      "<string>"
    ],
    "location": {
      "kind": "text",
      "query": "<string>",
      "country": "<string>"
    },
    "property_types": [
      "<string>"
    ],
    "status": [
      "<string>"
    ],
    "price": {
      "min": 123,
      "currency": "<string>",
      "max": 123,
      "unit_code": "<string>"
    },
    "bedrooms": {
      "min": 123,
      "max": 123
    },
    "bathrooms": {
      "min": 123,
      "max": 123
    },
    "listed_since": "2023-11-07T05:31:56Z",
    "include": [],
    "source_filters": {},
    "limit": 20,
    "cursor": "<string>",
    "allow_partial": false,
    "group_by_property": false
  },
  "max_items": 1
}
'

import requests

url = "https://realtycrawl.dev/v1/jobs"

payload = {
    "operation": "listings.search",
    "params": {
        "platforms": ["<string>"],
        "location": {
            "kind": "text",
            "query": "<string>",
            "country": "<string>"
        },
        "property_types": ["<string>"],
        "status": ["<string>"],
        "price": {
            "min": 123,
            "currency": "<string>",
            "max": 123,
            "unit_code": "<string>"
        },
        "bedrooms": {
            "min": 123,
            "max": 123
        },
        "bathrooms": {
            "min": 123,
            "max": 123
        },
        "listed_since": "2023-11-07T05:31:56Z",
        "include": [],
        "source_filters": {},
        "limit": 20,
        "cursor": "<string>",
        "allow_partial": False,
        "group_by_property": False
    },
    "max_items": 1
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operation: 'listings.search',
    params: {
      platforms: ['<string>'],
      location: {kind: 'text', query: '<string>', country: '<string>'},
      property_types: ['<string>'],
      status: ['<string>'],
      price: {min: 123, currency: '<string>', max: 123, unit_code: '<string>'},
      bedrooms: {min: 123, max: 123},
      bathrooms: {min: 123, max: 123},
      listed_since: '2023-11-07T05:31:56Z',
      include: [],
      source_filters: {},
      limit: 20,
      cursor: '<string>',
      allow_partial: false,
      group_by_property: false
    },
    max_items: 1
  })
};

fetch('https://realtycrawl.dev/v1/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "<string>",
    "operation": "listings.search",
    "status": "queued",
    "created_at": "2023-11-07T05:31:56Z",
    "result_count": 123,
    "sources": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "schema_version": "<string>",
    "generated_at": "2023-11-07T05:31:56Z",
    "completeness": "complete",
    "sources": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<string>",
        "field": "<string>"
      }
    ],
    "pagination": {
      "next_cursor": "<string>",
      "has_more": true,
      "returned": 123,
      "total": 123,
      "total_relation": "exact"
    },
    "property_groups": [
      {
        "property_id": "<string>",
        "listing_ids": [
          "<string>"
        ],
        "match_method": "<string>",
        "status": "matched",
        "confidence": 123
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "details": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "request_id": "<string>"
}

POST

jobs

Request asynchronous read collection

curl --request POST \
  --url https://realtycrawl.dev/v1/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "operation": "listings.search",
  "params": {
    "platforms": [
      "<string>"
    ],
    "location": {
      "kind": "text",
      "query": "<string>",
      "country": "<string>"
    },
    "property_types": [
      "<string>"
    ],
    "status": [
      "<string>"
    ],
    "price": {
      "min": 123,
      "currency": "<string>",
      "max": 123,
      "unit_code": "<string>"
    },
    "bedrooms": {
      "min": 123,
      "max": 123
    },
    "bathrooms": {
      "min": 123,
      "max": 123
    },
    "listed_since": "2023-11-07T05:31:56Z",
    "include": [],
    "source_filters": {},
    "limit": 20,
    "cursor": "<string>",
    "allow_partial": false,
    "group_by_property": false
  },
  "max_items": 1
}
'

import requests

url = "https://realtycrawl.dev/v1/jobs"

payload = {
    "operation": "listings.search",
    "params": {
        "platforms": ["<string>"],
        "location": {
            "kind": "text",
            "query": "<string>",
            "country": "<string>"
        },
        "property_types": ["<string>"],
        "status": ["<string>"],
        "price": {
            "min": 123,
            "currency": "<string>",
            "max": 123,
            "unit_code": "<string>"
        },
        "bedrooms": {
            "min": 123,
            "max": 123
        },
        "bathrooms": {
            "min": 123,
            "max": 123
        },
        "listed_since": "2023-11-07T05:31:56Z",
        "include": [],
        "source_filters": {},
        "limit": 20,
        "cursor": "<string>",
        "allow_partial": False,
        "group_by_property": False
    },
    "max_items": 1
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operation: 'listings.search',
    params: {
      platforms: ['<string>'],
      location: {kind: 'text', query: '<string>', country: '<string>'},
      property_types: ['<string>'],
      status: ['<string>'],
      price: {min: 123, currency: '<string>', max: 123, unit_code: '<string>'},
      bedrooms: {min: 123, max: 123},
      bathrooms: {min: 123, max: 123},
      listed_since: '2023-11-07T05:31:56Z',
      include: [],
      source_filters: {},
      limit: 20,
      cursor: '<string>',
      allow_partial: false,
      group_by_property: false
    },
    max_items: 1
  })
};

fetch('https://realtycrawl.dev/v1/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "<string>",
    "operation": "listings.search",
    "status": "queued",
    "created_at": "2023-11-07T05:31:56Z",
    "result_count": 123,
    "sources": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "schema_version": "<string>",
    "generated_at": "2023-11-07T05:31:56Z",
    "completeness": "complete",
    "sources": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<string>",
        "field": "<string>"
      }
    ],
    "pagination": {
      "next_cursor": "<string>",
      "has_more": true,
      "returned": 123,
      "total": 123,
      "total_relation": "exact"
    },
    "property_groups": [
      {
        "property_id": "<string>",
        "listing_ids": [
          "<string>"
        ],
        "match_method": "<string>",
        "status": "matched",
        "confidence": 123
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "details": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "request_id": "<string>"
}

Submit one durable source request for one Trulia Seattle sale listing or one Vrbo Orlando dated stay. Other platforms and bulk collection are unsupported. Check live capabilities before submission. Set max_items and params.limit to 1. Supply exactly one matching platform and the existing source selectors. Trulia uses transaction: "sale" and location: {kind: "source_region", platform: "trulia", country: "US", region_id: "seattle-wa"}. Vrbo uses region orlando-fl, future ISO check-in/out dates for 1–30 nights, two adults with no children/infants/pets, and currency USD. No partial results, cursor or extra source filters.

{
  "operation": "listings.search",
  "params": {
    "platforms": ["trulia"],
    "location": {"kind": "source_region", "platform": "trulia", "country": "US", "region_id": "seattle-wa"},
    "transaction": "sale",
    "limit": 1
  },
  "max_items": 1
}

The creating live key must allow createReadJob and the corresponding searchListings or searchStays operation. Use an Idempotency-Key and X-Max-Credits: 50. HTTP 202 returns a queued job and its status URL in the Location header. The50-credit source reservation is charged once and refunded if the job fails or expires; status/results cost 1 credit each. Replays are free and return the original snapshot, so a repeated creation does not refresh its status. Jobs are stored durably and dispatched once. A post-response worker starts promptly; the maintenance worker can dispatch queued work on its existing 10-minute schedule. There is no source retry after an unknown or failed dispatch. Queued work expires after 20 minutes; stalled work fails after 2 minutes and is reconciled on maintenance. At most three unfinished jobs per account. Status/results are private to the account and retained 24 hours from creation.

One source observation is not bulk inventory, a verified closed transaction, a booking quote or current availability. Trulia retains asking-price semantics; Vrbo preserves dated source price observations with unknown availability and fee completeness.

Fresh job status/result reads expire after 24 hours. The existing API idempotency-response cache lasts seven days and can replay an earlier response after that window. A replay preserves its original snapshot; it does not refresh status or execute a source again.

Authorizations

x-api-key

string

header

required

Body

application/json

Option 1
Option 2

One durable source request: Trulia Seattle sale listing or Vrbo Orlando dated stay. max_items and params.limit must both equal1. The creating key must also grant the corresponding underlying search. No continuation or automatic retry.

operation

any

required

params

object

required

Show child attributes

max_items

integer

required

Required range: 1 <= x <= 1

client_request_id

string

Maximum string length: 128

Response

Read job accepted

data

object

required

Show child attributes

Overview

Meta

Listings

Platform listings

Properties

Buildings

Developments

Agents

Agencies

Auctions

Markets

Stays

Locations

Jobs

Request asynchronous read collection

Authorizations

Body

Response