Start Crawl
curl -X POST https://api.orthogonal.com/v1/run \
-H 'Authorization: Bearer orth_live_••••' \
-H 'Content-Type: application/json' \
-d '{
"api": "olostep",
"path": "/v1/crawls",
"method": "POST",
"body": {
"start_url": "",
"max_pages":
}
}'
{
"success": true,
"data": {
"id": "example",
"object": "example",
"status": "example",
"created": 123,
"cost_usd": null,
"max_depth": null,
"max_pages": 123,
"start_url": "example",
"start_date": "example",
"pages_count": 123,
"exclude_urls": [],
"include_urls": [ 1 item ],
"current_depth": 123,
"credits_consumed": null,
"include_external": true
}
}
Example values, built from the documented fields.
Changes with the parameters.
$1.2300per callFor the example request; changes with the parameters.
API-wide: 96.7% success · 8,884 ms median · 30 days
About this endpoint
Starts a new crawl. You receive a id to track the progress. The operation may take 1-10 mins depending upon the site and depth and pages parameters.
Body parameters
Response types
More from Olostep
- Retrieve ContentGET/v1/retrieveFree
- Batch InfoGET/v1/batches/{batch_id}Free
- Create AnswerPOST/v1/answers$0.0500 per call
- MapsPOST/v1/maps$0.0100 per call
- Crawl PagesGET/v1/crawls/{crawl_id}/pagesFree
- Start BatchPOST/v1/batchesPriced per call
- Create ScrapePOST/v1/scrapes$0.0100 per call
- Batch ItemsGET/v1/batches/{batch_id}/itemsFree
- Get ScrapeGET/v1/scrapes/{scrape_id}Free
- Get AnswerGET/v1/answers/{answer_id}Free
- Crawl InfoGET/v1/crawls/{crawl_id}Free