Skip to content

Commit 832ba40

Browse files
crawlbasecrawlbase
committed
build: initial commit after rebranding
0 parents  commit 832ba40

22 files changed

+5873
-0
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
log
3+
test.jpg

‎LICENSE‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.

‎README.md‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
# Crawlbase node
2+
3+
Dependency free module for scraping and crawling websites using [Crawlbase](https://crawlbase.com) API
4+
5+
## Installation
6+
7+
Install using npm
8+
9+
```javascript
10+
npm i crawlbase
11+
```
12+
13+
Require the necessary API class in your project.
14+
You can get your [Crawlbase free token from here](https://crawlbase.com/signup).
15+
16+
```javascript
17+
const { CrawlingAPI, ScraperAPI, LeadsAPI, ScreenshotsAPI } = require('crawlbase');
18+
```
19+
20+
## Crawling API usage
21+
22+
Initialize with one of your account tokens, either normal or javascript token. Then make get or post requests accordingly.
23+
24+
```javascript
25+
const api = new CrawlingAPI({ token: 'YOUR_TOKEN' });
26+
```
27+
28+
### GET requests
29+
30+
Pass the url that you want to scrape plus any options from the ones available in the [API documentation](https://crawlbase.com/dashboard/docs).
31+
32+
```javascript
33+
api.get(url, options);
34+
```
35+
36+
Example:
37+
38+
```javascript
39+
api.get('https://www.facebook.com/britneyspears').then(response => {
40+
if (response.statusCode === 200) {
41+
console.log(response.body);
42+
}
43+
}).catch(error => console.error);
44+
```
45+
46+
You can pass any options from Crawlbase API.
47+
48+
Example:
49+
50+
```javascript
51+
api.get('https://www.reddit.com/r/pics/comments/5bx4bx/thanks_obama/', {
52+
userAgent: 'Mozilla/5.0 (Windows NT 6.2; rv:20.0) Gecko/20121202 Firefox/30.0',
53+
format: 'json'
54+
}).then(response => {
55+
if (response.statusCode === 200) {
56+
console.log(response.body);
57+
}
58+
}).catch(error => console.error);
59+
```
60+
61+
### POST requests
62+
63+
Pass the url that you want to scrape, the data that you want to send which can be either a json or a string, plus any options from the ones available in the [API documentation](https://crawlbase.com/dashboard/docs).
64+
65+
```javascript
66+
api.post(url, data, options);
67+
```
68+
69+
Example:
70+
71+
```javascript
72+
api.post('https://producthunt.com/search', { text: 'example search' }).then(response => {
73+
if (response.statusCode === 200) {
74+
console.log(response.body);
75+
}
76+
}).catch(error => console.error);
77+
```
78+
79+
You can send the data as application/json instead of x-www-form-urlencoded by setting options `postType` as json.
80+
81+
```javascript
82+
api.post('https://httpbin.org/post', { some_json: 'with some value' }, { postType: 'json' }).then(response => {
83+
if (response.statusCode === 200) {
84+
console.log(response.body);
85+
}
86+
}).catch(error => console.error);
87+
```
88+
89+
### PUT requests
90+
91+
Pass the url that you want to scrape, the data that you want to send which can be either a json or a string, plus any options from the ones available in the [API documentation](https://crawlbase.com/dashboard/docs).
92+
93+
```javascript
94+
api.put(url, data, options);
95+
```
96+
97+
Example:
98+
99+
```javascript
100+
api.put('https://producthunt.com/search', { text: 'example search' }).then(response => {
101+
if (response.statusCode === 200) {
102+
console.log(response.body);
103+
}
104+
}).catch(error => console.error);
105+
```
106+
107+
### Javascript requests
108+
109+
If you need to scrape any website built with Javascript like React, Angular, Vue, etc. You just need to pass your javascript token and use the same calls. Note that only `.get` is available for javascript and not `.post`.
110+
111+
```javascript
112+
const api = new CrawlingAPI({ token: 'YOUR_JAVASCRIPT_TOKEN' });
113+
```
114+
115+
```javascript
116+
api.get('https://www.nfl.com').then(response => {
117+
if (response.statusCode === 200) {
118+
console.log(response.body);
119+
}
120+
}).catch(error => console.error);
121+
```
122+
123+
Same way you can pass javascript additional options.
124+
125+
```javascript
126+
api.get('https://www.freelancer.com', { pageWait: 5000 }).then(response => {
127+
if (response.statusCode === 200) {
128+
console.log(response.body);
129+
}
130+
}).catch(error => console.error);
131+
```
132+
133+
### Original status and PC status
134+
135+
You can always get the original status and crawlbase status from the response. Read the [Crawlbase documentation](https://crawlbase.com/dashboard/docs) to learn more about those status.
136+
137+
```javascript
138+
api.get('https://craiglist.com').then(response => {
139+
console.log(response.originalStatus, response.cbStatus);
140+
}).catch(error => console.error);
141+
```
142+
143+
## Scraper API usage
144+
145+
Initialize the Scraper API and use it in the same way as the Crawling API (see above). Use it with your normal token.
146+
147+
```javascript
148+
const api = new ScraperAPI({ token: 'YOUR_TOKEN' });
149+
150+
api.get('https://www.amazon.com/Halo-SleepSack-Swaddle-Triangle-Neutral/dp/B01LAG1TOS').then(response => {
151+
if (response.statusCode === 200) {
152+
console.log(response.json);
153+
}
154+
}).catch(error => console.error);
155+
```
156+
157+
## Leads API usage
158+
159+
Initialize with your Leads API token and call the `getFromDomain` method.
160+
161+
```javascript
162+
const api = new LeadsAPI({ token: 'YOUR_TOKEN' });
163+
164+
api.getFromDomain('somesite.com').then(response => {
165+
console.log(response.leads);
166+
});
167+
```
168+
169+
## Screenshots API usage
170+
171+
Initialize with your Screenshots API token and call the `get` method, then do whatever you need with the binary content. For example save it in a file.
172+
173+
You can pass any of the [available parameters](https://crawlbase.com/docs/screenshots-api/parameters/)
174+
175+
```javascript
176+
const api = new ScreenshotsAPI({ token: 'YOUR_TOKEN' });
177+
178+
api.get('https://www.amazon.com').then(response => {
179+
fs.writeFileSync('amazon.jpg', response.body, { encoding: 'binary' });
180+
});
181+
182+
// Example with parameters
183+
api.get('https://www.amazon.com', { device: 'mobile' }).then(response => {
184+
fs.writeFileSync('amazon-mobile.jpg', response.body, { encoding: 'binary' });
185+
});
186+
```
187+
188+
If you have questions or need help using the library, please open an issue or [contact us](https://crawlbase.com/contact).
189+
190+
---
191+
192+
Copyright 2023 Crawlbase

‎index.d.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import CrawlingAPI = require("./src/crawling-api.js");
2+
import ScraperAPI = require("./src/scraper-api.js");
3+
import LeadsAPI = require("./src/leads-api.js");
4+
import ScreenshotsAPI = require("./src/screenshots-api.js");
5+
export { CrawlingAPI, CrawlingAPI as CrawlbaseAPI, ScraperAPI, LeadsAPI, ScreenshotsAPI };

‎index.js‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
const CrawlingAPI = require('./src/crawling-api.js');
2+
const ScraperAPI = require('./src/scraper-api.js');
3+
const LeadsAPI = require('./src/leads-api.js');
4+
const ScreenshotsAPI = require('./src/screenshots-api.js');
5+
6+
module.exports = {
7+
CrawlingAPI,
8+
CrawlbaseAPI: CrawlingAPI, // This one is here for backward compatibility reasons
9+
ScraperAPI,
10+
LeadsAPI,
11+
ScreenshotsAPI,
12+
};

0 commit comments

Comments
 (0)