API Reference

Circuit construction:

• Quantum circuit model (qiskit.circuit)
• QuantumCircuit class
• Circuit annotations (qiskit.circuit.annotation)
• Classical expressions (qiskit.circuit.classical)
• Circuit Library (qiskit.circuit.library)
• Random Circuits (qiskit.circuit.random)
• Singleton instructions (qiskit.circuit.singleton)

Quantum information:

• Quantum Information (qiskit.quantum_info)

Transpilation:

• Circuit Converters (qiskit.converters)
• DAG Circuits (qiskit.dagcircuit)
• Passmanager (qiskit.passmanager)
• Circuit Synthesis (qiskit.synthesis)
• Approximate Quantum Compiler (qiskit.synthesis.unitary.aqc)
• Transpiler (qiskit.transpiler)
• Transpiler Passes (qiskit.transpiler.passes)
• Synthesis Plugins (qiskit.transpiler.passes.synthesis.plugin)
• Preset Passmanagers (qiskit.transpiler.preset_passmanagers)
• Transpiler Stage Plugin Interface (qiskit.transpiler.preset_passmanagers.plugin)

Primitives and providers:

• Primitives (qiskit.primitives)
• Providers Interface (qiskit.providers)
• BasicProvider: Python-based Simulators (qiskit.providers.basic_provider)
• Fake Provider (qiskit.providers.fake_provider)

Results and visualizations:

• Experiment Results (qiskit.result)
• Visualizations (qiskit.visualization)

Serialization:

• OpenQASM 2 (qiskit.qasm2)
• OpenQASM 3 (qiskit.qasm3)
• QPY serialization (qiskit.qpy)

Other:

• C API interface from Python (qiskit.capi)
• Compilation Routines (qiskit.compiler)
• Top-level exceptions (qiskit.exceptions)
• Root namespace (qiskit)
• Utilities (qiskit.utils)