Developer Quickstart

Initial onboarding steps with the Spider API.

Create and Export an API Key

Create an API key, then store it securely as an environment variable. This key will allow you to access the Spider API securely. Once you’ve generated an API key, export it as an environment variable in your terminal. Store the key in a safe location, like a .zshrc file or another text file on your computer.

Export an envrionment variable on *nix systems

export SPIDER_API_KEY="your_api_key_here"

Make Your First API Request

Once you have your API key, you can start making requests to Spider API. This example crawls a website from a URL.

Request

from spider import Spider
app = Spider()
params = {"limit":5}
crawl_result = app.crawl_url('https://example.com', params=params)