Universal Scraper API

Parameter query

1.Input parameter query


parameter

type

default value

illustrate

source

string

-

Reptile id

context


├─ context.url


└─context.screenshot_type

map[string]interface

-

Specific parameters, user-defined additional information

string

-

Link to a page

number

-

Select the screenshot type (only for png format) (1: full page screenshot, 2: window screenshot)

geo

string

-

area

callback

string

-

callback address

js_render

bool

FALSE

Whether to enable js rendering false: disable true: enable

locale

string

-

language

format

[]string

-

Required return format

 

These parameters help achieve complex requirements from simple HTML crawling to JS rendering, automatic parsing, screenshots and even session simulation

2. Output query parameters

Field name

type

illustrate

created_at

string

Request creation time, in the format of YYYY-MM-DD HH:MM:SS

id

string

Unique identifier in the format s_XXXXXXXXXXXX_XXXX

request

interface{}

Details of the request, including callback, context, format, etc.

callback

string

Callback address, indicating the notification address after the request is completed (if any)

context


├─ context.url


└─context.screenshot_type

map[string]interface

Context, which contains specific request parameters

string

The requested URL, which indicates the URL to be crawled or processed

number

Screenshot type, indicating the screenshot format or the selected screenshot type (1 indicates a certain type)

format

[]string

Request the desired return format, which can be an array of multiple formats (such as html and png)

geo

string

A geolocation code indicating the geographic region from which the request originated (e.g. AE for United Arab Emirates)

js_render

boolean

Whether to enable JavaScript rendering, true means enabled, false means disabled

locale

string

The locale of the request, in the format language-region (e.g. af-ZA for Afrikaans in South Africa)

source

string

The source identifier of the crawler, indicating which crawler the request comes from (for example, uni-scraper)

status

string

The status of the current request, indicating the current progress or status of the task (pending, done, completed, faulted, faulty)

 

BestProxy
BestProxyBestProxy