English
中文简体
  • Getting Started

  • How to use IpStar proxy

  • FAQ

  • Data API

Video Downloader APl Document

1. Submit Video API
POST

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

Header
KeyTypeDescriptionExample
AuthorizationstringBearer + api-keyBearer
Body
KeyTypeDescriptionIf necessary
typestringTypeOptional
video_urlsarrayVideo LinkRequired
qualitynumberVideo QualityOptional
storage_typestringStorage TypeOptional
storage_infoobjectStorage ConfigurationOptional
bucket_name
stringBucket NameOptional
endpoint
stringEndpoint URLOptional
access_id
stringAuthentication IDOptional
access_key_secret
stringAuthentication KeyOptional
sublangsstringSubtitle LanguageOptional
meta_infobooleanIncludes MetadataOptional
Result
KeyTypeDescriptionExample
codeintegerStatus Code200
msgstringMessagesuccess
dataobject
count
integerSuccess Count5
2. Video List API
GET

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

Header
KeyTypeDescriptionExample
AuthorizationstringBearer + api-keyBearer
Params
KeyTypeDescriptionIf necessary
statusstring
  • 0: Pending
  • 1: Running
  • 2: Success
  • 3: Download failed
  • 4: Upload failed
  • 5: Task Cancelled
Optional
page_indexstringPage IndexOptional
page_sizestringPage SizeOptional
Result
KeyTypeDescriptionIf necessary
codeintegerVideo Quality200
msgstringStorage Typesuccess
dataobjectStorage Configuration
count
integerBucket NameRequired
list
arrayBucket Name
task_id
stringTask IDRequired
video_url
stringVideo LinkRequired
quality
integerVideo QualityRequired
sublangs
stringSubtitle LanguageRequired
meta_info
booleanIncludes MetadataRequired
start_time
stringStart TimeRequired
end_time
stringEnd TimeRequired
packsize
integerData UsageRequired
status
integerStatusRequired
storage_type
integerStorage TypeRequired
storage_info
stringStorage InformationRequired
result
objectRequired
download_url
StringDownload AddressRequired
sub_url
StringSubtitle AddressRequired
meta_url
StringMetadata AddressRequired