Import.io User Guide

API endpoints


This topic describes the API endpoints available on the Integrate tab of the Import.io dashboard.

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

Note: The Import.io API is available only with Import.io paid subscriptions.

To locate the API endpoints specific to a given extractor, perform the following steps:

  • In the left-side navigation pane of the dashboard, select an extractor from the list of your extractors.
  • Click the Integrate tab. The list of API endpoints for the extractor appears.

The following API endpoints are available:

  • Live query API
  • CSV/JSON from the latest successful run
  • Google sheets
  • RSS feed

Live query API

Use this endpoint in your API requests to programmatically run an extractor on a single URL. The API response consists of the extracted data in JSON format. Each API request runs the extractor live and counts as one query toward your plan total. The endpoint contains the URL for one webpage. To retrieve data from another webpage of similar structure, replace the URL in the endpoint with the URL of the other webpage.

CSV/JSON from the latest successful run

Use these endpoints in your API requests to programmatically retrieve the compiled dataset from the most-recent run of an extractor. The API response consists of a GZIP-compressed file containing data in either CSV or JSON format.

Note: You can use the curl -s -L -H ‘Accept-Encoding: gzip’ –compressed <API endpoint> command to decompress the file from the command line.

The following image shows an endpoint for a latest successful CSV run:

The following image shows an endpoint for a latest successful JSON run:

These endpoints return data that your extractor has already collected, therefore using the endpoints do not count as queries toward your plan total.

Note: When running a scheduled extraction, use this endpoint to collect the most current data.

Note: The API response from API requests using this endpoint is newline-delimited in JSON format. The API response returns each URL as a separate JSON object. For details, refer to the JSON response topic.

Google Sheets

Use this endpoint as a Google Sheets formula to extract your data directly into Google Sheets.

Because the API response returns data from the latest extractor run, you can keep your spreadsheet current by setting your extractor to run on a schedule. For example, schedule your extractor to run on Monday at 5am and have instant access to the current data in your Google Sheet when you arrive at the office.

This endpoint returns data that your extractor has already collected, therefore using the endpoint does not count as a query toward your plan total.

RSS feed

Use this endpoint in your API requests to collect information relevant to the history of your runs for a particular extractor.

You can use Zapier to integrate your RSS feed.

This endpoint does not count as a query toward your plan total.