# ApifyRequestQueueClient<!-- -->

Request queue client for the Apify platform.

This client provides access to request queues stored on the Apify platform, supporting both single-consumer and multi-consumer scenarios. It manages local caching, request fetching, and state synchronization with the platform's API.

## Index[](#Index)

### Methods

* [\_\_init\_\_](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#__init__)
* [add_batch_of_requests](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#add_batch_of_requests)
* [drop](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#drop)
* [fetch_next_request](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#fetch_next_request)
* [get_metadata](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#get_metadata)
* [get_request](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#get_request)
* [is_empty](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#is_empty)
* [is_finished](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#is_finished)
* [mark_request_as_handled](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#mark_request_as_handled)
* [open](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#open)
* [purge](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#purge)
* [reclaim_request](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md#reclaim_request)

## Methods<!-- -->[](#Methods)

### [](#__init__)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L37)\_\_init\_\_

* **\_\_init\_\_**(\*, api_client, metadata, access): None

- Initialize a new instance.

  Preferably use the `ApifyRequestQueueClient.open` class method to create a new instance.

  ***

  #### Parameters

  * ##### keyword-onlyapi_client: RequestQueueClientAsync
  * ##### keyword-onlymetadata: RequestQueueMetadata
  * ##### optionalkeyword-onlyaccess: Literal\[single, shared] = <!-- -->'single'

  #### Returns None

### [](#add_batch_of_requests)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L169)add_batch_of_requests

* async **add_batch_of_requests**(requests, \*, forefront): AddRequestsResponse

- #### Parameters

  * ##### requests: Sequence\[Request]
  * ##### optionalkeyword-onlyforefront: bool = <!-- -->False

  #### Returns AddRequestsResponse

### [](#drop)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L165)drop

* async **drop**(): None

- #### Returns None

### [](#fetch_next_request)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L178)fetch_next_request

* async **fetch_next_request**(): Request | None

- #### Returns Request | None

### [](#get_metadata)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L69)get_metadata

* async **get_metadata**(): [ApifyRequestQueueMetadata](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueMetadata.md)

- Retrieve current metadata about the request queue.

  This method fetches metadata from the Apify API and merges it with local estimations to provide the most up-to-date statistics. Local estimations are used to compensate for potential delays in API data propagation (typically a few seconds).

  ***

  #### Returns [ApifyRequestQueueMetadata](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueMetadata.md)

  Request queue metadata with accurate counts and timestamps, combining API data with local estimates.

### [](#get_request)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L186)get_request

* async **get_request**(unique_key): Request | None

- #### Parameters

  * ##### unique_key: str

  #### Returns Request | None

### [](#is_empty)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L199)is_empty

* async **is_empty**(): bool

- #### Returns bool

### [](#is_finished)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L203)is_finished

* async **is_finished**(): bool

- #### Returns bool

### [](#mark_request_as_handled)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L182)mark_request_as_handled

* async **mark_request_as_handled**(request): ProcessedRequest | None

- #### Parameters

  * ##### request: Request

  #### Returns ProcessedRequest | None

### [](#open)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L104)open

* async **open**(\*, id, name, alias, configuration, access): [ApifyRequestQueueClient](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md)

- Open an Apify request queue client.

  This method creates and initializes a new request queue client instance, handling authentication, storage lookup or creation, metadata retrieval, and initialization of internal caching structures.

  ***

  #### Parameters

  * ##### keyword-onlyid: str | None

    ID of an existing request queue to open. Mutually exclusive with `name` and `alias`.

  * ##### keyword-onlyname: str | None

    Name of the request queue to open or create (persists across Actor runs). Mutually exclusive with `id` and `alias`.

  * ##### keyword-onlyalias: str | None

    Alias for the request queue (scoped to current Actor run, creates unnamed storage). Mutually exclusive with `id` and `name`.

  * ##### keyword-onlyconfiguration: [Configuration](https://docs.apify.com/sdk/python/reference/class/Configuration.md)

    Configuration object containing API credentials (`token`, `api_base_url`) and optionally a `default_request_queue_id` for fallback when no identifier is provided.

  * ##### optionalkeyword-onlyaccess: Literal\[single, shared] = <!-- -->'single'

    Access mode controlling the client's behavior:

    * `single`: Optimized for single-consumer scenarios (lower API usage, better performance).
    * `shared`: Optimized for multi-consumer scenarios (more API calls, guaranteed consistency).

  #### Returns [ApifyRequestQueueClient](https://docs.apify.com/sdk/python/reference/class/ApifyRequestQueueClient.md)

  An instance for the opened or created storage client.

### [](#purge)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L158)purge

* async **purge**(): None

- #### Returns None

### [](#reclaim_request)[](https://github.com/apify/apify-sdk-python/blob/c674a4d42ade9c1a07f33062b6702497cd34b19d//src/apify/storage_clients/_apify/_request_queue_client.py#L190)reclaim_request

* async **reclaim_request**(request, \*, forefront): ProcessedRequest | None

- #### Parameters

  * ##### request: Request
  * ##### optionalkeyword-onlyforefront: bool = <!-- -->False

  #### Returns ProcessedRequest | None
