---
title: "Get a crawl"
method: GET
path: "/v1/crawls/{crawlId}"
tags: ["crawls"]
---

# Get a crawl

`GET /v1/crawls/{crawlId}`

## Request

- Base URL: `https://api.olostep.com`
- URL: `https://api.olostep.com/v1/crawls/{crawlId}`
- Auth: HTTP bearer

Retrieve status and progress information about a crawl.

## Path parameters

- `crawlId` string, required

## Response `200`

Default Response

- object: A crawl resource.
  - `id` string, required
  - `object` 'crawl', required
  - `status` string, required
  - `created` number, required
  - `start_date` string
  - `start_url` string, required
  - `max_pages` number, nullable
  - `max_depth` number, nullable
  - `exclude_urls` string[]
  - `include_urls` string[]
  - `include_external` boolean
  - `search_query` string
  - `top_n` number
  - `current_depth` number
  - `pages_count` number
  - `webhook` string, nullable
  - `webhook_url` string, nullable
  - `follow_robots_txt` boolean
  - `credits_consumed` number, nullable
  - `cost_usd` number, nullable

## Other responses

- `401`: Default Response
- `404`: Default Response
- `502`: Default Response

---

[API](https://skmtc.dev/olostep/apis/olostep-api.md) · [All operations](https://skmtc.dev/olostep/apis/olostep-api/llms.txt) · [OpenAPI document](https://skmtc.dev/olostep/apis/olostep-api/revisions/13c766ab100c?raw)