> ## 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.

![Oxylabs](https://stackone-logos.com/api/oxylabs/filled/svg)

v1.0.0[See changelog](https://docs.stackone.com/connectors/oxylabs/changelog.md)

[7 actions](#actions) · 1 auth method

Developer Tools

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Credentials · Connector Profile](https://docs.stackone.com/connectors/oxylabs/guides/connector-profile/api-credentials.md)
>
> Uses API user credentials (username and password) created in the Oxylabs dashboard. Provides access to Web Scraper API a...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

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

> [card] [API Credentials · Link Account](https://docs.stackone.com/connectors/oxylabs/guides/link-account/api-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

7 actions

ActionDescription

Scrape URL`oxylabs_scrape_url`

Scrape a URL in realtime and return the content synchronously

Create Scraping Job`oxylabs_create_scraping_job`

Submit an asynchronous scraping job via the push-pull method

Create Batch Scraping Job`oxylabs_create_batch_scraping_job`

Submit a batch of URLs or queries for asynchronous scraping

Get Scraping Job`oxylabs_get_scraping_job`

Retrieve the status and metadata of an asynchronous scraping job

Get Scraping Job Results`oxylabs_get_scraping_job_results`

Retrieve the results of a completed asynchronous scraping job

Get Usage Statistics`oxylabs_get_usage_statistics`

Retrieve usage statistics for the Web Scraper API

List Callback IPs`oxylabs_list_callback_ips`

Retrieve the list of IP addresses used for callback notifications


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