Get Scrape

Can be used to retrieve response for a scrape.

GET /v1/scrapes/{scrape_id}

Retrieve scrape result

cURL

curl --request GET \
  --url https://api.olostep.com/v1/scrapes/{scrape_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "metadata": {},
  "url_to_scrape": "<string>",
  "result": {
    "html_content": "<string>",
    "markdown_content": "<string>",
    "json_content": "<string>",
    "screenshot_hosted_url": "<string>",
    "html_hosted_url": "<string>",
    "markdown_hosted_url": "<string>",
    "links_on_page": [
      "<string>"
    ],
    "page_metadata": {
      "status_code": 123,
      "title": "<string>"
    },
    "size_exceeded": true
  },
  "credits_consumed": 123,
  "cost_usd": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer , where is your auth token.

Path Parameters

scrape_id · string · required

Unique identifier for the scrape to be retrieved.

Response

200

application/json

Successful response with the scrape result.

id · string

Scrape ID

object · string

The kind of object. "scrape" for this endpoint.

created · number

Created epoch

metadata · object

User-defined metadata.

url_to_scrape · string

The URL that was scraped.

result · object

Show child attributes

credits_consumed · integer | null

Number of credits consumed by this request. Populated after execution completes. Credits are the source of truth for billing.

cost_usd · number | null

Estimated cost in USD for this request. Populated after execution completes. Calculated from credits consumed and your plan rate — 99% accurate, but credits_consumed is the authoritative value.