Overview

Introduction

To use the Octoparse OpenAPI, you will first need to have a Standard, Professional or Enterprise account with at least one working task. (Haven’t got an account? Sign up here.)

The Octoparse OpenAPI allows you to retrieve the extracted data, task information and even control tasks without having to interact with the Octoparse App, enabling seamless data integration with your own applications.

Document Version

Current version: V1.0

Swagger Json file

Contact

Contact: Octoparse support team

Email: support@octoparse.com

URI Standard

All requests should be URL encoded with the base URL.

BaseURL: https://openapi.octoparse.com

For example: the request URL for 'Search Task' should be: GET https://openapi.octoparse.com/task/search?taskGroupId={taskGroupId}

Note: {xxxx} in this document represents placeholder and users need to replace it with real value. For example, if your task group id is abc, then the URL should be https://openapi.octoparse.com/task/search?taskGroupId=abc

Instruction

Octoparse limits API usage to 20 requests/second. Please reduce the frequency if you receive status code ‘429’.

The response HTTP status code should be ‘200’. If not, please refer to References to solve the problem.

Permission Instruction

Service	API	Permission
Access Token	Obtain a New Token	All users
Access Token	Refresh Token	All users
Task Group	Get Task Group Information	Standard, Professional, Enterprise
Task	Search Task	Standard, Professional, Enterprise
Task	Get Action Parameters	Professional, Enterprise
Task	Update Action Value	Professional, Enterprise
Cloud Extraction	Start Task	Professional, Enterprise
Cloud Extraction	Stop Task	Professional, Enterprise
Cloud Extraction	Get Task Status	Professional, Enterprise
Cloud Extraction	Get Task Status V2	Professional, Enterprise
Data	Get Non-Exported Data	Standard, Professional, Enterprise
Data	Mark Data as Exported	Standard, Professional, Enterprise
Data	Get Data by Offset	Standard, Professional, Enterprise
Data	Remove Data	Standard, Professional, Enterprise

Make sure that your account has permission to use the services. If not, please upgrade your account.

Request fails?

All the requests will return a requestId. You can provide the requestId to our support team to help you troubleshoot the issue.

Access Token

Obtain a New Token

Before getting access to the Octoparse OpenAPI, you will need your username and password to get a new Access Token.

https://openapi.octoparse.com/token

Permission: All users

Request Header

Field	Type	Description
Content-Type required	String	application/json

Request Header Example

{
    "Content-Type": "application/json"
}

Field	Type	Description
username required	String	Account email address or username
password required	String	Account password
grant_type required	String	password

Request Body Example

{
    "username": "account email address or username",
    "password": "account password",
    "grant_type": "password"
}

Response Fields

Field	Type	Description
data required	Object[]	Response data
access_token required	String	Access Token
expires_in required	Date	Access Token expiration time (in seconds)(The same token can be used repeatedly within this time frame.)
token_type required	String	Token type
refresh_token required	String	The Token to refresh Access Token
requestId required	String	Request ID

Response Example

{
    "data": {
        "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
        "expires_in": "86399",
        "token_type": "Bearer",
        "refresh_token": "SSc1Uf56BRfNfSewsZ0FJCHjfqI5FwGW3k2QfiRplN8",
    },
    "requestId": "0HMD3FSLHJRVO:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "Invalid.Grant",
        "message": "Incorrect username or password."
    },
    "requestId": "0HMD43G9J9JV9:00000001"
}

Refresh Token

Once an Access Token expires, you can refresh Access Token with "refresh_token" in the response.

https://openapi.octoparse.com/token

Permission: All users

Request Header Example

{
    "Content-Type": "application/json"
}

Field	Type	Description
refresh_token required	String	Token to refresh Access Token
grant_type required	String	refresh_token

Request Body Example

{
    "refresh_token": "5p6RhlU0A9AYPLpzfdYG-pyK97uqffrRDG4fgrFv4eo",
    "grant_type": "refresh_token"
}

Response Fields

Field	Type	Description
data required	Object[]	Response data
access_token required	String	New Access Token
expires_in required	Date	Access Token expiration time (in seconds)(The same token can be used repeatedly within this time frame.)
token_type required	String	Token type
refresh_token required	String	Token to refresh Access Token
requestId required	String	Request ID

Response Example

{
    "data": {
        "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
        "expires_in": "86399",
        "token_type": "Bearer",
        "refresh_token": "SSc1Uf56BRfNfSewsZ0FJCHjfqI5FwGW3k2QfiRplN8",
    },
    "requestId": "0HMD3FSLHJRVO:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Task Group

Get Task Group Information

Get information of all task groups.

https://openapi.octoparse.com/taskGroup

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
}

Response Fields

Field	Type	Description
data required	Object[]	Response data
taskGroupId required	Int	Task group ID
taskGroupName required	String	Task group name
requestId required	String	Request ID

Response Example

{
    "data": [
        {
            "taskGroupId": 23894,
            "taskGroupName": "Task Group 1"
        },
        {
            "taskGroupId": 35489,
            "taskGroupName": "Task Group 2"
        }
    ],
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description
requestId required	String	Request ID

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Task

Search Task

Get task information based on task group ID.

https://openapi.octoparse.com/task/search

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
}

Field	Type	Description
taskGroupId required	int	Task group ID

Request Example

https://openapi.octoparse.com/task/search?taskGroupId=23894

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object[]	Response data
taskId required	String	Task ID
taskName required	String	Task name

Response Example

{
    "data": [
        {
            "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
            "taskName": "Task Group 1"
        },
        {
            "taskId": "86b9bdf7-9aaa-22236-9ccf-b3279469df01",
            "taskName": "Task Group 2"
        }
    ],
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "InvalidParameter",
        "message": "Invalid field"
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Duplicate Task

Duplicate a task to a specified group.

https://openapi.octoparse.com/task/copy

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {access_token}

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
}

Field	Type	Description
taskGroupId required	int	Task group ID (If not specified, the task will be duplicated to the current task group)
taskId required	string	Task ID

Request Example

https://openapi.octoparse.com/task/copy?taskId=a2de44e9-092c-453c-bfe3-fe9e71dff12345&taskGroupId=100

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object	Response data
taskId required	String	ID of the duplicated task

Response Example

{
    "data": {
        "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
        "taskName": "Octoparse"
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "InvalidTaskId",
        "message": "Invalid Id"
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Get Action Parameters

Get task parameters based on the specific action. For example, the URL from ‘Go To The Web Page’ action, text value from ‘Enter Text’ action and text list/URL list from ‘Loop Item’ action.

https://openapi.octoparse.com/task/getActions

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskIds required	String[]	Task IDs list
actionTypes required	String[]	Action types. Currently supporting "LoopAction" (Loop Item), "NavigateAction" (Go to Web Page), and "EnterTexAction" (Enter Text).

Request Body Example

{
    "taskIds": [
        "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f"
    ],
    "actionTypes": [
        "LoopAction",
        "NavigateAction",
        "EnterTextAction"
    ]
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object[]	Response data
taskId required	String	Task ID
actions required	Object[]	Action parameter value. Different action types give different response data. You can refer to Action Parameters for more details.

{
    "data": [
        {
            "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
            "actions": [
                {
                    "actionType": "NavigateAction",
                    "name": "Go to Web Page",
                    "actionId": "5mzlvhcynky",
                    "url": "http://my.xcar.com.cn/thread/hot.htm"
                }
            ]
        }
    ],
    "requestId": "0HMCVDHG1V3E6:00000002"
}

{
    "data": [
        {
            "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
            "actions": [
                {
                    "actionType": "EnterTextAction",
                    "name": "Enter Text",
                    "actionId": "8sfflvhkpd",
                    "text": "Notebook"
                }
            ]
        }
    ],
    "requestId": "0HMCVDHG1V3E6:00000002"
}

{
    "data": [
        {
            "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
            "actions": [
                {
                    "actionType": "LoopAction",
                    "loopType": "URLList",
                    "loopItems": [
                        "http://www.octoparse"
                    ],
                    "name": "Loop URLs",
                    "actionId": "ce1wg4nytr"
                },
                {
                    "actionType": "LoopAction",
                    "loopType": "TextList",
                    "loopItems": [
                        "Octoparse"
                    ],
                    "name": "Loop Texts",
                    "actionId": "6l3bq70xaka"
                }
            ]
        }
    ],
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description
requestId required	String	Request ID

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Move Task

Move a task to a specified task group.

https://openapi.octoparse.com/task/moveToGroup

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {access_token}

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
}

Field	Type	Description
taskGroupId required	int	Task group ID
taskId required	string	Task ID

Request Example

https://openapi.octoparse.com/task/copy?taskId=a2de44e9-092c-453c-bfe3-fe9e71dff12345&taskGroupId=100

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object	Response data
moved required	Bool	"true" means successful

Response Example

{
      "data":{
              "moved":true,
              
          },
      "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "InvalidTaskId",
        "message": "Invalid task ID"
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Update Action Parameters

Update the text value in the Enter Text action or the URL in the Go to Web Page action.

https://openapi.octoparse.com/task/updateActionProperties

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID
actions required	Object[]	Action parameters to be updated. Please refer to Action Parameters.
actionType required	String	Action type. Currently supporting "NavigateAction" (Go to Web Page), "EnterTextAction" (Enter Text) and "LoopAction" (Loop Item).
actionId required	String	Action API call name. Get it by clicking the API icon in the action setting or using Get Action Parameters.
properties required	Object[]	Action parameter information. Check the currently supported parameters at Action Parameters.
name required	String	Parameter name. Check the currently supported parameters at Action Parameters.
value required	String	Parameter value

Request Body Example (EnterTextAction)
Request Body Example（NavigateAction）

{
    "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
    "actions": [
        {
            "actionType": "EnterTextAction",
            "actionId": "ce1wg4nytr",
            "properties": [
                {
                    "name": "TextToSet",
                    "value": "Octoparse 123"
                }
            ]
        }
    ]
}

{
    "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
    "actions": [
        {
            "actionType": "NavigateAction",
            "actionId": "1j4prvwsy1z",
            "properties": [
                {
                    "name": "Url",
                    "value": "https://www.octoparse.com"
                }
            ]
        }
    ]
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object	Response data
message required	String	Update result

Response Example

{
    "data": {
        "message": "success"
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "InvalidParameter.Required",
        "message": "taskId cannot be empty."
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Update Loop Item List

Update the text list or the URL list in a Loop Item.

https://openapi.octoparse.com/task/updateLoopItems

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID
actionId required	String	Action API call name. You can get it by clicking the API icon in the settings of one action or using Get Action Parameters.
loopType required	String	Loop mode. TextList (Text list) or UrlList (List of URLs).
loopItems required	String[]	The value to update to.
isAppend required	bool	Add the value to the current list or replace the current list. "true" means to add the value to the current list; "false" means to replace the current list.

Request Body Example

{
    "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
    "actionId": "ewwesadxa",
    "loopType": "TextList",
    "loopItems": [
        "https://www.octoparse.com/"
    ],
    "isAppend": false
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object	Response data
message required	String	Update result

Response Example

{
    "data": {
        "message": "success"
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "TaskUpdateFail",
        "message": "Update fails."
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Update Task URLs

Update the URLs in a task with a URL file link.

https://openapi.octoparse.com/task/urls:file

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {access_token}
Content-Type required	String	multipart/form-data

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "multipart/form-data"
}

Field	Type	Description
taskId required	string	Task ID

Field	Type	Description
file required	File	URL path: C:\Username\URLs.txt

Response Fields

Field	Type	Description
requestId required	String	Task ID
data required	Object	Response data

Response Example

{
    "data": null,
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "InvalidTaskId",
        "message": "Invalid task ID"
    },
    "requestId": "0HMCVDHG1V3E6:00000002"
}

Cloud Extraction

Start Task

Run a task in the Cloud.

https://openapi.octoparse.com/cloudextraction/start

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID

Request Body Example

{
    "taskId": "6bb3b0c8-1e1d-432f-bc42-7206567219b"
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object[]	Response data

Response Example

{
    "data": null,
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Stop Task

Stop a task in the Cloud

https://openapi.octoparse.com/cloudextraction/stop

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID

Request Body Example

{
    "taskId": "6bb3b0c8-1e1d-432f-bc42-7206567219b"
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object[]	Response data

Response Example

{
    "data": null,
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Get Task Status

Get the status of tasks based on task IDs.Request frequency: 1 request/5 seconds.

https://openapi.octoparse.com/cloudextraction/statuses

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
    "Content-Type":"application/json"
}

Field	Type	Description
taskIds required	String[]	A list of Task IDs

Request Body Example

{
    "taskIds": [
        "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
        "86b9bdf7-9aaa-22236-9ccf-b3279469df01"
    ]
}

Response Fields

Field	Type	Description
data required	Object[]	Response data
taskId required	String	Task ID
taskName required	String	Task name
status required	String	Task Status: Unexecuted=Have not been run; Waiting=Waiting to run; Extracting=Running; Stopped=Run stopped; Finished=Run completed
requestId required	String	Request ID

Response Example

{
    "data": [
        {
            "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
            "taskName": "Octoparse",
            "status": "Extracting"
        },
        {
            "taskId": "86b9bdf7-9aaa-22236-9ccf-b3279469df01",
            "taskName": "Octoparse2",
            "status": "Stopped"
        }
    ],
    "requestId": "0HMD469L0I8R0:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Get Task Status V2

Get the status of tasks based on task IDs. Request frequency: 5 requests/second

https://openapi.octoparse.com/cloudextraction/statuses/v2

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
    "Content-Type":"application/json"
}

Field	Type	Description
taskIds required	String[]	A list of Task IDs

Request Body Example

{
    "taskIds": [
        "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
        "86b9bdf7-9aaa-22236-9ccf-b3279469df01"
    ]
}

Response Fields

Field	Type	Description
data required	Object[]	Response data
taskId required	String	TaskId
status required	String	Task Status: Unexecuted=Have not been run; Waiting=Waiting to run; Extracting=Running; Stopped=Run stopped; Finished=Run completed
currentTotalExtractCount required	Int	The amount of data collected
executedTimes required	Int	Execution times
subTaskCount required	Int	Subtask number
nextExecuteTime required	String	Next execution time
startExecuteTime required	String	Task start time
endExecuteTime required	String	Task end time
requestId required	String	Request ID

Response Example

{
    "data": [
        {
            "taskId": "a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f",
            "status": "Extracting",
            "currentTotalExtractCount": 0,
            "executedTimes": 1,
            "subTaskCount": 1,
            "nextExecuteTime": "2018-04-04T20:34:20.973",
            "endExecuteTime": "2018-04-04T18:34:20.973",
            "startExecuteTime": "2018-04-04T18:34:20.973"
        }
    ],
    "requestId": "0HMD469L0I8R0:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Get Subtask Status

Get the subtask status of the latest run of a task.

https://openapi.octoparse.com/cloudextraction/task/subtasks

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {access_token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization":"Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
    "Content-Type":"application/json"
}

Field	Type	Description
taskId required	String	Task ID
page required	Int	Page number
size required	Int	Number of subtasks a page (1 to 20)

Request Example

https://openapi.octoparse.com/cloudextraction/task/subtasks?taskId=11d18cb2-6209-4b35-9243-c33a07be45b0&page=1&size=20

Response Fields

Field	Type	Description
data required	Object[]	Response data
subTaskId required	String	Subtask ID
status required	String	Subtask status：Waiting - wait to be run; Sent- Sent to a Cloud node to run; Extracting; Stopped; Finished
requestId required	String	Request ID

Response Example

{
    "data": [
        {
            "subTaskId": "1ea88321-6627-43db-896b-851dba5d69ec",
            "status": "Extracting"
        }
    ],
    "requestId": "0HMD469L0I8R0:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Start subtasks

Start subtasks in the Cloud.

https://openapi.octoparse.com/cloudextraction/subtasks:start

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {access_token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID
subTaskIds required	String[]	Subtask IDs

Request Body Example

{
    "taskId": "11d18cb2-6209-4b35-9243-c33a07be45b0",
    "subTaskIds": [
        "8936bce4-e4d5-4134-8cce-5f1a38211c8f"
    ]
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object[]	Response data

Response Example

{
    "data": null,
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Stop Subtasks

Stop subtasks in the Cloud.

https://openapi.octoparse.com/cloudextraction/subtasks:stop

Permission: Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {access_token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID
subTaskIds required	String[]	Subtask IDs

Request Header Example

{
    "taskId": "11d18cb2-6209-4b35-9243-c33a07be45b0",
    "subTaskIds": [
        "8936bce4-e4d5-4134-8cce-5f1a38211c8f"
    ]
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object[]	Response data

Response Example

{
    "data": null,
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Data

Get Non-Exported Data

Get data that has never been exported. Please use "Mark Data as Exported" to mark the data as exported data after getting the data successfully, or the data would still be considered as non-exported data.(Data size should not exceed 4M when up to 200 data rows are exported and should not exceed 8M when more than 200 data rows are exported)

https://openapi.octoparse.com/data/notexported

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
}

Field	Type	Description
taskId required	String	Task ID
size required	String	The amount of data rows(range from 1 to 1000)

Request Example

https://openapi.octoparse.com/data/notexported?taskId=a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f&size=4

Response Fields

Field	Type	Description
data required	Object[]	Response data
data required	Object	Data scraped by the task
total required	Int	Total number of data rows in the task
current required	Int	The number of data rows exported

Response Example

{
    "data": {
        "total": 100000,
        "current": 4,
        "data": [
            {
                "State": "Texas",
                "City": "Plano"
            },
            {
                "State": "Texas",
                "City": "Houston"
            },
            {
                "State": "Texas",
                "City": "Austin"
            },
            {
                "State": "Texas",
                "City": "Arlington"
            }
        ]
    },
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Mark Data as Exported

Mark the data as exported, or the data would still be considered as non-exported data.

https://openapi.octoparse.com/data/markexported

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID

Request Body Example

{
    "taskId": "6bb3b0c8-1e1d-432f-bc42-7206567219b"
}

Response Fields

Field	Type	Description
data required	Object[]	Response data
requestId required	String	Request ID

Response Example

{
    "data": null,
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Get Data by Offset

When the offset is set to 0, you can get the data from the first data row and get a new offset in the response. You can use the offset returned to get the next batch of data rows. For example, when you set offset=0, size=100 in your first request, and the offset returned is offset=1024, you should use offset=1024, size=100 for the second request and get a new offset=1124. Then you should use offset=1124, size=100 for the third request.

https://openapi.octoparse.com/data/all

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
}

Field	Type	Description
taskId required	String	Task ID
offset required	Number	Data offset. When offset=0, you can get data from the first data row.
size required	Number	The amount of data rows(range from 1 to 1000).

Request Example

https://openapi.octoparse.com/data/all?taskId=a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f&offset=0&size=4

Response Fields

Field	Type	Description
data required	Object	Response data
data required	Object	Task data
total required	Int	Total number of data rows in the task.
restTotal required	Int	The number of data rows remained.
offset required	Int	Data offset for the next request.
requestId required	String	Request ID

Response Example

{
    "data": {
        "offset": 4,
        "total": 100000,
        "restTotal": 99996,
        "data": [
            {
                "State": "Texas",
                "City": "Plano"
            },
            {
                "State": "Texas",
                "City": "Houston"
            },
            {
                "State": "Texas",
                "City": "Austin"
            },
            {
                "State": "Texas",
                "City": "Arlington"
            }
        ]
    },
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Remove Data

Delete all the data of a task.

https://openapi.octoparse.com/data/remove

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {Access Token}
Content-Type required	String	application/json

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw",
    "Content-Type": "application/json"
}

Field	Type	Description
taskId required	String	Task ID

Request Body Example

{
    "taskId": "6bb3b0c8-1e1d-432f-bc42-7206567219b"
}

Response Fields

Field	Type	Description
requestId required	String	Request ID
data required	Object[]	Response data

Response Example

{
    "data": null,
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Get Data From a Designated Batch by Offset

https://openapi.octoparse.com/data/lotno/all

Permission: Standard, Professional and Enterprise Account

Request Header

Field	Type	Description
Authorization required	String	Bearer {access_token}

Request Header Example

{
    "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE2MzY0NjIyNzAsImV4cCI6MTYzNjU0ODY2OSwiaXNzIjoiaHR0cDovL3Rlc3QuaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiY2xpZW50X2lkIjoiT2N0b3B1cyIsInN1YiI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImF1dGhfdGltZSI6MTYzNjQ2MjI3MCwiaWRwIjoibG9jYWwiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjllOGJiM2VhLWUwMWQtNGFlZC05ODM3LTVhMWUyODg0NWI5ZSIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0d2VuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHdlbiIsInVuaXF1ZV9uYW1lIjoidGVzdHdlbiIsInJlZ2lzdGVyX2RhdGUiOiIxMS8wNC8yMDE2IDA4OjM4OjE2ICswODowMCIsImxhc3RfbG9naW5fZGF0ZSI6IjA0LzIyLzIwMTkgMDk6MDE6MDIgKzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIwMS8yMy8yMDE5IDA4OjMwOjMxICswODowMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbCI6IndlbmRpQHNraWVlci5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwic2NvcGUiOlsiZW1haWwiLCJvcGVuaWQiLCJyb2xlcyIsIm9mZmxpbmVfYWNjZXNzIl0sImFtciI6WyJwd2QiXX0.ARhbBfzI1xS6yo-Ue1CFHzMaUIfzw4gJlubNBOkUT4SSTlhuS4bVQ4t4UHuYGbE9VX6XgNVgkcDnx6XapqcPohSy7vPv9TIAsjtbrQSA3mj13SnVVAPWwfAVJ-I7g9HDnyPEEOVSvmZUJhiz-irH5L0ojbnt3ck2rQ9tIFuSd7j2eh5BS4ItjNoHY00rh_QPZltk66a9q-fNE33GrxOaXUdHH47WMlsENnh1gybB7QtGtd6bZ982Qa9JljpFnZWSdEf4VfkN4JmhkUTTC908DqS3stT-LD-9tpztFwB54sd0D4CyOBnESkKrUwjxchYYZo4l1O7auiZVGV48YhZYMw"
}

Field	Type	Description
taskId required	String	Task Id
lotno required	String	Batch ID
offset required	Number	Data offset. When offset=0, you can get data from the first data row.
size required	Number	The amount of data rows (range from 1 to 1000).

Request Example

https://openapi.octoparse.com/data/lotno/all?taskId=a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f&lotno=638590565765988670&offset=0&size=4

Response Fields

Field	Type	Description
data required	Object	Response data
data required	Object	Task data
total required	Int	Total number of data rows in the batch.
restTotal required	Int	The number of data rows remained in the batch.
offset required	Int	Data offset for the next request.
requestId required	String	Request ID

Response Example

{
    "data": {
        "offset": 4,
        "total": 100000,
        "restTotal": 99996,
        "data": [
            {
                "State": "Texas",
                "City": "Plano"
            },
            {
                "State": "Texas",
                "City": "Houston"
            },
            {
                "State": "Texas",
                "City": "Austin"
            },
            {
                "State": "Texas",
                "City": "Arlington"
            }
        ]
    },
    "requestId": "0HMD469L0I8Q1:00000001"
}

Error Fields

Name	Type	Description
requestId required	String	Request ID
error required	Object	Error message. Please refer to the Error Code for more information.
code required	String	Error Code
message required	String	Error description

Error Example

{
    "error": {
        "code": "ServerError",
        "message": "Internal Server Error"
    },
    "requestId": "0HMD469L0I8R0:00000001"
}

Sample Code

Python Code

Python Code (Other languages will be coming out soon.)

https://openapi.octoparse.com/Sample

References

Error Code

Service	Status Code	Error Code	Error Message
General	400	InvalidParameter	Wrong filed
General	400	InvalidParameter.Required	{param} cannot be empty
General	400	InvalidParameter.MaxValue	{param} cannot be greater than {value}
General	400	InvalidParameter.MinValue	{param} must be larger than {value}
General	400	InvalidParameter.Range	{param} should be between {min} and {max}
General	400	InvalidParameter.EnumDataType	{type} has unsupported data type
General	401	Unauthorized	Invalid access_token
General	403	PermissionDenied	Permission denied
General	429	LimitTimes	The request frequency has exceeded the limit.
General	500	ServerError	Server internal error
General	503	ServiceUnavailable	Service unavailable
Identity	400	Invalid.Grant	Invalid grant. Please refer to the error details.
storage	400	LimitTraffic	The request body is too large and exceeds the maximum permissible limit. Please limit request body size to 4M for each call (or 8M if it contains more than 200 lines).
TaskRule	400	InvalidParameter.GroupId	Invalid group ID
TaskRule	400	Template.Permission	Template does not exist or it is not open to you.
TaskRule	400	Template.Level	The template is only available for {level} or higher plan.
TaskRule	400	TaskCreate.Permission	Cannot create tasks for other users.
TaskRule	400	InvalidParameter.TaskId	Invalid task ID or this task does not belong to you.

Action Parameters

Loop Item (LoopAction)

Parameter Name	Type	Description	Whether updates are supported
actionId	String	Action API call name	No
actionType	String	LoopAction	No
name	String	Action name	No
loopType	String	Currently supported types: UrlList (List of URLs) and TextList (Text List)	No
loopItems	object[]	Loop Item list content	Yes

Go to Web Page (NavigateAction)

Parameter Name	Type	Description	Whether updates are supported
actionId	String	Action API call name	No
actionType	String	NavigateAction	No
name	String	Action name - Currently supported types: Url	No
url	String	URL	Yes

Enter Text (EnterTextAction)

Parameter Name	Type	Description	Whether updates are supported
actionId	String	Action API call name	No
actionType	String	EnterTextAction	No
name	String	Action name - Currently supported types: TextToSet	No
text	String	Text value	Yes