Get market alert | RealScout API documentation

Get market alert Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://bump.sh/realscout/doc/realscout-api/mcp

Standard setup for AI tools providing an mcp.json file

{
  "RealScout API MCP server": {
    "url": "https://bump.sh/realscout/doc/realscout-api/mcp"
  }
}

GET /market-alerts/{id}

Bearer auth

One market alert: who it is for, the area it covers, its price band and filters, how often it sends, and whether it is paused.

Requires the market_alerts:read scope. Rate budget: 300 calls per 1 minute per credential (the read class).

Path parameters

id string Required

The market alert id.

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- X-RateLimit-Limit integer
  
  Calls allowed in the current window.
- X-RateLimit-Remaining integer
  
  Calls left in the current window.
- X-RateLimit-Reset integer
  
  Epoch seconds at which the window resets.
Hide response attributes Show response attributes object
- id string Required
- name string | null Required
- contact object Required
  
  Hide contact attributes Show contact attributes object
  
  id string Required
  
  realscout_url string(uri) Required
- schedule string Required
  
  Values are BIWEEKLY, MONTHLY, QUARTERLY, or MANUAL.
- disabled boolean Required
- queued boolean Required
- price_min integer | null Required
- price_max integer | null Required
- beds_min integer | null Required
- beds_max integer | null Required
- baths_min number | null Required
- baths_max number | null Required
- sqft_min integer | null Required
- sqft_max integer | null Required
- property_types array[string] | null Required
  
  Values are APARTMENT, COMM, LAL, MF, MOBILE, OTHER, SFR, TC, TOWNHOUSE, CONDO, COOP, or CONDOP.
- last_sent_at string(date-time) | null Required
- next_send_at string(date-time) | null Required
- created_at string(date-time) | null Required
- updated_at string(date-time) | null Required
- realscout_url string(uri) | null Required
400 application/json

The request is invalid; field names the offending input when there is one. A body that is not valid JSON is refused before the API runs, as a bare 400 with no body.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
401 application/json

Invalid or missing bearer token.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
403 application/json

The credential was not granted the scope this call requires.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
404 application/json

Not found, or not yours: the two are indistinguishable on purpose.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
429 application/json

Rate limit exceeded; Retry-After says when to try again.
Hide headers attribute Show headers attribute
- Retry-After integer
  
  Seconds until the budget refills.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
500 application/json

Something went wrong on our side.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.

GET /market-alerts/{id}

curl -H "Authorization: Bearer rs_agent_..." https://www.realscout.com/api/agent/v1/market-alerts/TWFya2V0QWxlcnQtNzc=

Response examples (200)

{
  "id": "TWFya2V0QWxlcnQtNzc=",
  "name": "Palo Alto",
  "contact": {
    "id": "VXNlci0xMjM=",
    "realscout_url": "https://www.realscout.com/agent/contacts/VXNlci0xMjM="
  },
  "schedule": "MONTHLY",
  "disabled": false,
  "queued": false,
  "price_min": 500000,
  "price_max": 900000,
  "beds_min": 3,
  "beds_max": null,
  "baths_min": null,
  "baths_max": null,
  "sqft_min": null,
  "sqft_max": null,
  "property_types": [
    "SFR"
  ],
  "last_sent_at": "2026-08-01T12:00:00Z",
  "next_send_at": "2026-09-01T12:00:00Z",
  "created_at": "2026-06-01T17:00:00Z",
  "updated_at": "2026-08-01T12:00:00Z",
  "realscout_url": "https://www.realscout.com/agent/users/VXNlci0xMjM=/market-activity-alerts/TWFya2V0QWxlcnQtNzc="
}

Response examples (400)

{
  "error": {
    "code": "invalid_request",
    "message": "unknown is not a field this endpoint takes.",
    "field": "unknown",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (401)

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing credentials.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (403)

{
  "error": {
    "code": "missing_scope",
    "message": "This call requires the market_alerts:read scope, which this credential was not granted.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (404)

{
  "error": {
    "code": "not_found",
    "message": "No market alert with id TWFya2V0QWxlcnQtNzc= for this agent.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (429)

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Try again in 30 seconds.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (500)

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}