← All integrations
Import.io + REST API

The Import.io REST API

Run Import.io extractors on your schedule, list their runs and pull results into any system. Every call is plain HTTPS with your API key.

Connects via
REST APIEndpoint
Setup
15 min
Available on
API: every planEndpoints: every plan
Category
Code & API
Start free trialTalk to sales
# Start a run
curl -X POST "https://api.import.io/extractors/$EXTRACTOR_ID/start?_apikey=$IMPORTIO_API_KEY"

# Recent runs, newest first
curl "https://api.import.io/crawlruns/?_apikey=$IMPORTIO_API_KEY&_perpage=5"

# A run's rows: csv, xlsx or json (NDJSON)
curl -L "https://api.import.io/crawlruns/$CRAWLRUN_ID/json?_apikey=$IMPORTIO_API_KEY" -o rows.ndjson

How it connects.

Source

The web

Any public page, rendered, through managed proxies

Engine

Import.io

Rendering, proxy routing, captcha handling, extraction

Path

REST API

https://api.import.io

Destination

REST API

Start extractors, list runs and download results from api.import.io.

Also connects via data endpoints.

What teams do with it.

Run on your schedule

Start an extractor from your orchestrator the moment upstream work finishes, instead of on a fixed timer.

Pull any run, in any format

Download a run’s rows as CSV, Excel or NDJSON, plus its log and captured files.

Change inputs per run

Update an extractor’s inputs through the API, then start it, so one extractor serves many URL lists.

Set it up.

  1. Copy your API key from account settings at app.import.io.
  2. Start a run with POST /extractors/{extractorId}/start.
  3. Find the run with GET /crawlruns/ and download results with GET /crawlruns/{crawlrunId}/{fileType}.

Questions.

What format is JSON output?

NDJSON: one JSON object per line. Read it line by line, or split on newlines and parse each line.

Does the Live Query API count as a query?

Yes. Each Live Query request runs the extractor on one URL and counts as one query. Latest-run downloads don’t.

How do I authenticate?

Pass your API key as the _apikey query parameter. Copy it from account settings at app.import.io.

Is the API on every plan?

Yes. The trial and Standard include rate-limited API access. Professional and Advanced include full API access and webhooks.

Do endpoint downloads count as queries?

No. The latest-run CSV, JSON and Google Sheets endpoints return data your extractor already collected, so they don’t count toward your plan. Only the Live Query API runs an extraction per request.

Related integrations.

All 50 integrations

EndpointREST API

Python & pandas

Latest-run data into a DataFrame in three lines.

Setup 5 minEndpointREST API

Node.js

Fetch extractor results in Node with the built-in fetch.

Setup 5 minEndpointREST API

R

Extractor results into a tibble with httr2 and readr.

Setup 5 minWebhookEndpoint

AWS Lambda

A function URL that lands every run in S3 or DynamoDB.

Setup 15 min

Build on
the live web.

Start free trialTalk to sales