API reference
Airbnb Stay Rating API
One stay's overall rating and review count with the category ratings (cleanliness, accuracy, communication, location, check-in, value).
Endpoint
GET/v1/airbnb/stay-ratinglive · proven6 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | The listing number (or pass url, the stay's page) | 6332745 |
url | no | The stay's page URL instead of an id | |
language | no | Language code for the site's text | |
currency | no | Three-letter currency code | |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/airbnb/stay-rating?id=6332745" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/airbnb/stay-rating?id=6332745",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/airbnb/stay-rating?id=6332745",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "airbnb",
"endpoint": "/v1/airbnb/stay-rating",
"data": {
"_warnings": [],
"category_ratings": [
{
"label": "example",
"rating": 0,
"share": 0
}
],
"id": "example",
"platform": "example",
"rating": 0,
"rating_distribution": [],
"reviews": 0,
"type": "example",
"url": "https://example.com/example"
},
"credits_used": 6,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
_warnings | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
category_ratings | array | null | Optional category ratings supplied by this operation. Null means unknown. |
category_ratings[].label | string | null | Optional label supplied by this operation. Null means unknown. |
category_ratings[].rating | number | null | Source rating; read its accompanying scale and vote count. |
category_ratings[].share | number | null | Optional share supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
rating | number | null | Source rating; read its accompanying scale and vote count. |
rating_distribution | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
reviews | number | null | Optional reviews supplied by this operation. Null means unknown. |
type | string | null | Optional type supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference