Replace a parser

PUT

/v1/parsers/{id}

Full replacement, not a patch. v1 and v2 config formats cannot be mixed.

Authorizations

• apiKeyHeader
• apiKeyQuery

Parameters

Path Parameters

id

required

string

Parser ID

Request Body ^required

object

name

Required unless config.name supplies it.

string

<= 120 characters

description

required

Required human/agent-readable purpose.

string

url

Optional documentation URL for the resource.

string format: uri

config

required

A v2 flat parser config. See the Parsers guide for HTML, JSON, API, regex, list mode, field typing, and transforms.

object

name

string

type

required

string

Allowed values: html json api regex

fields

required

Array<object>

>= 1 items <= 64 items

object

key

additional properties

any

item_selector

string

item_selector_type

string

Allowed values: css xpath

item_path

string

json_source

object

key

additional properties

any

key

additional properties

any

scrape_config

Fetch override. Credit price depends on browser and proxy settings.

object

useBrowser

boolean

waitSeconds

number

waitForBrowser

string

proxy

default, highquality, hardcore, premium, or premium:<country code>.

string

visibility

string

default: private

Allowed values: private public

Responses

200

Parser replaced.

object

id

string

name

string

format

string

version

integer

updated_at

string format: date-time

401

Missing or invalid API key.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string

404

Resource missing or not owned by this account.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string

422

Validation failed.

object

error

required

string

Example

invalid request

field

Field that failed validation.

string

detail

string

hint

string