START NOW
Devices

Get All Devices

GET/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

Authorizations

X-API-KEYstringheaderrequired

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

Query Parameters

qrnstring

Filter devices by QRN

vendorenum<string>

Filter devices by vendor

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

Filter devices by provider ID

deviceTypeenum<string>

Filter devices by hardware type

Available options: QPU, SIMULATOR
statusenum<string>

Filter devices by operational status

Available options: ONLINE, OFFLINE, RETIRED, UNAVAILABLE
retiredboolean

Include (true) or exclude (false) retired devices

privateboolean

Filter by visibility — true for private, false for public

verifiedboolean

Filter by device verification status

directAccessboolean

Filter devices by direct access availability

searchstring

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

sortByenum<string>

Field to sort devices by

Available options: name, vendor, deviceType, status, numberQubits, createdAt, updatedAt
sortOrderenum<string>default: "asc"

Sort order direction (default: asc)

Available options: asc, desc
pageintegerdefault: 1

Page number (1-indexed, default: 1)

limitintegerdefault: 20

Number of items per page (1–100, default: 20)

Response

200Successful Response
successbooleanrequired
dataobject[]required

Array of devices matching the query filters

401Unauthorized
422Validation Error
GET/devices
curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/devices \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api-v2.qbraid.com/api/v1/devices"
headers = {
    "X-API-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)
print(response.json())
const url = "https://api-v2.qbraid.com/api/v1/devices";
const options = {
  method: "GET",
  headers: {"X-API-KEY":"<api-key>"},
};

const response = await fetch(url, options);
console.log(await response.json());
{
  "success": true,
  "data": [
    {
      "name": "<string>",
      "qrn": "<string>",
      "vendor": "aws",
      "deviceType": "SIMULATOR",
      "runInputTypes": [
        "<string>"
      ],
      "status": "ONLINE",
      "statusMsg": "<string>",
      "nextAvailable": "2024-01-01T00:00:00Z",
      "queueDepth": 123,
      "avgQueueTime": 123,
      "numberQubits": 123,
      "paradigm": "gate_model",
      "modality": "<string>",
      "noiseModels": [
        "<string>"
      ],
      "pricingModel": "fixed",
      "pricing": {
        "perTask": 10,
        "perShot": 10,
        "perMinute": 10
      },
      "directAccess": true
    }
  ]
}
{
  "detail": "Authentication required"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}