You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+94-3Lines changed: 94 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,22 +21,113 @@ npm i
21
21
npm build
22
22
```
23
23
24
-
## Example Usage
24
+
## Example Usages
25
25
26
-
#### The following example returns the response of how you requested from httpbin.co. You should see the ‘A123’ header in the header section of the response.
26
+
> ### extraHeaders
27
+
28
+
#### extraHeaders is used when you want to add one or more headers specifically required by the target website, without altering the core headers automatically generated by the service. This is useful for passing additional information while maintaining the integrity of the existing request headers.
29
+
30
+
#### The following example returns the response of how you requested from httpbin.co. You should see the ‘Key’ header in the header section of the response.
27
31
28
32
```typescript
29
33
const client =newScrapeDo("example_token");
30
34
const response =awaitclient.sendRequest("GET", {
31
35
url: "https://httpbin.co/anything",
32
36
extraHeaders: {
33
-
A123: "Extra Header",
37
+
Key: "Value",
38
+
},
39
+
});
40
+
41
+
console.log(response.data);
42
+
```
43
+
44
+
> ### forwardHeaders
45
+
46
+
#### The forwardHeaders option is ideal when you want to forward your custom headers directly to the target website without any additional headers being generated or modified by the service. This approach makes the request appear as if it is being made directly from your end, preserving the original header structure.
47
+
48
+
```typescript
49
+
const client =newScrapeDo("example_token");
50
+
const response =awaitclient.sendRequest("GET", {
51
+
url: "https://httpbin.co/anything",
52
+
forwardHeaders: {
53
+
Key: "Value",
54
+
},
55
+
});
56
+
57
+
console.log(response.data);
58
+
```
59
+
60
+
> ### customHeaders
61
+
62
+
#### The customHeaders option gives you full control over all headers sent to the target website. When you use customHeaders, the headers you provide will completely replace the default ones. This feature is useful when you need to define specific headers like User-Agent, Accept, Cookies, and more, ensuring that only your specified headers are sent with the request.
63
+
64
+
```typescript
65
+
const client =newScrapeDo("example_token");
66
+
const response =awaitclient.sendRequest("GET", {
67
+
url: "https://httpbin.co/anything",
68
+
customHeaders: {
69
+
Key: "Value",
34
70
},
35
71
});
36
72
37
73
console.log(response.data);
38
74
```
39
75
76
+
> ### super (residental proxy)
77
+
78
+
#### The super parameter enables the use of a residential proxy for the request. When this parameter is set to true, the request will be routed through a residential IP address. This means that the IP address will typically appear as if it belongs to a mobile network provider, adding an additional layer of anonymity and making the request look more like regular web traffic.
#### The render parameter allows for the execution of JavaScript during the request, enabling full browser-like rendering. When this parameter is set to true, the service will render the target webpage as if it were being loaded in a real browser, executing all JavaScript, loading dynamic content, and handling client-side interactions. This approach is particularly useful for scraping websites that rely heavily on JavaScript to display their content, providing a more accurate and “humanized” view of the page.
93
+
94
+
```typescript
95
+
const client =newScrapeDo("example_token");
96
+
const response =awaitclient.sendRequest("GET", {
97
+
url: "https://httpbin.co/anything",
98
+
render: true,
99
+
});
100
+
101
+
console.log(response.data);
102
+
```
103
+
104
+
> ### final bonus example (render, super, geoCode, playWithBrowser)
105
+
106
+
#### In this example, multiple parameters are combined to showcase advanced scraping capabilities. By using a combination of render, super, geoCode, and playWithBrowser, you can perform complex scraping tasks that require JavaScript execution, residential proxies, geographical targeting, and interactive browser actions:
107
+
108
+
- render: true: Enables JavaScript execution to fully render the webpage, allowing for the scraping of dynamic content that relies on client-side scripting.
109
+
- super: true: Utilizes a residential proxy, which makes the request appear as if it is coming from a typical user on a mobile network, providing enhanced anonymity and avoiding blocks from anti-scraping measures.
110
+
- geoCode: "us": Targets a specific geographic location for the request, in this case, the United States. This is useful for scraping content that varies by region, such as localized prices or region-specific data.
111
+
- playWithBrowser: Provides the ability to interact with the browser while rendering the page. For example, you can wait for specific elements to load or perform actions like clicking buttons. In this case, it waits for the <body> element to ensure the page is fully loaded before proceeding.
112
+
113
+
```typescript
114
+
const client =newScrapeDo("example_token");
115
+
const response =awaitclient.sendRequest("GET", {
116
+
url: "https://ExampleProtectedDomain.com/prices",
117
+
render: true,
118
+
super: true,
119
+
geoCode: "us",
120
+
playWithBrowser: [
121
+
{
122
+
Action: "WaitSelector",
123
+
WaitSelector: "body",
124
+
},
125
+
],
126
+
});
127
+
128
+
console.log(response.data);
129
+
```
130
+
40
131
## More details
41
132
42
133
#### [Documentation for more information](https://scrape.do/documentation/?utm_source=github&utm_medium=node-client)
0 commit comments