---
title: "Initiate a web page scrape"
method: POST
path: "/olostep/v1/scrapes"
tags: ["Olostep"]
---

# Initiate a web page scrape

`POST /olostep/v1/scrapes`

## Request

- Base URL: `https://api.orthogonal.com/mpp`
- URL: `https://api.orthogonal.com/mpp/olostep/v1/scrapes`
- Auth: none declared
- TypeScript: <https://skmtc.dev/orthogonal/apis/orthogonal-api-marketplace/docs/olostep/v1/scrapes/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- object
  - `url_to_scrape` string, required: The URL to start scraping from.
  - `wait_before_scraping` integer: Time to wait in milliseconds before starting the scraping.
  - `formats` string[]: Formats in which you want the content.
  - `remove_css_selectors` string: Option to remove certain CSS selectors from the content. Optionally, you can also pass a JSON stringified array of specific selectors you want to remove. The CSS selectors removed when this option is set to default are ['nav','footer','script','style','noscript','svg',[role=alert],[role=banner],[role=dialog],[role=alertdialog],[role=region][aria-label*=skip i],[aria-modal=true]] Available options: `default`, `none`, `array`
  - `actions` object[]: Actions to perform on the page before getting the content.
    - `type` string, required
    - `milliseconds` number
  - `country` string: Residential country to load the request from. Supported values are: * US (United States) * CA (Canada) * IT (Italy) * IN (India) * GB (England) * JP (Japan) * MX (Mexico) * AU (Australia) * ID (Indonesia) * UA (UAE) * RU (Russia) * RANDOM Some operations, like scraping Google Search and Google News, support all countries.
  - `transformer` string: Specify the HTML transformer to use, if any. Postlight's Mercury Parser library is used to remove ads and other unwanted content from the scraped content. Available options: `postlight`, `none`
  - `remove_images` boolean: Option to remove images from the scraped content. Defaults to false.
  - `remove_class_names` string[]: List of class names to remove from the content.
  - `parser` object: When defining json as a format, you can use this parameter to specify the parser to use. Parsers are useful to extract structured content from web pages. Olostep has a few parsers built in for most common web pages, and you can also create your own parsers.
    - `id` string
  - `llm_extract` object
    - `schema` object
  - `links_on_page` object: With this option, you can get all the links present on the page you scrape.
    - `absolute_links` boolean
    - `query_to_order_links_by` string
    - `include_links` string[]
    - `exclude_links` string[]
  - `screen_size` object: Configuration for screen size. Preset dimensions are available through screen_type: desktop (1920x1080), mobile (414x896), or default (768x1024).
    - `screen_type` string
    - `screen_width` number
    - `screen_height` number
  - `metadata` object: User-defined metadata. Not supported yet

## Response `200`

Successful response

## Other responses

- `402`: Payment Required (x402 / MPP / np)

## Changes

- **2026-11-08** `857e915717f4`: 1 breaking
  - added required request body
- **2026-08-25** `806e279c8d50`: 2 info
  - api tag `Olostep` added
  - api tag `Olostep API` removed

[Operation history](https://skmtc.dev/orthogonal/apis/orthogonal-api-marketplace/changes/olostep/v1/scrapes/post.md)

---

[API](https://skmtc.dev/orthogonal/apis/orthogonal-api-marketplace.md) - [All operations](https://skmtc.dev/orthogonal/apis/orthogonal-api-marketplace/llms.txt) - [OpenAPI document](https://skmtc.dev/orthogonal/apis/orthogonal-api-marketplace/revisions/fc2e1d26c8eb?raw)