Octoparse OpenAPI

Octoparse OpenAPI reference for authentication, task management, cloud extraction, and data export.

Use the Octoparse OpenAPI to manage tasks, run cloud extractions, and retrieve scraped data programmatically.

Before you start

To use the Octoparse OpenAPI, you need a Standard, Professional, or Enterprise account with at least one working task. Sign up here if you don’t have one yet.

Current API version: v1.0

Base URL

All requests must be URL-encoded against the base URL:

https://openapi.octoparse.com

Placeholders are shown as {xxxx} and need to be replaced with real values. For example, the request URL for Search Task is:

GET https://openapi.octoparse.com/task/search?taskGroupId={taskGroupId}

If your task group ID is abc, the URL becomes https://openapi.octoparse.com/task/search?taskGroupId=abc.

Rate limits

Octoparse limits API usage to 20 requests per second. If you receive a 429 status code, slow your request rate.

A successful response returns HTTP 200. For other status codes, see the References section in each endpoint.

Permissions

Make sure your account has permission to use each service. If not, upgrade your account.

Service	API	Required plan
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	Duplicate Task	Standard, Professional, Enterprise
Task	Move Task	Standard, Professional, Enterprise
Task	Get Action Parameters	Professional, Enterprise
Task	Update Task Parameters	Professional, Enterprise
Task	Update Action Parameters	Professional, Enterprise
Task	Update Loop Item List	Professional, Enterprise
Task	Update Task URLs	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
Cloud Extraction	Get Subtask Status	Professional, Enterprise
Cloud Extraction	Start Subtasks	Professional, Enterprise
Cloud Extraction	Stop Subtasks	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	Get Data From a Designated Batch by Offset	Standard, Professional, Enterprise
Data	Remove Data	Standard, Professional, Enterprise

Troubleshooting

Every response includes a requestId. If a request fails, share the requestId with the Octoparse support team to help diagnose the issue.