Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

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