CTRL+K

Web Scraper API

POST

https://api.apifreaks.com/v1.0/scraping

Swagger Docs Documentation

format

Format of the Response

urlstringrequired

Target page URL to scrape.

jsEnabledboolean

Enables browser-based scraping for JavaScript-rendered websites when set to true; uses static scraping when false.

textboolean

Returns plain text when true; returns HTML content when false.

proxystring

Enables proxy usage. Use true for the default proxy or pass a custom proxy string such as http://username:password@host:port.

sslIgnoreboolean

Ignores SSL certificate errors during scraping. Mainly relevant for JS-enabled scraping.

windowSizestring

Browser viewport size in width/height format for rendered scraping sessions.

adBlockboolean

Blocks ads and unnecessary page resources to improve scraping quality and speed.

captchaboolean

Enables CAPTCHA-related instructions for JavaScript-enabled workflows.

Pass the target page in the url query parameter. The JSON body should contain the scraping instructions array.The extractedData object is dynamic and reflects the field names defined inside your extract instruction.

Sample Responses

400

401

429

500

LANGUAGE

Python

PHP

Java

Node

Ruby


$ pip install requests
import requests 
import json

url = "https://api.apifreaks.com/v1.0/scraping"

payload = json.dumps({
    "instructions": []
})
headers = {
	'Content-Type': 'application/json',
	'X-apiKey': ''
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

Click Test it to start the request and see the response here!

API Response

Field	Type	Requirement	Description
extractedData	Object	Mandatory	Container for the values extracted by your scraping instructions. The returned keys depend on the names used inside the extract action.

The extractedData object is instruction-driven. Common response shapes include the following fields:

Field	Type	Requirement	Description
html	String	Optional	HTML content extracted from a selector or XPath when the extract instruction requests html output.
text	String	Optional	Plain text content extracted from a selector or XPath when the extract instruction requests text output.
<custom field>	String \| Number \| Boolean \| Array \| Object	Optional	Any custom key defined inside extract. The response type depends on the selector result and the structure of the extraction rule.
<custom array field>	Array<String>	Optional	Returned when an extract rule maps a field to multiple selectors, such as repeated rows, links, or name server values.

Error responses can contain the following fields when scraping fails or the request is invalid:

Field	Type	Requirement	Description
error	String	Mandatory	Human-readable error message describing the failure.
code	Integer	Optional	Numeric error code returned by the API when available.
details	Object	Optional	Additional context about invalid parameters, failed instructions, or provider-side processing issues.

$ pip install requests

import requests 
import json

url = "https://api.apifreaks.com/v1.0/scraping"

payload = json.dumps({
    "instructions": []
})
headers = {
	'Content-Type': 'application/json',
	'X-apiKey': ''
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Field

Type

Requirement

Description

extractedData

Object

Mandatory

Container for the values extracted by your scraping instructions. The returned keys depend on the names used inside the extract action.

Field

Type

Requirement

Description

html

String

Optional

HTML content extracted from a selector or XPath when the extract instruction requests html output.

text

String

Optional

Plain text content extracted from a selector or XPath when the extract instruction requests text output.

String | Number | Boolean | Array | Object

Optional

Any custom key defined inside extract. The response type depends on the selector result and the structure of the extraction rule.

Array<String>

Optional

Returned when an extract rule maps a field to multiple selectors, such as repeated rows, links, or name server values.

Field

Type

Requirement

Description

error

String

Mandatory

Human-readable error message describing the failure.

code

Integer

Optional

Numeric error code returned by the API when available.

details

Object

Optional

Additional context about invalid parameters, failed instructions, or provider-side processing issues.