QiskitRuntimeService

Return the channel type used.

Returns

The channel type used.

active_account()

Return the IBM Quantum account currently in use for the session.

Returns

A dictionary with information about the account currently in the session.

Return type

Dict[str, str] | None

backend(name, instance=None, use_fractional_gates=False)

Return a single backend matching the specified filtering.

Parameters

• name (str) – Name of the backend.
• instance (str | None) – This is only supported for ibm_quantum runtime and is in the hub/group/project format. If an instance is not given, among the providers with access to the backend, a premium provider will be prioritized. For users without access to a premium provider, the default open provider will be used.
• use_fractional_gates (bool | None) – Set True to allow for the backends to include fractional gates. Currently this feature cannot be used simultaneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend. When you use a dynamic circuits feature (e.g. if_else) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. If None, then both fractional gates and control flow operations are included in the backends.

Returns

A backend matching the filtering.

Return type

Backend

Raises

QiskitBackendNotFoundError – if no backend could be found.

backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)

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

Parameters

• name (str | None) – Backend name to filter by.

• min_num_qubits (int | None) – Minimum number of qubits the backend has to have.

• instance (str | None) – In hub/group/project format if on the ibm_quantum channel. IBM Cloud account CRN if on the ibm_cloud and ibm_quantum_platform channels

• dynamic_circuits (bool | None) – Filter by whether the backend supports dynamic circuits.

• filters (Callable[[IBMBackend], bool] | None) –

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

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

• use_fractional_gates (bool | None) – Set True to allow for the backends to include fractional gates. Currently this feature cannot be used simultaneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend. When you use a dynamic circuits feature (e.g. if_else) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. If None, then both fractional gates and control flow operations are included in the backends.

• **kwargs (Any) –

  Simple filters that require a specific value for an attribute in backend configuration or status. Examples:

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

  For the full list of backend attributes, see the IBMBackend class documentation </api/qiskit/1.4/providers_models>

Returns

The list of available backends that match the filter.

Raises

• IBMInputValueError – If an input is invalid.
• QiskitBackendNotFoundError – If the backend is not in any instance.

Return type

List[IBMBackend]

check_pending_jobs()

Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached.

Return type

None

static delete_account(filename=None, name=None, channel=None)

Delete a saved account from disk.

Parameters

• filename (str | None) – Name of file from which to delete the account.
• name (str | None) – Name of the saved account to delete.
• channel (Literal['ibm_quantum_platform', 'ibm_cloud', 'ibm_quantum', 'local'] | None) – Channel type of the default account to delete. Ignored if account name is provided.

Returns

True if the account was deleted. False if no account was found.

Return type

bool

delete_job(job_id)

Delete a runtime job.

Note that this operation cannot be reversed.

Parameters

job_id (str) – ID of the job to delete.

Raises

• RuntimeJobNotFound – If the job doesn’t exist.
• IBMRuntimeError – If the request failed.

Return type

None

instances()

Return the instance list associated to the active account. For the “ibm_quantum” channel,

the list elements will be in the hub/group/project format. For the “ibm_cloud” and “ibm_quantum_platform” channels, this list will contain a series of dictionaries with the following instance identifiers per instance: “crn”, “plan”, “name”.

Returns

A list with instances available for the active account.

Return type

Sequence[str | Dict[str, str]]

job(job_id)

Retrieve a runtime job.

Parameters

job_id (str) – Job ID.

Returns

Runtime job retrieved.

Raises

• RuntimeJobNotFound – If the job doesn’t exist.
• IBMRuntimeError – If the request failed.

Return type

RuntimeJob | RuntimeJobV2

jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)

Retrieve all runtime jobs, subject to optional filtering.

Parameters

• limit (int | None) – Number of jobs to retrieve. None means no limit.
• skip (int) – Starting index for the job retrieval.
• backend_name (str | None) – Name of the backend to retrieve jobs from.
• pending (bool | None) – Filter by job pending state. If True, ‘QUEUED’ and ‘RUNNING’ jobs are included. If False, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included.
• program_id (str | None) – Filter by Program ID.
• instance (str | None) – This is only supported for ibm_quantum runtime and is in the hub/group/project format.
• job_tags (List[str] | None) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
• session_id (str | None) – Filter by session id. All jobs in the session will be returned in desceding order of the job creation date.
• created_after (datetime | None) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time.
• created_before (datetime | None) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time.
• descending (bool) – If True, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.

Returns

A list of runtime jobs.

Raises

IBMInputValueError – If an input value is invalid.

Return type

List[RuntimeJob | RuntimeJobV2]

least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)

Return the least busy available backend.

Parameters

• min_num_qubits (int | None) – Minimum number of qubits the backend has to have.

• instance (str | None) – This is only supported for ibm_quantum runtime and is in the hub/group/project format.

• filters (Callable[[IBMBackend], bool] | None) –

  Filters can be defined as for the backends() method. An example to get the operational backends with 5 qubits:

  QiskitRuntimeService.least_busy(n_qubits=5, operational=True)

• kwargs (Any)

Returns

The backend with the fewest number of pending jobs.

Raises

QiskitBackendNotFoundError – If no backend matches the criteria.

Return type

IBMBackend

static save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False, region=None, plans_preference=None)

Save the account to disk for future use.

Parameters

• token (str | None) – IBM Cloud API key or IBM Quantum API token.

• url (str | None) – The API URL. Defaults to https://cloud.ibm.com (ibm_cloud), https://quantum.cloud.ibm.com (ibm_quantum_platform) or https://auth.quantum.ibm.com/api (ibm_quantum).

• instance (str | None) – This is an optional parameter to specify the CRN or service name for ibm_cloud and ibm_quantum_platform, and the hub/group/project for ibm_quantum. If set, it will define a default instance for service instantiation, if not set, the service will fetch all instances accessible within the account.

• channel (Literal['ibm_quantum_platform', 'ibm_cloud', 'ibm_quantum', 'local'] | None) –

  Channel type. ibm_quantum, ibm_cloud or ibm_quantum_platform. The ibm_quantum channel is deprecated and will be removed no earlier than July 1st 2025. ibm_quantum_platform should be used instead. Note that ibm_cloud and ibm_quantum_platform point to the same url. For help migrating to the alternative channels, review the migration guide.

• filename (str | None) – Full path of the file where the account is saved.

• name (str | None) – Name of the account to save.

• proxies (dict | None) – Proxy configuration. Supported optional keys are urls (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at https://docs.python-requests.org/en/latest/api/#requests.Session.proxies), username_ntlm, password_ntlm (username and password to enable NTLM user authentication)

• verify (bool | None) – Verify the server’s TLS certificate.

• overwrite (bool | None) – True if the existing account is to be overwritten.

• set_as_default (bool | None) – If True, the account is saved in filename, as the default account.

• private_endpoint (bool | None) – Connect to private API URL.

• region (Literal['us-east', 'eu-de'] | None) – Set a region preference. us-east or eu-de. An instance with this region will be prioritized if an instance is not passed in.

• plans_preference (List[str] | None) – A list of account types, ordered by preference. An instance with the first value in the list will be prioritized if an instance is not passed in.

Return type

None

static saved_accounts(default=None, channel=None, filename=None, name=None)

List the accounts saved on disk.

Parameters

• default (bool | None) – If set to True, only default accounts are returned.

• channel (Literal['ibm_quantum_platform', 'ibm_cloud', 'ibm_quantum', 'local'] | None) –

  Channel type. ibm_quantum, ibm_cloud or ibm_quantum_platform. The ibm_quantum channel is deprecated and will be removed no earlier than July 1st 2025. ibm_quantum_platform should be used instead. Note that ibm_cloud and ibm_quantum_platform point to the same url. For help migrating to the alternative channels, review the migration guide.

• filename (str | None) – Name of file whose accounts are returned.

• name (str | None) – If set, only accounts with the given name are returned.

Returns

A dictionary with information about the accounts saved on disk.

Raises

ValueError – If an invalid account is found on disk.

Return type

dict

usage()

Return monthly open plan usage information.

Returns

Dict with usage details.

Raises

IBMInputValueError – If method is called when using the ibm_cloud channel

Return type

Dict[str, Any]