Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Import.io Extractor API

Create, configure, run, and manage web data extractors.

Import.io Extractor API is one of 5 APIs that Import.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Extractor. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 7 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.import.io.

9 operations 7 paths 5 schemas 1 DELETE3 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.import.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Import.io Extractor API declares 1 security scheme for authenticating requests. An API key is passed in the query as _apikey (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key obtained from the Import.io dashboard User Settings.

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Extractor 9

Create, configure, run, and manage web data extractors.

GET
/extractors/
List extractors
listExtractors 5 params → 200401
GET
/extractors/{extractorId}
Get extractor
getExtractor 2 params → 200401404
DELETE
/extractors/{extractorId}
Archive extractor
deleteExtractor 2 params → 200401404
GET
/extractors/{extractorId}/inputs
Get extractor inputs
getExtractorInputs 2 params → 200401404
PUT
/extractors/{extractorId}/inputs
Update extractor inputs
updateExtractorInputs 2 params body → 200401404500
POST
/extractors/{extractorId}/start
Start extractor
startExtractor 2 params → 200401404500
POST
/extractors/{extractorId}/stop
Stop extractor
stopExtractor 2 params → 200401404500
POST
/extractors/{extractorId}/duplicate
Duplicate extractor
duplicateExtractor 2 params → 200401403404500
POST
/extractors/{extractorId}/credentials
Update extractor credentials
updateExtractorCredentials 2 params body → 200401403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Extractor (10 properties), Meta (5 properties), Error (3 properties), Credentials (2 properties). Each schema is shown below with its type and property counts.

Extractor
object
10 properties
Error
object
3 properties
Meta
object
Common metadata included on most resources.
5 properties
ExtractorInputs
object
1 property
Credentials
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

import-io-extractor-api-openapi.yml Raw ↑

Other APIs Import.io publishes across the network.

Import.io Crawlrun API
Import.io Report API
Import.io ReportRun API
Import.io User API