CRAFT Scraper
Try for free
7 days trial then $30.00/month - No credit card required now
Go to Store
CRAFT Scraper
jupri/craft-scraper
Try for free
7 days trial then $30.00/month - No credit card required now
💫 Scrape Craft.co
You can access the CRAFT Scraper programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.1",
5 "x-build-id": "Q2zsX5UU2MOk3ZO8I"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/jupri~craft-scraper/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-jupri-craft-scraper",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/jupri~craft-scraper/runs": {
50 "post": {
51 "operationId": "runs-sync-jupri-craft-scraper",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/jupri~craft-scraper/run-sync": {
93 "post": {
94 "operationId": "run-sync-jupri-craft-scraper",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "properties": {
134 "query": {
135 "title": "❓ Query",
136 "type": "string",
137 "description": "💡 Company <i><code>slug(s)</code></i> separated by spaces, or <code><i>keywords</i></code> to search in <code>search_mode=true</code>"
138 },
139 "search_mode": {
140 "title": "Enable Search Mode",
141 "type": "boolean",
142 "description": ""
143 },
144 "limit": {
145 "title": "Limit",
146 "type": "integer",
147 "description": "💡 Limit number of results. (default = 5)",
148 "default": 5
149 },
150 "tags": {
151 "title": "Sectors (Tags)",
152 "type": "string",
153 "description": "💡 Sector Tags separated by comma"
154 },
155 "size_min": {
156 "title": "Employee Count",
157 "type": "integer",
158 "description": ""
159 },
160 "size_max": {
161 "title": "",
162 "type": "integer",
163 "description": ""
164 },
165 "types": {
166 "title": "Type of Company",
167 "type": "array",
168 "description": "",
169 "items": {
170 "type": "string",
171 "enum": [
172 "private",
173 "public",
174 "subsidiary",
175 "investor"
176 ],
177 "enumTitles": [
178 "Private",
179 "Public",
180 "Subsidiary",
181 "Investor"
182 ]
183 }
184 },
185 "includes.locations": {
186 "title": "Office Locations",
187 "type": "boolean",
188 "description": ""
189 },
190 "includes.executives": {
191 "title": "Key People/Management",
192 "type": "boolean",
193 "description": ""
194 },
195 "includes.operating_metrics": {
196 "title": "Operating Metrics",
197 "type": "boolean",
198 "description": ""
199 },
200 "includes.acquisitions": {
201 "title": "Acquisitions / Subsidiaries",
202 "type": "boolean",
203 "description": ""
204 },
205 "includes.revenue_breakdowns": {
206 "title": "Revenue Breakdowns",
207 "type": "boolean",
208 "description": ""
209 },
210 "includes.expenses_breakdowns": {
211 "title": "Expenses Breakdowns",
212 "type": "boolean",
213 "description": ""
214 },
215 "includes.human_capital": {
216 "title": "Human Capital",
217 "type": "boolean",
218 "description": ""
219 },
220 "includes.job_hiring": {
221 "title": "Job Hiring Categories",
222 "type": "boolean",
223 "description": ""
224 },
225 "includes.salaries": {
226 "title": "Median Salaries",
227 "type": "boolean",
228 "description": ""
229 },
230 "includes.competitors": {
231 "title": "Competitors",
232 "type": "boolean",
233 "description": ""
234 },
235 "includes.technologies": {
236 "title": "Technology Stacks",
237 "type": "boolean",
238 "description": ""
239 },
240 "includes.company_culture": {
241 "title": "Company Culture",
242 "type": "boolean",
243 "description": ""
244 },
245 "includes.similar_companies": {
246 "title": "Similar Companies",
247 "type": "boolean",
248 "description": ""
249 },
250 "dev_proxy_config": {
251 "title": "🌐 PROXY NETWORKING",
252 "type": "object",
253 "description": "<b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b><a href=https://scrapeops.io/app/register/main target=_blank>ScrapeOps.IO</a></b><br><code>scrapeops://{api-key}</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>"
254 },
255 "dev_custom_headers": {
256 "title": "📜 HTTP HEADERS",
257 "type": "array",
258 "description": "💡 Additional HTTP Headers",
259 "items": {
260 "type": "object",
261 "required": [
262 "key",
263 "value"
264 ],
265 "properties": {
266 "key": {
267 "type": "string",
268 "title": "Key"
269 },
270 "value": {
271 "type": "string",
272 "title": "Value"
273 }
274 }
275 }
276 },
277 "dev_custom_cookies": {
278 "title": "🍰 HTTP COOKIES",
279 "type": "array",
280 "description": "💡 Additional HTTP Cookies",
281 "items": {
282 "type": "object",
283 "required": [
284 "key",
285 "value"
286 ],
287 "properties": {
288 "key": {
289 "type": "string",
290 "title": "Key"
291 },
292 "value": {
293 "type": "string",
294 "title": "Value"
295 }
296 }
297 }
298 },
299 "dev_no_strip": {
300 "title": "Disable data cleansing",
301 "type": "boolean",
302 "description": "💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>"
303 },
304 "dev_transform_enable": {
305 "title": "Enable Custom Fields",
306 "type": "boolean",
307 "description": ""
308 },
309 "dev_transform_fields": {
310 "title": "Fields List",
311 "type": "array",
312 "description": "",
313 "items": {
314 "type": "object",
315 "required": [
316 "key",
317 "value"
318 ],
319 "properties": {
320 "key": {
321 "type": "string",
322 "title": "Key"
323 },
324 "value": {
325 "type": "string",
326 "title": "Value"
327 }
328 }
329 }
330 },
331 "dev_dataset_enable": {
332 "title": "Enable Custom Storage",
333 "type": "boolean",
334 "description": ""
335 },
336 "dev_dataset_clear": {
337 "title": "Clear Storage",
338 "type": "boolean",
339 "description": "Clear Dataset before insert/update."
340 },
341 "dev_dataset_name": {
342 "title": "Dataset Name",
343 "type": "string",
344 "description": "💡 <b>Use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>"
345 }
346 }
347 },
348 "runsResponseSchema": {
349 "type": "object",
350 "properties": {
351 "data": {
352 "type": "object",
353 "properties": {
354 "id": {
355 "type": "string"
356 },
357 "actId": {
358 "type": "string"
359 },
360 "userId": {
361 "type": "string"
362 },
363 "startedAt": {
364 "type": "string",
365 "format": "date-time",
366 "example": "2025-01-08T00:00:00.000Z"
367 },
368 "finishedAt": {
369 "type": "string",
370 "format": "date-time",
371 "example": "2025-01-08T00:00:00.000Z"
372 },
373 "status": {
374 "type": "string",
375 "example": "READY"
376 },
377 "meta": {
378 "type": "object",
379 "properties": {
380 "origin": {
381 "type": "string",
382 "example": "API"
383 },
384 "userAgent": {
385 "type": "string"
386 }
387 }
388 },
389 "stats": {
390 "type": "object",
391 "properties": {
392 "inputBodyLen": {
393 "type": "integer",
394 "example": 2000
395 },
396 "rebootCount": {
397 "type": "integer",
398 "example": 0
399 },
400 "restartCount": {
401 "type": "integer",
402 "example": 0
403 },
404 "resurrectCount": {
405 "type": "integer",
406 "example": 0
407 },
408 "computeUnits": {
409 "type": "integer",
410 "example": 0
411 }
412 }
413 },
414 "options": {
415 "type": "object",
416 "properties": {
417 "build": {
418 "type": "string",
419 "example": "latest"
420 },
421 "timeoutSecs": {
422 "type": "integer",
423 "example": 300
424 },
425 "memoryMbytes": {
426 "type": "integer",
427 "example": 1024
428 },
429 "diskMbytes": {
430 "type": "integer",
431 "example": 2048
432 }
433 }
434 },
435 "buildId": {
436 "type": "string"
437 },
438 "defaultKeyValueStoreId": {
439 "type": "string"
440 },
441 "defaultDatasetId": {
442 "type": "string"
443 },
444 "defaultRequestQueueId": {
445 "type": "string"
446 },
447 "buildNumber": {
448 "type": "string",
449 "example": "1.0.0"
450 },
451 "containerUrl": {
452 "type": "string"
453 },
454 "usage": {
455 "type": "object",
456 "properties": {
457 "ACTOR_COMPUTE_UNITS": {
458 "type": "integer",
459 "example": 0
460 },
461 "DATASET_READS": {
462 "type": "integer",
463 "example": 0
464 },
465 "DATASET_WRITES": {
466 "type": "integer",
467 "example": 0
468 },
469 "KEY_VALUE_STORE_READS": {
470 "type": "integer",
471 "example": 0
472 },
473 "KEY_VALUE_STORE_WRITES": {
474 "type": "integer",
475 "example": 1
476 },
477 "KEY_VALUE_STORE_LISTS": {
478 "type": "integer",
479 "example": 0
480 },
481 "REQUEST_QUEUE_READS": {
482 "type": "integer",
483 "example": 0
484 },
485 "REQUEST_QUEUE_WRITES": {
486 "type": "integer",
487 "example": 0
488 },
489 "DATA_TRANSFER_INTERNAL_GBYTES": {
490 "type": "integer",
491 "example": 0
492 },
493 "DATA_TRANSFER_EXTERNAL_GBYTES": {
494 "type": "integer",
495 "example": 0
496 },
497 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
498 "type": "integer",
499 "example": 0
500 },
501 "PROXY_SERPS": {
502 "type": "integer",
503 "example": 0
504 }
505 }
506 },
507 "usageTotalUsd": {
508 "type": "number",
509 "example": 0.00005
510 },
511 "usageUsd": {
512 "type": "object",
513 "properties": {
514 "ACTOR_COMPUTE_UNITS": {
515 "type": "integer",
516 "example": 0
517 },
518 "DATASET_READS": {
519 "type": "integer",
520 "example": 0
521 },
522 "DATASET_WRITES": {
523 "type": "integer",
524 "example": 0
525 },
526 "KEY_VALUE_STORE_READS": {
527 "type": "integer",
528 "example": 0
529 },
530 "KEY_VALUE_STORE_WRITES": {
531 "type": "number",
532 "example": 0.00005
533 },
534 "KEY_VALUE_STORE_LISTS": {
535 "type": "integer",
536 "example": 0
537 },
538 "REQUEST_QUEUE_READS": {
539 "type": "integer",
540 "example": 0
541 },
542 "REQUEST_QUEUE_WRITES": {
543 "type": "integer",
544 "example": 0
545 },
546 "DATA_TRANSFER_INTERNAL_GBYTES": {
547 "type": "integer",
548 "example": 0
549 },
550 "DATA_TRANSFER_EXTERNAL_GBYTES": {
551 "type": "integer",
552 "example": 0
553 },
554 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
555 "type": "integer",
556 "example": 0
557 },
558 "PROXY_SERPS": {
559 "type": "integer",
560 "example": 0
561 }
562 }
563 }
564 }
565 }
566 }
567 }
568 }
569 }
570}Craft.co Scraper OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for CRAFT Scraper from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
cat
