Abstract's Web Scraping API is a simple yet powerful REST API that is used to extract data from a given URL. To make a request, you simply include the target URL and your API key, and Abstract's API will return the data from that site. Optional configuration options, like proxies, location of the request, and more are possible to include.
The Web Scraping API, like all of Abstract's APIs, is organized around REST. It is designed to use predictable, resource-oriented URL's and to use HTTP status codes to indicate errors.
The Web Scraping API requires all communications to be secured TLS 1.2 or greater.
All of Abstract's API are versioned. The Web Scraping API is currently on Version 1.
Your API key is your unique authentication key to be used to access Abstract's Web Scraping API. Note that each of Abstract's APIs has a unique API key, so you will need different keys to access the Web Scraping and Website Screenshot APIs, for example. To authenticate your requests, you will need to append your API key to the base URL.
Abstract's Website Screenshot API only has two required parameters for the request, your unique API key and a single URL.
? api_key = YOUR_API_KEY
& url = https://www.apple.com
The was a successful request, so it returns the HTML (abbreviated for this example):
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">'
[...] // 46 lines skipped
[...] // 512 lines skipped
Your unique API key. Note that each user has unique API keys for each of Abstract's APIs, so your Web Scraping API key will not work for as your User Avatar API key, for example.
The URL to extract the data from. Note that this parameter should include the full HTTP Protocol (http:// or https://).
If true the request will block any advertisements it can identify on the target site. Defaults to false.
The country to make the request from. The country should be submitted in the two letter, ISO 3166-1 alpha-2 code.
Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.
Everything worked as expected.
The request was unacceptable. Typically due to the API key missing or incorrect.
Internal Server Error
The request could not be completed due to an error on the server side.
The server was unavailable.
The Web Scraping API takes a URL and returns the HTML for it. The API comes with a variety of configurations so you can exclude or include various data in your extraction, as well as handle various scenarios like geo-specific data and ads.
July 11, 2020
Improved handling of images and special characters which caused issues in certain exports
June 18, 2020
Each of our API's has a free plan as well as several paid options, which offer a greater number of requests, a higher level of data quality, and greater speed for higher prices. Please see the page above or sign into your account to view pricing for each API.
Absolutely! We want you to try before you buy. Each of our API's has a free tier with a generous usage allowance for you to try the product out and verify that the speed and data quality work for you.
We use Stripe to accept payment via major debit and credit cards (Visa, Mastercard, American Express). If you cannot use those payment methods, then contact us at team at abstractapi.com to arrange for an alternative payment method.
Yes, you can upgrade or downgrade your subscription at any time by visiting your dashboard. If you upgrade in the middle of a billing cycle, you will be charged a pro-rated amount for your new plan through the end of the billing cycle.
Yes, all of our subscriptions are month to month. You can cancel at any time, and you will not be charged again at the end of your billing cycle.
You can cancel your subscription at any time from your dashboard. Once canceled, your subscription will be active until the end your current billing cycle, and then it will be automatically moved to the free plan.
If your API usage exceeds the monthly limit set by your plan, then you will be charged a fee for each call over your limit. At the end of your billing period, your usage will reset again.
We do offer enterprise plans with custom features and pricing in limited circumstances. If our public pricing plans don't work for you, then contact us (team at abstractapi.com) and we'll work something out.
While we don't normally offer discounts, we do make exceptions for certain types of users and use cases. If you are a student or are engaged in academic work, or are working on a non-profit or open source project, we're happy to offer you discounts for our API's. Just email us at team at abstractapi.com.
All of our plans are currently paid month to month. We will be launching annual plans at a discount soon. If you're interested in an annual plan in the meantime, just contact us and we'll set you up.
We will typically attempt to charge your payment method up to three times after it fails. If we're still unable to collect payment, then your subscription will be automatically canceled and you'll be moved to the free plan.
Yes, a paid tier of our API may be used in conjunction with a commercial project. The free tiers of our API's may not be used in commercial projects.