Extract with Custom API

Extracts a page using a modified Extract API or a custom ruleset.

byDiffbot Extract API (Web Extraction)

120calls

N/Alatency

Discover -> Inspect -> Call

Call setup

Tool IDdiffbot.default.retrieve.v1.f2a0cf24

Request parametersJSON

Before this Call

1 credit / call

The final charge is settled from actual provider usage and will appear in Usage.

Field reference

apistringRequired

Name of your Custom API

urlstringRequired

Target URL to extract (url encoded)

fieldsstringOptional

Specify optional fields to be returned from any fully-extracted pages (e.g. `fields=querystring,links`)

timeoutintegerOptional

Sets a value in milliseconds to wait for the retrieval/fetch of content from the requested URL. The default timeout for the third-party response is 30 seconds (30000).

callbackstringOptional

Use for jsonp requests. Needed for cross-domain ajax.

proxystringOptional

Specify an IP address of a [custom proxy](https://docs.diffbot.com/reference/using-proxies#how-to-use-proxies) that will be used to fetch the target page. (Ex: `&proxy` or `&proxy=0.0.0.0`)

proxyAuthstringOptional

Used to specify the authentication parameters that will be used with a custom proxy specified in the &proxy parameter. (Ex: `proxyAuth=username:password`)

useProxystringOptional

Set to `default` to use [Diffbot's datacenter proxy](https://docs.diffbot.com/reference/using-proxies#how-to-use-proxies) for this request. `none` will instruct Extract to not use proxies, even if proxies have been enabled for this particular URL globally.