Authentication

The API endpoints require that you authenticate using an API token.

Generate a token

The token can be generated from the Olostep dashboard. Please create an account here.

Use your token

You can authenticate by adding an Authorization header to all your HTTP calls. The Authorization header is formatted as such: Authorization: Bearer <API-TOKEN> (replace <API-TOKEN> with your token. If you don’t have a token, you can generate one for free from the Olostep dashboard. Examples:

# pip install requests

import requests

endpoint = 'https://api.olostep.com/v1/scrapes/<SCRAPE_ID>'
headers = {
    'Authorization': 'Bearer <API-TOKEN>',
    'Accept': 'application/json'
}

response = requests.get(endpoint, headers=headers)
print(response.status_code)
print(response.json())

// npm install node-fetch

// ESM
import fetch from 'node-fetch'

const endpoint = 'https://api.olostep.com/v1/scrapes/<SCRAPE_ID>'
const res = await fetch(endpoint, {
  headers: {
    'Authorization': 'Bearer <API-TOKEN>',
    'Accept': 'application/json'
  }
})
console.log(res.status)
console.log(await res.json())

curl -L -X GET 'https://api.olostep.com/v1/scrapes/<SCRAPE_ID>' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <API-TOKEN>'

Using the CLI

The Olostep CLI doesn’t use an API key. It signs in with your Olostep account:

curl -fsSL https://cli.olostep.com | sh
olostep login

Your browser opens the Olostep sign-in page. For CI, set OLOSTEP_TOKEN. See CLI authentication. To put an API key into a .env file for your own code without printing it:

olostep keys reveal <key> --write-env .env

Using the SDKs

The Python and Node.js SDKs read OLOSTEP_API_KEY from the environment, or accept the key directly when you construct the client.

Get Started

Features

Balance & Billing

Generate a token

Use your token

Using the CLI

Using the SDKs

​Generate a token

​Use your token

​Using the CLI

​Using the SDKs

Generate a token

Use your token

Using the CLI

Using the SDKs