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:

Python

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

Using the CLI

If you’re using the Olostep CLI, you can skip manual key handling and sign in from the terminal:

npm install -g olostep-cli
olostep login

The browser opens, you click Authorize, and the key is saved locally. For CI, set OLOSTEP_API_KEY instead.

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.