Starter Kit

API Reference

Dashboard

Support

This endpoint allows you to get basic information from your account such as token usage and other stats.

Account summary

default

Example section for showcasing API endpoints

Introduction

This endpoint allows you to get a scraping result.

Get a result

This endpoint allows you to delete a scraping result.

Delete a result

This endpoint returns the information about the latest result for a scraper.

You can use the optional `status` body parameter to filter the result for a particular scraping status.

Get a scraper's latest result

This endpoint allows you to get a list of all your scraping results.

List all results

This endpoint allows you to get a list of all your scrapers.

List all scrapers

This endpoint allows you to get a single scraper's information.

Get a scraper

This endpoint allows you to tell a scraper to start a scraping.

Run a scraper

This endpoint allows you to delete a scraping run and its results.

Delete a scraping run

This endpoint returns the information about the latest scraping run for a scraper.

You can use the optional `status` body parameter to filter the result for a particular scraping run status.

Get a scraper's latest scraping run

This endpoint allows you to get a scraping run batch.

Get a scraping run

This endpoint allows you to list all scraping runs.

List all scraping runs

This endpoint allows you to run a new job board scraper.

API Documentation

Endpoint Examples

Account summary

Authorizations

Response