START NOW
Devices

Get All Devices

List quantum devices (simulators and QPUs) visible to the caller, with filtering, search, sorting, and pagination.

GET/devices

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, UNAVAILABLE, OFFLINE, RETIRED
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

200Success.
successbooleanrequired
dataobject[]required

Array of devices matching the query filters

400Invalid query parameters.
List 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());
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/devices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api-v2.qbraid.com/api/v1/devices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api-v2.qbraid.com/api/v1/devices"))
    .header("X-API-KEY", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'uri'
require 'net/http'

url = URI("https://api-v2.qbraid.com/api/v1/devices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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
    }
  ]
}
{
  "success": false,
  "message": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}