English
中文简体
  • Getting Started

  • How to use IpStar proxy

  • FAQ

  • Data API

Web Scraper API Document

1. API for submitting crawler tasks
POST

https://scraper.ipstar.io/v1/scraper/web/task

Header
KeyTypeDescriptionExample
AuthorizationstringBearer + api-keyBearer
Body
KeyTypeDescriptionIf necessary
geostringCountry Location CodeOptional
localestringLanguage CodeOptional
js_renderbooleanJS renderOptional
formatarray[string] Result FormatOptional
screen_typeinteger
  • 1: Full-screen Screenshot
  • 2: Visible Area Screenshot
Optional
urlstring Link AddressRequired
2. API for the Crawler Task List
GET

https://scraper.ipstar.io/v1/scraper/web/tasks

Header
KeyTypeDescriptionExample
AuthorizationstringBearer + api-keyBearer
Params
KeyTypeDescriptionIf necessary
start_timestringStart TimeOptional
end_timestringEnd TimeOptional
page_indexintegerPage IndexOptional
page_sizeintegerPage SizeOptional
Result
KeyTypeDescriptionIf necessary
codeinteger200
msgstringsuccess
dataobject
count
integerRequired
list
array
task_id
stringTask IDRequired
url
stringLink AddressRequired
status
integer
  • 0: Pending
  • 1: Running
  • 2: Success
  • 3: Failure
Required
req_num
integerNumber submittedRequired
suc_num
integerNumber successfulRequired
formats
array[string] Result FormatRequired
duration
integerDurationRequired
start_time
stringStart TimeRequired
end_time
stringEnd TimeRequired
create_time
stringCreation timeRequired
result
objectRequired
html
stringHTMLRequired
png
stringPNGRequired