---
title: "Get a batch"
method: GET
path: "/v1/batches/{batchId}"
tags: ["batches"]
---

# Get a batch

`GET /v1/batches/{batchId}`

## Request

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

Retrieve status and progress information about a batch.

## Path parameters

- `batchId` string, required

## Response `200`

Default Response

- object: A batch resource.
  - `id` string, required
  - `object` 'batch', required
  - `status` string, required
  - `created` number, required
  - `completed_at` number, nullable
  - `total_urls` integer, required
  - `completed_urls` integer, required
  - `number_retried` integer
  - `parser` string, nullable
  - `country` string, nullable
  - `start_date` string
  - `metadata` object
  - `webhook` string, nullable
  - `completion_window` string
  - `credits_consumed` number, nullable
  - `cost_usd` number, nullable
  - `warning` string

## 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)