User Guide

Chapter 5. Accessing the API

This chapter describes the application programming interface (API). The API helps to integrate applications, websites, and other types of programs. Use the API to integrate your data with Google Sheets, turn your data into a rich site summary (RSS) feed for Zapier integration, and more. For example, use API requests to upload a list of URLs to an extractor, run the extractor, and monitor the status of the crawl run to know when your data is ready to access.

The API is a RESTful API designed to have resource-oriented URLs and use HTTP status codes to indicate API status.The API requests use standard HTTP, which all HTTP clients understand, and support cross-origin resource sharing (CORS), which allows you to connect with the API from a client-side web application.

Note: Never expose your secret API key in any public client-side code!

The API response is a GZIP-compressed file in JavaScript object notation (JSON) format, and includes HTTP response codes, any error messages, and the data. The API response uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (for example, a required parameter is missing), and codes in the 5xx range indicate an error with the servers.

All data is accessible through both the dashboard and the API. For example, whether you added URLs from the Settings tab of the dashboard or through the API (using PUT /extractor/{extractorId}/_attachment/urlList), you can use both the dashboard and the API to see your additions.

Refer to the API Reference for detailed information regarding the API requests.

Note: The API is available only with paid annual subscriptions.

Topic 1. Locating your API key and extractor GUID

This topic describes how to locate your API key and extractor GUIDs.

Topic 2. The JSON API Response

This topic describes the JSON API response.

Topic 3. API endpoints

This topic lists the API endpoints available using the API.

Topic 4. Retrieving the name of an extractor

This topic describes the API request for retrieving the human-readable name of an extractor.

Topic 5. Retrieving extractor details

This topic describes the API request for retrieving basic information about an extractor..

Topic 6. Retrieving crawl run URLs

This topic describes the API request for retrieving the list of URLs accessed by an extractor.