API Endpoints
Complete reference for all ScraperCompany API endpoints.
Base URL: https://api.scrapercompany.com
Auth Header: x-api-key: YOUR_API_KEY
Discovery
/v1/searchFind a Google property token by hotel name and city. This is your starting point.
Request Body
{
"name": "Hilton Chicago",
"city": "Chicago",
"market": "US",
"limit": 5
}Response
{
"recommended_match": {
"token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
"name": "Hilton Chicago",
"name_score": 1.0
},
"search_status": "matched"
}Google SERP
/v1/calendarGet 90-night forward horizon in one ~30KB request. The cheapest endpoint by far.
Request Body
{
"token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
"days": 90,
"currency": "USD",
"market": "US",
"adults": 2
}/v1/stayGet rates for a specific check-in/check-out window.
/v1/offersGet per-OTA breakdown with room detail. Samples multi-MB pages (~5 credits).
/v1/roomsRoom types by OTA matrix, aligned by normalized signature.
Airbnb
/v1/serp/airbnbAirbnb destination search with listings, prices, filters, and pagination.
Request Body
{
"q": "Toronto",
"airbnb_domain": "airbnb.ca",
"currency": "CAD",
"check_in_date": "2026-09-10",
"check_out_date": "2026-09-12",
"adults": 2
}OTA Direct
/v1/ota/booking/searchFind Booking.com pagename and country by hotel name and city.
/v1/ota/bookingGet 61-date calendar from Booking.com GraphQL in ~33KB. Requires browser-minted token.
Request Body
{
"pagename": "moxy-boston-downtown",
"country": "us",
"days": 365,
"currency": "USD"
}/v1/ota/hotels/searchFind Hotels.com numeric property ID by hotel name and city.
/v1/ota/hotelsGet Hotels.com rate for one stay date. Unlike Booking, no calendar endpoint (one call per date).
/v1/ota/agoda/searchFind Agoda numeric property ID by hotel name and city.
/v1/ota/agodaGet every Agoda room type with rate plans. No anti-bot gate, per-room ladder included (~0.3s).
/v1/ota/compareRun Booking, Hotels.com, and Agoda concurrently. Fail-soft per source.
/v1/ota/sourcesWhich OTA engines are available on this deployment, their call patterns, and browser requirements.
Official Site
/v1/officialFetch rates from the hotel's own booking engine. Engine is auto-detected (29+ extractors).
Request Body
{
"url": "https://bookings.example.com/hotel",
"check_in": "2026-09-14",
"nights": 1
}/v1/official/enginesList of official-site booking engines that can be extracted, their detection patterns, and cost per query.
Storage & Usage
/v1/rates/storedQuery stored rates by property/date with freshness metadata. Reads from PostgreSQL, does not scrape.
/v1/storage/statusDatabase and R2 archive health: safe table counts, retention windows, operational status.
/v1/usageRequest counts, errors, bytes, and latency aggregated by endpoint and day.
/v1/requestsFilterable request ledger with forward/back paging. Credential-safe, sanitized params only.
/v1/requests/{request_id}Detailed metadata for one request by its opaque ID (returned in x-request-id header).
Async Jobs
/v1/jobsSubmit a durable, idempotent batch of up to 50 calendar requests. PostgreSQL-backed queue with optional webhook.
Request Body
{
"items": [
{
"token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
"label": "Competitor A",
"days": 90,
"currency": "USD"
}
],
"priority": 5,
"callback_url": "https://example.com/webhooks/scrapingme"
}/v1/jobs/{job_id}Poll job status. Once succeeded/partial/failed, results are available.
Common Parameters
Most endpoints accept these common parameters:
token— Google property token from /v1/searchcurrency— ISO 4217 code (USD, EUR, GBP, etc.)market— Market/country (US, MX, AU, GB, etc.)adults— Occupancy (1-8)check_in— Date in YYYY-MM-DD formatnightsorcheck_out— Length of stay
Response Format
All endpoints return consistent JSON envelopes with meta, search_parameters, and provenance fields.
Full API Specification: Download our OpenAPI 3.0 spec for complete schemas and examples.