> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Oxylabs

> How to set up the Oxylabs connector, plus the actions that are available.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/oxylabs/filled/svg" alt="Oxylabs" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span>v1.0.0</span></div>
    <div><a href="/connectors/oxylabs/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">7 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">Developer Tools</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Credentials" href="/connectors/oxylabs/guides/connector-profile/api-credentials" icon="https://stackone-logos.com/api/oxylabs/filled/svg" horizontal>
        Uses API user credentials (username and password) created in the Oxylabs dashboard. Provides access to Web Scraper API a...
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

    See the guide for the authentication type chosen in the Connector Profile:

    <Columns cols={2}>
      <Card title="Link Account · API Credentials" href="/connectors/oxylabs/guides/link-account/api-credentials" icon="https://stackone-logos.com/api/oxylabs/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>7 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="oxylabs_scrape_url" data-action-label="Scrape URL" data-action-scopes="" data-action-auth="API Credentials" data-action-auth-scopes="{&#x22;API Credentials&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Scrape URL</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="oxylabs_scrape_url" aria-label="Copy oxylabs_scrape_url"><code className="connector-page-code">oxylabs\_scrape\_url</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Scrape a URL in realtime and return the content synchronously</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="oxylabs_create_scraping_job" data-action-label="Create Scraping Job" data-action-scopes="" data-action-auth="API Credentials" data-action-auth-scopes="{&#x22;API Credentials&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Scraping Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="oxylabs_create_scraping_job" aria-label="Copy oxylabs_create_scraping_job"><code className="connector-page-code">oxylabs\_create\_scraping\_job</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Submit an asynchronous scraping job via the push-pull method</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="oxylabs_create_batch_scraping_job" data-action-label="Create Batch Scraping Job" data-action-scopes="" data-action-auth="API Credentials" data-action-auth-scopes="{&#x22;API Credentials&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Batch Scraping Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="oxylabs_create_batch_scraping_job" aria-label="Copy oxylabs_create_batch_scraping_job"><code className="connector-page-code">oxylabs\_create\_batch\_scraping\_job</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Submit a batch of URLs or queries for asynchronous scraping</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="oxylabs_get_scraping_job" data-action-label="Get Scraping Job" data-action-scopes="" data-action-auth="API Credentials" data-action-auth-scopes="{&#x22;API Credentials&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Scraping Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="oxylabs_get_scraping_job" aria-label="Copy oxylabs_get_scraping_job"><code className="connector-page-code">oxylabs\_get\_scraping\_job</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the status and metadata of an asynchronous scraping job</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="oxylabs_get_scraping_job_results" data-action-label="Get Scraping Job Results" data-action-scopes="" data-action-auth="API Credentials" data-action-auth-scopes="{&#x22;API Credentials&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Scraping Job Results</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="oxylabs_get_scraping_job_results" aria-label="Copy oxylabs_get_scraping_job_results"><code className="connector-page-code">oxylabs\_get\_scraping\_job\_results</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the results of a completed asynchronous scraping job</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="oxylabs_get_usage_statistics" data-action-label="Get Usage Statistics" data-action-scopes="" data-action-auth="API Credentials" data-action-auth-scopes="{&#x22;API Credentials&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Usage Statistics</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="oxylabs_get_usage_statistics" aria-label="Copy oxylabs_get_usage_statistics"><code className="connector-page-code">oxylabs\_get\_usage\_statistics</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve usage statistics for the Web Scraper API</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="oxylabs_list_callback_ips" data-action-label="List Callback IPs" data-action-scopes="" data-action-auth="API Credentials" data-action-auth-scopes="{&#x22;API Credentials&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Callback IPs</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="oxylabs_list_callback_ips" aria-label="Copy oxylabs_list_callback_ips"><code className="connector-page-code">oxylabs\_list\_callback\_ips</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the list of IP addresses used for callback notifications</div>
      </div>
    </div>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.