List

get

https://api.diffbot.com/v3/list

Automatically structures a list of items from news index pages, product listings pages, search engine results pages, and other "list-like" pages.

Query Params

url

string

required

Defaults to https://slashdot.org/

Target URL to extract

fields

string

enum

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

Allowed:

timeout

int32

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).

callback

string

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

proxy

string

Specify an IP address of a custom proxy that will be used to fetch the target page. (Ex: &proxy or &proxy=0.0.0.0)

proxyAuth

string

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

useProxy

string

Set to default to use Diffbot's datacenter proxy for this request. none will instruct Extract to not use proxies, even if proxies have been enabled for this particular URL globally.

renderDelay

integer

≤ 180000

Add additional time for rendering before the page is closed and the DOM is extracted. This can cause page timeouts, so a timeout parameter may be needed to extend the timeout. Note that the renderer closes automatically at 180 seconds.

scroll

string

enum

Direct the browser to scroll down the page, to trigger lazy-loaded content.

Allowed:

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful API Response

500Internal Server Error