Skip to content
ScoutingAPI
Docs

Endpoint reference

Reviews

Normalized, paginated reviews for one listing.

GET/v1/reviews

Normalized, paginated reviews for one listing.

Creditsper review · min 5
Cache TTL24 hours
ReturnsReview[]
ShapePaginated

Live calls are asynchronous — you poll for the result

The sample response below is the synchronous shape you get from the sandbox (a stay_test_ key) and from live cache hits. A live (stay_live_) call that has to scrape returns HTTP 202 with a data.jobId instead of blocking. Poll GET /v1/jobs/{jobId} (always free) until data.status is completed, then read the payload below from data.result (not data); the reconstructed meta — credits, platformResults, warnings — sits at the top level. Jobs usually finish in tens of seconds but can run several minutes (240s+), so budget your wait. The @stayingapi/sdk auto-polls a 202 to completion and hands you this exact synchronous-looking envelope — the simplest way to consume the API. See the response envelope for all three shapes.

Normalized, paginated reviews for one listing on one platform. Native rating scales are preserved and echoed alongside each rating (TripAdvisor/Airbnb/Vrbo use 5; Booking.com/Expedia/Hotels.com use 10) — never silently rescaled.

Parameters

Request parameters
ParameterTypeRequiredDefaultNotes
platformenumYes—Platform enum.
listingIdstringOne of—Listing id on platform.
urlstringOne of—Full listing URL.
limitintegerNo201–100.
cursorstringNo—Opaque base64 cursor.
languagestringNo—ISO-639-1 filter.
minRatingnumberNo—On the response ratingScale.
sortenumNorecentrecent | rating_desc | rating_asc.

Request & response

/v1/reviews
Request
GET /v1/reviews?platform=booking&listingId=abramovic2&limit=20&sort=recent
Host: api.stayingapi.com
Authorization: Bearer stay_live_…
Response
{
  "data": [
    {
      "platform": "booking",
      "listingId": "abramovic2",
      "reviewId": "r987",
      "rating": 9, "ratingScale": 10,
      "title": "Perfect family stay",
      "text": "Spotless apartment a short walk from the old town…",
      "author": "Jane D.", "date": "2026-05-10", "tripType": "family",
      "language": "en", "ownerResponse": "Thank you!",
      "liked": "Location and cleanliness", "disliked": null
    }
  ],
  "meta": {
    "requestId": "req_rv…",
    "platforms": ["booking"],
    "cached": false, "partial": false,
    "creditsCharged": 20, "currency": "USD",
    "pagination": { "limit": 20, "cursor": null, "nextCursor": "eyJ…", "hasMore": true },
    "platformResults": [
      { "platform": "booking", "status": "ok", "creditsCharged": 20, "cached": false, "count": 20 }
    ],
    "warnings": []
  }
}

Code samples

The same call in every language that matters — all returning the identical unified schema.

curl -sS "https://api.stayingapi.com/v1/reviews?platform=booking&listingId=abramovic2&limit=20&sort=recent" \
  -H "Authorization: Bearer $STAYINGAPI_KEY"

Try it

Run this endpoint against the deterministic sandbox right now — a real 200, zero credits, no sign-up. The credit cost of the equivalent live call is per review · min 5.

Try itsandbox · 0 credits · no sign-up
GET/v1/reviews

Runs against the deterministic Booking sandbox fixture — a real 200, zero credits.

Response

Run the call to see a live, deterministic sandbox response.

Copy as curl
curl -sS "https://api.stayingapi.com/v1/reviews" \
  -H "Authorization: Bearer $STAYINGAPI_KEY"

Workflows using this

Ready-made automations built on /v1/reviews — an importable n8n workflow + a portable AI-agent skill each.