---
title: "Create a scrape"
method: POST
path: "/v1/scrapes"
tags: ["scrapes"]
---

# Create a scrape

`POST /v1/scrapes`

## Request

- Base URL: `https://api.olostep.com`
- URL: `https://api.olostep.com/v1/scrapes`
- Auth: HTTP bearer

Scrape a URL and return its content in the requested formats.

## Request body

- object
  - `url_to_scrape` string, uri, required: The URL to scrape.
  - `formats` string[]: Output formats to return.
  - `wait_before_scraping` integer: Milliseconds to wait before scraping.
  - `country` string: ISO 3166-1 alpha-2 country to scrape from.
  - `remove_css_selectors` union: CSS selectors to strip, or "default"/"none".
    - 'default'
    - 'none'
    - string[]
  - `remove_images` boolean
  - `remove_class_names` string[]
  - `actions` object[]
    - `type` string, required
  - `parser` object
    - `id` string
  - `llm_extract` object
  - `links_on_page` object
  - `screenshot` union
    - boolean
    - object
  - `screen_size` object
  - `transformer` string
  - `metadata` object: Set of up to 50 key-value string pairs you can attach to the object. Echoed back unchanged.

## Response `200`

Default Response

- object: A scrape result.
  - `id` string, required
  - `object` 'scrape', required
  - `created` integer, required
  - `url` string, required
  - `retrieve_id` string, required
  - `result` object, required
    - `html_content` string, nullable
    - `markdown_content` string, nullable
    - `text_content` string, nullable
    - `json_content` string, nullable
    - `html_hosted_url` string, nullable
    - `markdown_hosted_url` string, nullable
    - `text_hosted_url` string, nullable
    - `json_hosted_url` string, nullable
    - `screenshot_hosted_url` string, nullable
    - `links_on_page` unknown[], nullable
      - unknown
    - `page_metadata` object
  - `metadata` object

## Other responses

- `400`: Default Response
- `401`: Default Response
- `402`: Default Response
- `403`: Default Response
- `429`: Default Response
- `502`: Default Response
- `504`: 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)