Documentation has been updated: see help center and changelog in one place.

Web Scraper API

Web Scraper API is an all-in-one web data collection platform. It covers every stage of web scraping, from crawling URLs and bypassing IP blocks to precise data parsing and delivery to your preferred cloud storage. Extract data from search engines, e-commerce sites, travel platforms, and any other website.

Getting started

Create your API user credentials: Sign up for a free trial or purchase the product in the Oxylabs dashboard to create your API user credentials (USERNAME and PASSWORD).

Request samples

Below, you'll find sample cURL requests. For examples in other programming languages, please refer to the relevant sections: Amazon, Google, Other Websites.

curl 'https://realtime.oxylabs.io/v1/queries' \
--user "USERNAME:PASSWORD" \
-H "Content-Type: application/json" \
-d '{
        "source": "amazon_product",
        "query": "B07FZ8S74R",
        "geo_location": "90210",
        "parse": true
    }'

We use synchronous Realtime integration method in our examples. If you would like to use Proxy Endpoint or asynchronous Push-Pull integration, refer to the integration methods section.

Request parameter values

  1. source - This parameter sets the scraper that will be used to process your request.

  2. URL or query - Provide the URL or query for the type of page you want to scrape. Refer to the table below and the corresponding target sub-pages for detailed guidance on when to use each parameter.

  3. Optionally, you can include additional parameters such as geo_location, user_agent_type, parse (find the list of our parsers here), render and more to customize your scraping request. Read more: Features.

- mandatory parameter

Scraping with URLs or parametrized inputs

Oxylabs support two general groups of inputs - URLs and parametrized inputs like queries, product or video IDs. Generic targets which do not have a dedicated source can be scraped with universal source.

Target
Source (Scraping URL)
Source (Using Query, Product or Video ID)

amazon

amazon_product,

amazon_search,

amazon_pricing,

amazon_sellers,

amazon_bestsellers

google

google_search,

google_ads,

google_ai_mode,

google_lens,

google_maps,

google_travel_hotels,

google_suggest,

google_trends_explore, google_shopping_product,

google_shopping_search

bing

bing_search

universal

youtube_search,

youtube_search_max,

youtube_video_trainability,

youtube_download,

youtube_transcript, youtube_subtitles, youtube_metadata, youtube_channel, youtube_autocomplete

universal

chatgpt

universal

perplexity

universal

walmart_search,

walmart_product

universal

tiktok_shop_search, tiktok_shop_product

universal

ebay_search, ebay_product

etsy

etsy_search,

etsy_product

universal

bestbuy_search,

bestbuy_product

bedbathandbeyond

bedbathandbeyond_search, bedbathandbeyond_product

instacart

instacart_search, instacart_product

kroger

kroger_search, kroger_product

lowes

lowes_search,

lowes_product

target

target_search,

target_product, target_category

grainger

grainger_search, grainger_product

costco

costco_search, costco_product

universal

menards_search

universal

petco_search

universal

staples_search

universal

allegro_search,

allegro_product

universal

idealo_search

universal

mediamarkt_search

cdiscount

cdiscount_search, cdiscount_product

alibaba

alibaba_search, alibaba_product

aliexpress

aliexpress_search, aliexpress_product

indiamart

indiamart_search, indiamart_product

universal

avnet_search

universal

lazada_search

universal

rakuten_search

universal

tokopedia_search

flipkart

flipkart_search, flipkart_product

universal

mercadolibre_search

universal

mercadolivre_search

universal

magazineluiza_search

falabella

falabella_search, falabella_product

universal

dcard_search

airbnb

airbnb_product

universal

Using query parameter is not supported

If you need any assistance in making your first request, feel free to contact us via the 24/7 available live chat.

Testing via Scraper APIs Playground

Try Web Scraper API and OxyCopilot in the Scraper APIs Playground.

Testing via Postman

Get started with our API using Postman, a handy tool for making HTTP requests. Download our Web Scraper API Postman collection and import it. This collection includes examples that demonstrate the functionality of the scraper. Customize the examples to your needs or start scraping right away.

For step-by-step instructions, watch our video tutorial below. If you're new to Postman, check out this short guide.

All information herein is provided on an "as is" basis and for informational purposes only. We make no representation and disclaim all liability with respect to your use of any information contained on this page. Before engaging in scraping activities of any kind you should consult your legal advisors and carefully read the particular website's terms of service or receive a scraping license.

Last updated

Was this helpful?