Skip to main content

How can I access my API key and use API in Octoparse?

Steps to get the API keys and use API.

Updated over a week ago

Octoparse provides robust API support for users wishing to integrate its functionality into their workflows. This guide will walk you through the steps required to access and use the Octoparse API, eligibility requirements, and additional resources for deeper insights.


Requirements for Accessing Octoparse API

The Octoparse API is available only for paid plans (Standard Plan and above). Free plan users cannot access API features.


How to Get the API Key (Token)?

Please refer to the instructions provided in the API Documentation. This document includes guidance and details about available endpoints.

  1. Send a request to obtain the API token:

    • Endpoint: https://openapi.octoparse.com/token

    • Include your Octoparse login credentials in the request body.

  2. You can use tools like Postman to test the request and verify that you can successfully retrieve the token.


How to Use the API

Once you have your API token, you can start using Octoparse APIs:

  1. Check your API access – make sure you’re on a supported plan.

  2. Read the official API documentation – to understand supported endpoints, authentication, and request formats.

  3. Test with Postman (or similar tools) – ensure requests and responses are working as expected.

Additionally, there are helpful tutorials to guide you through the process:


Integration with Third-Party Tools

Octoparse’s API can be integrated with various third-party tools for enhanced automation. To set up such integrations, including those with tools like N8n, refer to the instructions in the API documentation. It provides guidelines for connecting to the Octoparse API.

Did this answer your question?