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

Nimbleway Crawl API

The Crawl API from Nimbleway — 2 operation(s) for crawl.

Nimbleway Crawl API is one of 11 APIs that Nimbleway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://sdk.nimbleway.com.

4 operations 2 paths 12 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://sdk.nimbleway.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nimbleway Crawl API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 4

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

Crawl 4
POST
/v1/crawl
Create Crawl
body → 200400402429500
GET
/v1/crawl
List Crawls
3 params → 200400402429500
GET
/v1/crawl/{id}
Crawl by ID
1 param → 200400402404429500
DELETE
/v1/crawl/{id}
Cancel Crawl
1 param → 200400402404429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ExtractPayload (24 properties), CrawlPayload (13 properties), BrowserAction (11 properties), NetworkCaptureFilter (6 properties). Each schema is shown below with its type and property counts.

ExtractPayload
object
Request body model for the /extract endpoint
24 properties 1 required
Error400
object
4 properties 2 required
CrawlPayload
object
13 properties 1 required
Parser
object
Custom extraction recipe defining what data to extract and how to structure it. Each property represents a field in the output.
ParserExtractor
Error429
object
2 properties 2 required
PostProcessor
object
Transform extracted data
1 property 1 required
BrowserAction
object
An action to perform in the browser (one of: goto, wait, waitforelement, click, press, fill, scroll, autoscroll, screenshot, getcookies, fetch)
11 properties
ParserSelector
Error402
object
2 properties 2 required
NetworkCaptureFilter
object
Configuration for capturing network requests made by the page
6 properties
Error500
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimbleway-crawl-api-openapi.yml Raw ↑

Other APIs Nimbleway publishes across the network.

Nimbleway Agents API
Nimbleway Domain Knowledge API
Nimbleway Extract API
Nimbleway Fast SERP API
Nimbleway Jobs API
Nimbleway Map API
Nimbleway Media API
Nimbleway Search API
Nimbleway SERP API
Nimbleway Tasks API