IBMBackendService.backends#

IBMBackendService.backends(name=None, filters=None, min_num_qubits=None, instance=None, dynamic_circuits=None, **kwargs)[source]#

Return all backends accessible via this account, subject to optional filtering.

Parameters:

  • name (Optional[str]) – Backend name to filter by.

  • min_num_qubits (Optional[int]) – Minimum number of qubits the backend must have.

  • instance (Optional[str]) – The provider in the hub/group/project format.

  • dynamic_circuits (Optional[bool]) – Filter by whether the backend supports dynamic circuits.

  • filters (Optional[Callable[[List[IBMBackend]], bool]]) –

    More complex filters, such as lambda functions. For example:

    IBMProvider.backends(filters=lambda b: b.max_shots > 50000)
IBMProvider.backends(filters=lambda x: ("rz" in x.basis_gates )

  • **kwargs –

    Simple filters that require a specific value for an attribute in backend configuration, backend status, or provider credentials.

    Examples:

    # Get the operational real backends
IBMProvider.backends(simulator=False, operational=True)
# Get the backends with at least 127 qubits
IBMProvider.backends(min_num_qubits=127)
# Get the backends that support OpenPulse
IBMProvider.backends(open_pulse=True)

    For the full list of backend attributes, see the IBMBackend class documentation <https://qiskit.org/documentation/apidoc/providers_models.html>

Return type:

List[IBMBackend]

Returns:

The list of available backends that match the filter.

Raises:

  • IBMBackendValueError – If only one or two parameters from hub, group, project are specified.

  • QiskitBackendNotFoundError – If the backend is not found in any instance.