Get All Devices

Retrieve a list of quantum devices available to the authenticated user.

Query Parameters:

• qrn (string, optional): Filter by device QRN
• vendor (string, optional): Filter by vendor
• providerId (string, optional): Filter by provider ID
• deviceType (string, optional): Filter by device type (QPU or SIMULATOR)
• status (string, optional): Filter by operational status
• retired (boolean, optional): Include or exclude retired devices
• private (boolean, optional): Filter by visibility (true = private, false = public)
• verified (boolean, optional): Filter by verification status
• directAccess (boolean, optional): Filter by direct access availability
• search (string, optional): Search by name, description, or about (1–255 characters)
• sortBy (string, optional): Field to sort by
• sortOrder (string, optional): Sort direction (asc or desc)
• page (integer, optional): Page number (default: 1)
• limit (integer, optional): Items per page, max 100 (default: 20)

Returns:

• Array of RuntimeDevice objects containing device specifications and pricing information

Raises:

• 401: Authentication required
• 422: Validation error if query parameters are invalid

GET /devices

Get All Devices

cURL

curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/devices \
  --header 'X-API-KEY: <api-key>'

200

{
  "success": true,
  "data": [
    {
      "name": "QIR sparse simulator",
      "qrn": "qbraid:qbraid:sim:qir-sv",
      "vendor": "qbraid",
      "deviceType": "SIMULATOR",
      "runInputTypes": ["qasm2", "qasm3", "qir.bc", "qir.ll"],
      "status": "ONLINE",
      "statusMsg": null,
      "nextAvailable": null,
      "queueDepth": 0,
      "avgQueueTime": null,
      "numberQubits": 64,
      "paradigm": "gate_model",
      "modality": "sparse_simulator",
      "noiseModels": null,
      "pricingModel": "fixed",
      "pricing": {
        "perTask": 0.5,
        "perShot": 0,
        "perMinute": 7.5
      },
      "directAccess": true
    }
  ]
}

200

{
  "success": true,
  "data": [
    {
      "name": "QIR sparse simulator",
      "qrn": "qbraid:qbraid:sim:qir-sv",
      "vendor": "qbraid",
      "deviceType": "SIMULATOR",
      "runInputTypes": ["qasm2", "qasm3", "qir.bc", "qir.ll"],
      "status": "ONLINE",
      "statusMsg": null,
      "nextAvailable": null,
      "queueDepth": 0,
      "avgQueueTime": null,
      "numberQubits": 64,
      "paradigm": "gate_model",
      "modality": "sparse_simulator",
      "noiseModels": null,
      "pricingModel": "fixed",
      "pricing": {
        "perTask": 0.5,
        "perShot": 0,
        "perMinute": 7.5
      },
      "directAccess": true
    }
  ]
}

Authorizations

X-API-KEY · string · header · required

Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account-v2.qbraid.com.

Query Parameters

qrn · string

Filter devices by QRN Device QRN (qBraid Resource Name)

vendor · enum<string>

Filter devices by vendor

Available options: aws, azure, ibm, ionq, qbraid

providerId · string

Filter devices by provider ID Provider ID to filter by

deviceType · enum<string>

Filter devices by hardware type Filter by hardware type

Available options: QPU, SIMULATOR

status · enum<string>

Filter devices by operational status Filter by operational status

Available options: ONLINE, OFFLINE, RETIRED, UNAVAILABLE

retired · boolean

Include (true) or exclude (false) retired devices Include or exclude retired devices

private · boolean

Filter by visibility — true for private, false for public Filter by device visibility

verified · boolean

Filter by device verification status

directAccess · boolean

Filter devices by direct access availability Filter by direct access availability

search · string

Search devices by name, description, or about (1–255 characters) Search keyword

Required string length: 1 - 255

sortBy · enum<string>

Field to sort devices by Field to sort by

Available options: name, vendor, deviceType, status, numberQubits, createdAt, updatedAt

sortOrder · enum<string> · default: asc

Sort order direction

Available options: asc, desc

page · integer · default: 1

Page number (1-indexed, default: 1) Page number (1-indexed)

Required range: x >= 1

limit · integer · default: 20

Number of items per page

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

Response schema for listing devices

success · boolean · required

data · RuntimeDevice · object[] · required

Array of devices matching the query filters

Show child attributes