API reference
Every endpoint, generated from the OpenAPI spec: parameters, examples, responses and errors.
All endpoints live under https://api.scrapercompany.com, take and return JSON, and authenticate with the x-api-key header. Each page lists parameters, a copy-paste example in cURL, Python and Node.js, a real response with field descriptions, and the errors that endpoint can return. The pages are generated from the OpenAPI document (openapi.json · openapi.yaml), so they always match it. To browse by site instead, with what each one is best for, see Data sources.
Any website
Web scraping
Any public web page as HTML, markdown or text, with JavaScript rendering, screenshots and automatic retries on blocks.
Screenshots
Any public web page as a PNG, JPEG or WebP image: the viewport, the full page or one element, at the size and pixel ratio you choose.
Internet Archive
archive.org items with their files, and Wayback Machine snapshots of any URL.
- POST
/v1/archive/searchInternet Archive searchSearch archive.org books, movies, audio, software and more2 credits - POST
/v1/archive/itemInternet Archive itemOne archive.org item, optionally with download links2 credits - POST
/v1/archive/waybackWayback Machine snapshotsWayback Machine snapshots of one URL2 credits
Hotels
Discovery
Turn a hotel name into the property token the Google endpoints use.
Google Hotels
Destination search, nightly calendars, stay prices, per-seller offers and room types.
- POST
/v1/calendarCalendarPrice a forward horizon in one call8+ credits - POST
/v1/stayStayPrice one explicit stay window5 credits - POST
/v1/offersOffersPer-OTA offers for one night10+ credits - POST
/v1/roomsRoom matrixRoom types by OTA, aligned on one signature5 credits - POST
/v1/hotels/searchDestination searchSearch a destination for hotels and prices4 credits
Property lookup
Confirm a property by its mailing address before targeting it.
Official site
The hotel's own booking engine, 50+ engines supported.
Cross-source
Rate parity across OTAs and the source capability matrix.
Guest reviews
Guest reviews from Tripadvisor, Booking.com, Expedia, Hotels.com, Google Hotels, Agoda, Airbnb, Vrbo and Trip.com, with provenance per page.
- POST
/v1/hotels/reviewsGoogle Hotels reviewsGuest reviews, aggregated by provider2+ credits - POST
/v1/ota/expedia/reviewsExpedia reviewsGuest reviews for one property, newest first2 credits - POST
/v1/ota/hotels/reviewsHotels.com reviewsGuest reviews for one property, newest first2 credits - POST
/v1/ota/tripadvisor/reviewsTripadvisor reviewsGuest reviews, newest first as the site orders them1 credit - POST
/v1/ota/booking/reviewsBooking.com reviewsGuest reviews for one property2 credits - POST
/v1/ota/agoda/reviewsAgoda reviewsGuest reviews: Agoda's own and Booking.com-sourced2 credits - POST
/v1/ota/airbnb/reviewsAirbnb reviewsListing reviews with the host's replies2 credits - POST
/v1/ota/vrbo/reviewsVrbo reviewsGuest reviews with the owner's replies2 credits - POST
/v1/ota/tripcom/reviewsTrip.com reviewsGuest reviews with the hotel's replies2 credits
SERP-compatible
Drop-in Google Hotels search, property and calendar shapes.
- POST
/v1/serp/google_hotelsGoogle Hotels search (SERP-compatible)google_hotels destination search, drop-in4 credits - GET
/api/v1/searchAirbnb search (GET)SERP API GET drop-in: airbnb, google_autocomplete, google_images, google_videos12 credits - POST
/v1/serp/google_hotels_propertyGoogle Hotels property (SERP-compatible)google_hotels_property, drop-in5 credits - POST
/v1/serp/google_hotels_calendarGoogle Hotels calendar (SERP-compatible)Horizon sweep in the standard SERP API parameter style8 credits
Online travel agencies
Booking.com
Name search, calendar and rooms from Booking.com.
- POST
/v1/ota/booking/searchBooking.com searchFind a Booking.com slug by hotel name4 credits - POST
/v1/ota/booking/hotelsBooking.com destination searchSearch a destination for properties and prices4 credits - POST
/v1/ota/bookingBooking.com calendarPrice calendar — 61 dates per call12 credits - POST
/v1/ota/booking/roomsBooking.com roomsRoom types and rate plans12 credits
Expedia
Name search, then rooms and rate plans for one stay from Expedia.
Hotels.com
Name search, prices and rooms from Hotels.com.
Agoda
Name search and rooms from Agoda.
Tripadvisor
Metasearch offers, place search and details for hotels, restaurants and attractions on Tripadvisor.
Trivago
Every partner's deal Trivago shows for one hotel and stay.
ZenHotels
Rooms and rates for one stay from ZenHotels, with the taxes paid at the hotel listed apart.
lastminute.com
Find a hotel id by name, then one hotel's headline price for a stay on lastminute.com, in GBP.
Hostelworld
Dorms and private rooms from Hostelworld.
Japan and Korea
Rakuten Travel
Find a hotel number by name, then room types and plans for one stay from Rakuten Travel, in JPY.
Jalan
Find a hotel number by name, then plans and rooms for one stay from Jalan, in JPY.
Ikyu
Find a hotel number by name, then rooms and plans for one stay from Ikyu, in JPY.
Yahoo! Travel
Find a hotel number by name, then rooms and plans for one stay from Yahoo! Travel (Japan), in JPY.
NOL (Yanolja)
Find a stay id by name, then rooms and rate plans for one stay at a Korean property on NOL (Yanolja), in KRW.
Rentals, flights and cars
Airbnb
Vacation-rental search in the standard SERP API shape, and a day-by-day calendar with quoted prices.
- POST
/v1/serp/airbnbAirbnb searchAirbnb search, SERP-compatible12 credits - POST
/v1/airbnb/calendarAirbnb priced calendarPriced Airbnb nightly calendar12+ credits - POST
/v1/serp/airbnb_property_availability_calendarAirbnb availability calendar (SERP-compatible)Airbnb availability calendar, SERP-compatible, with prices12+ credits
Vrbo
Vacation-rental search and stay quotes from Vrbo.
Google Flights
Itineraries, return and multi-city legs, booking options, airport lookup and date-grid fares, in the standard SERP API shape.
- POST
/v1/serp/google_flightsGoogle Flights searchGoogle Flights search for itineraries4 credits - POST
/v1/serp/google_flights_returnReturn and next-leg flightsGoogle Flights return or next-leg options4 credits - POST
/v1/serp/google_flights_bookingFlight booking optionsGoogle Flights booking options for an itinerary5 credits - POST
/v1/serp/google_flights_location_searchFlight location searchResolve a city or airport to IATA codes2 credits - POST
/v1/serp/google_flights_calendarGoogle Flights calendarGoogle Flights date-grid pricing6 credits
Car rental
Car-rental offers for one pick-up place and rental window from DiscoverCars and Sixt, and their place and branch lookups.
- POST
/v1/cars/discovercarsDiscoverCars car rentalDiscoverCars: every supplier's offer for one rental10 credits - POST
/v1/cars/sixtSixt car rentalSixt: every offer at one branch for one rental4 credits - POST
/v1/cars/discovercars/locationsDiscoverCars place lookupDiscoverCars: find place ids by name1 credit - POST
/v1/cars/sixt/locationsSixt branch lookupSixt: find branch ids by name1 credit
Vehicles and aircraft
AutoTrader
US vehicles for sale by make, model and ZIP: up to 25 a page with VIN, price, mileage, specs and the dealer.
AutoScout24
European vehicles for sale: 20 a page with price, mileage, first registration and seller, and one listing in full with tax treatment, equipment and seller phones.
FAA aircraft
US aircraft registration and the last 180 days of FAA document receipts by N-number.
- POST
/v1/aircraft/registrationFAA aircraft registrationFAA aircraft registration by N-number2 credits - POST
/v1/aircraft/documentsFAA document receiptsFAA recent aircraft document-index receipts2 credits - POST
/v1/aircraft/recordsFAA registration and receiptsFAA registration plus recent document-index receipts4 credits - POST
/v1/aircraft/searchSearch the FAA aircraft registrySearch the FAA aircraft registry2 credits
Events and tickets
Events
A unified events search (`source` plus a plain city, dates and category) across Eventbrite, Luma, Resident Advisor, EventsEye tradeshows, Songkick, RunSignup races, sports schedules, Eventim, Bandsintown, Live Nation, DICE, AllEvents and university calendars, plus the per-provider routes and Eventbrite event detail.
- POST
/v1/events/searchEvents searchEvents from one provider, with a plain city2 credits - POST
/v1/events/eventbrite/searchEventbrite searchEventbrite events by city2 credits - POST
/v1/events/eventbrite/eventEventbrite eventEventbrite event detail2 credits - POST
/v1/events/luma/searchLuma searchLuma events by location2 credits - POST
/v1/events/residentadvisor/searchResident Advisor searchResident Advisor club nights and festivals2 credits - POST
/v1/events/tradeshows/searchEventsEye tradeshowsUpcoming trade fairs by country (EventsEye)2 credits - POST
/v1/events/songkick/searchSongkick searchSongkick concerts and festivals2 credits - POST
/v1/events/races/searchRunSignup racesRunSignup race calendar2 credits - POST
/v1/events/sports/scheduleSports scheduleSports schedule for one league-day1 credit - POST
/v1/events/eventim/searchEventim searchEventim events in one city (DE/AT/CH/NL)2 credits - POST
/v1/events/bandsintown/searchBandsintown searchBandsintown concerts by city2 credits - POST
/v1/events/livenation/searchLive Nation searchLive Nation events (AU/NZ/UK)1 credit - POST
/v1/events/dice/searchDICE searchDice events by city2 credits - POST
/v1/events/allevents/searchAllEvents searchAllEvents events by city2 credits - POST
/v1/events/university/calendarUniversity eventsUniversity academic calendar key dates2 credits
SeatGeek
Events by keyword and place, with live resale prices: lowest, median, average and highest, and listing and ticket counts.
Ticketmaster
Events by keyword: dates, venue, artists, category, status and on-sale date. No ticket prices.
StubHub
Events by keyword: date, venue and whether tickets are listed. No ticket prices.
Facebook Events
Public events from a Facebook listing page, and one event in full: schedule, venue, attendance, description, hosts and ticket link.
Maritime
MarineTraffic
Live AIS vessel positions in the one MarineTraffic map tile that contains a point.
CruiseMapper
Cruise itineraries, ship details, live positions and port information.
- POST
/v1/cruisemapper/cruisesCruiseMapper cruisesCruise search by region, port, ship, line, length and month2 credits - POST
/v1/cruisemapper/shipCruiseMapper shipOne cruise ship: specs, live position and cruises3 credits - POST
/v1/cruisemapper/positionsCruiseMapper positionsLive positions of tracked cruise ships2 credits - POST
/v1/cruisemapper/portCruiseMapper portA cruise port's ship calls for one month2 credits
Trade and suppliers
1688
China wholesale marketplace: product search and detail from 1688.com.
ImportYeti
US import records: company search, shipper profiles and HS code lookups.
- POST
/v1/importyeti/searchImportYeti searchFind US importers and their foreign suppliers by name or address2 credits - POST
/v1/importyeti/profileImportYeti profileA US importer's or foreign supplier's shipment profile5 credits - POST
/v1/importyeti/hs-codeImportYeti HS codeUS imports under one HS code: totals, origins, top importers and suppliers3 credits
ThomasNet
Industrial supplier search and company profiles from Thomasnet.com.
Datasets and weather
Datasets
Data we collect on a schedule: LLM token prices, RAM, Aldi and grocery prices, and a weather archive. Latest values, history, or the whole file.
- GET
/v1/datasetsList datasetsList the datasets we keep freshFree - GET
/v1/datasets/{name}One dataset and its columnsOne dataset: columns, freshness and a sampleFree - GET
/v1/datasets/{name}/latestLatest valuesCurrent value of every item in a dataset1 credit - GET
/v1/datasets/{name}/historyOne item's historyEvery recorded change for one item1 credit - GET
/v1/datasets/{name}/downloadDownload as SQLiteDownload the full dataset as a SQLite file500 credits
Weather
A free live forecast for any point on Earth: current conditions, hourly and daily.
Theme parks
Theme parks
Day-ticket prices for every visit date at 83 theme parks, water parks and zoos, with optional daily capacity and tickets sold.
Search, news and maps
Google Search
Organic results, People Also Ask and the AI Overview, rendered.
Bing
Organic results with trackers decoded to destination URLs.
Google News
Keyword search and section headlines from Google's own RSS wire.
Google Maps
Places search, place detail with review counts, and business leads with harvested emails.
Google Trends
Interest over time and top/rising related queries.
Autocomplete, Images and Videos
Search suggestions, image results and video results from Google.
Zalo
Public Zalo Official Accounts: name, verified flag, category, address and hours.
Retail and marketplaces
Amazon
Product search and a product's ratings histogram with featured reviews.
Walmart
Product search and reviews, with prices as the store shows them.
Target
Product search and product detail, priced at the store you name; find stores near a ZIP.
- POST
/v1/retail/target/searchTarget searchTarget search: one page of products priced at a store6 credits - POST
/v1/retail/target/storesTarget stores near a ZIPTarget stores near a ZIP: the store ids prices use1 credit - POST
/v1/retail/target/productTarget productOne Target product by TCIN, priced at a store3 credits
eBay
Search results on 8 eBay sites: price, bids, best offer, delivery, units sold and seller feedback.
Zalando
Fashion search on 8 Zalando sites: price shown, regular price and amount off.
Etsy
Etsy search: 48 listings a page with title, shop, price, currency and image.
Craigslist
Craigslist for-sale results in one city: up to about 350 in one call, with title, price in the local currency and neighbourhood.
Kijiji
Canadian classifieds from a Kijiji search URL: title, price in CAD, location, coordinates, image and posted time.
Karrot
Karrot second-hand search by region: 60 products a page with price, currency and image.
Idealo
Price comparison search and per-merchant offers from Idealo (DE, AT, FR, IT, ES, UK).
TCGplayer
Trading-card marketplace search with market price and supply, and one product's price per printing.
Google Shopping
Product cards with price, merchant and condition.
Shopify
Any public Shopify store's catalog, collections, search, stock, reviews, pages and blogs, and its published contacts.
- POST
/v1/retail/shopify/store/checkShopify store checkIs this a public Shopify store1 credit - POST
/v1/retail/shopify/storeShopify storeShopify store identity3 credits - POST
/v1/retail/shopify/store/profileShopify store profileShopify store profile and published contacts14 credits - POST
/v1/retail/shopify/productsShopify productsShopify products, one page3–9 credits - POST
/v1/retail/shopify/products/detailShopify productOne Shopify product2 credits - POST
/v1/retail/shopify/products/batchShopify products batchSeveral Shopify products2+ credits - POST
/v1/retail/shopify/products/searchShopify product searchSearch a Shopify catalog2 credits - POST
/v1/retail/shopify/products/on-saleShopify products on saleShopify products currently on sale3–9 credits - POST
/v1/retail/shopify/products/new-arrivalsShopify new arrivalsNewest Shopify products3–9 credits - POST
/v1/retail/shopify/products/best-sellersShopify best sellersBest-selling Shopify products3–9 credits - POST
/v1/retail/shopify/products/recommendationsShopify recommendationsProducts recommended alongside one product2 credits - POST
/v1/retail/shopify/products/inventoryShopify inventoryPublished stock for one Shopify product2 credits - POST
/v1/retail/shopify/products/reviewsShopify product reviewsReviews on a Shopify product9+ credits - POST
/v1/retail/shopify/collectionsShopify collectionsShopify collections4 credits - POST
/v1/retail/shopify/collections/productsShopify collection productsProducts in a Shopify collection3–9 credits - POST
/v1/retail/shopify/search/suggestionsShopify search suggestionsShopify search suggestions2 credits - POST
/v1/retail/shopify/store/sitemapShopify sitemapShopify store sitemap9 credits - POST
/v1/retail/shopify/store/catalog-statsShopify catalog statsShopify catalog counts9+ credits - POST
/v1/retail/shopify/pagesShopify pagesShopify pages3 credits - POST
/v1/retail/shopify/pages/detailShopify pageOne Shopify page3 credits - POST
/v1/retail/shopify/blogsShopify blogsShopify blogs3 credits - POST
/v1/retail/shopify/blogs/articlesShopify blog articlesArticles in a Shopify blog3 credits - POST
/v1/retail/shopify/blogs/articleShopify blog articleOne Shopify article3 credits
Jobs and hiring
LinkedIn Jobs
Job search cards and full postings from LinkedIn's public job pages.
Upwork
Job search and one job in full from Upwork's public job pages.
Indeed
Job records with salary, posting age and company ratings.
Google Jobs
Job cards with apply sources, rendered.
Company careers
Every open job behind a careers page, read from the company's own applicant-tracking system, plus board detection.
Property and reviews
StreetEasy
New York City rentals and sales by area: about 14 rentals or 38 sales a page, one listing, one building, and an agent profile with no email or phone.
- POST
/v1/streeteasy/searchStreetEasy rentals and salesStreetEasy NYC rentals or sales in one area2+ credits - POST
/v1/streeteasy/buildingStreetEasy buildingOne StreetEasy building's full record2 credits - POST
/v1/streeteasy/agentStreetEasy agentOne StreetEasy agent's published profile2 credits - POST
/v1/streeteasy/listingStreetEasy listingOne StreetEasy listing's full record2 credits
Zillow
US homes for sale by place name or Zillow search URL: about 40 a page with price, beds, baths, size, status and photo; and one listing in full, with HOA, description and photos.
Redfin
US and Canadian homes for sale by city, ZIP or neighborhood page: up to 350 a page with price, beds, baths, size, year built and MLS id; and one listing in full, with remarks, agents and photos.
Centris
Quebec homes for sale from Centris: 20 a page with price in CAD, type, address, beds and baths; and one listing in full, with its description and photos.
Rightmove
UK sale listings with asking price, bedrooms, type and coordinates.
Zoopla
UK property listings for sale or to rent, with price, bedrooms and coordinates.
OnTheMarket
UK property listings for sale or to rent from OnTheMarket.
Domain
Australian listings for sale or to rent from Domain.com.au, prices as displayed, and location lookup by place name.
Trustpilot
Reviews of a company by its domain, with the TrustScore.
G2
Reviews of a software product, with its aggregate rating.
Company research
SEC EDGAR
US company research from SEC filings: CIK lookup, filings, financials, insider trades, 13F holdings, full-text search and Form D raises.
- POST
/v1/sec/companiesSEC company lookupSEC: find a company's CIK by name or ticker1 credit - POST
/v1/sec/filingsSEC filingsSEC: a company's profile and recent filings1 credit - POST
/v1/sec/financialsSEC financialsSEC: revenue, profit, cash flow and balance sheet2 credits - POST
/v1/sec/insider_tradesInsider trades (Form 4)SEC: insider buys and sales (Form 4)4 credits - POST
/v1/sec/holdingsFund holdings (13F)SEC: an investment manager's 13F holdings4 credits - POST
/v1/sec/searchSEC full-text searchSEC: full-text search of filings2 credits - POST
/v1/sec/private_placementsPrivate raises (Form D)SEC: private raises from Form D filings4 credits
Earnings calendar
Every US-listed company reporting earnings on a day, with the EPS forecast.
Businesses for sale
Online businesses for sale or sold on Empire Flippers: price, revenue, profit and multiple.
Research papers
PubMed
PubMed search with full article records, and one article by PMID or link.
Apps and video
YouTube
Search, video metadata, transcripts, comments and channel pages, without a Data API quota.
- POST
/v1/youtube/searchYouTube searchYouTube search: videos, Shorts, channels, playlists2 credits - POST
/v1/youtube/videoYouTube videoOne YouTube video's metadata, counts and chapters2 credits - POST
/v1/youtube/transcriptYouTube transcriptA YouTube video's transcript as timed segments2 credits - POST
/v1/youtube/commentsYouTube commentsOne page of a YouTube video's comments or replies2 credits - POST
/v1/youtube/channelYouTube channelA YouTube channel's metadata and latest videos2 credits
TikTok
Public videos, profiles, search, hashtags and comments.
- POST
/v1/tiktok/videoTikTok videoOne TikTok video's metadata, counts and media2 credits - POST
/v1/tiktok/profileTikTok profileOne TikTok profile and its recent videos3 credits - POST
/v1/tiktok/searchTikTok searchTikTok search results for a query3 credits - POST
/v1/tiktok/hashtagTikTok hashtagOne hashtag's header and recent videos3 credits - POST
/v1/tiktok/commentsTikTok commentsOne TikTok video's comments3 credits
Google Play
App listings with the rating histogram, reviews and app search from the Play Store.
Apple App Store
App records with the per-star histogram, written reviews and app search from the App Store.
Platform
Jobs
Asynchronous calendar batches with webhooks.
Async jobs
Run any metered operation in the background: batches, signed webhooks, S3/GCS delivery and schedules.
- GET
/v1/async/operationsAsync operationsOperations an account can run asynchronouslyFree - GET
/v1/async/callback-secretGet the callback secretRead the account callback signing secretFree - POST
/v1/async/callback-secret/rotateRotate the callback secretRotate the account callback signing secretFree - POST
/v1/async/jobsSubmit an async jobSubmit an operation or a batch to run in the backgroundFree - GET
/v1/async/jobsList async jobsList this account's recent async jobsFree - GET
/v1/async/jobs/{job_id}Get an async jobPoll an async job and its per-item resultsFree - DELETE
/v1/async/jobs/{job_id}Cancel an async jobCancel a queued or running async jobFree - GET
/v1/async/destinationsList destinationsList saved S3/GCS destinationsFree - POST
/v1/async/destinationsCreate a destinationSave an S3 or GCS bucket for job deliveryFree - GET
/v1/async/destinations/{destination_id}Get a destinationRead a saved S3/GCS destinationFree - DELETE
/v1/async/destinations/{destination_id}Delete a destinationDelete a destinationFree - GET
/v1/async/schedulesList schedulesList async job schedulesFree - POST
/v1/async/schedulesCreate a scheduleSchedule a recurring async jobFree - GET
/v1/async/schedules/{schedule_id}Get a scheduleRead an async job scheduleFree - PUT
/v1/async/schedules/{schedule_id}Replace a scheduleReplace an async job scheduleFree - DELETE
/v1/async/schedules/{schedule_id}Delete a scheduleDelete an async job scheduleFree - POST
/v1/async/schedules/{schedule_id}/runRun a schedule nowRun a schedule nowFree
Stored rates
Read stored observations without calling a source.
Usage
Usage totals and request history for your key.
Billing
Plan, credit balance, ledger and the cost table.
Questions about this page?
Send the page link and your question, and the team will answer.