START NOW
Account

Get Simulator Usage

Return the daily per-simulator job quota and current usage for the tier of the caller. Usage resets at 00:00 UTC. The organization is taken from the API key, which is bound to a single organization.

GET/usage/simulator

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.

Response

200Success.
successbooleanrequired
dataobject[]required
401Authentication / org context required.
404Organization user not found.
Get simulator daily usage and quota
curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/usage/simulator \
  --header 'X-API-KEY: <api-key>'
import requests

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

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

const response = await fetch(url, options);
console.log(await response.json());
{
  "success": true,
  "data": [
    {
      "deviceQrn": "<string>",
      "deviceName": "<string>",
      "usage": 123,
      "quota": 123,
      "remaining": 123,
      "unlimited": true,
      "percentageUsed": 123,
      "resetsAt": "2024-01-01T00:00:00Z"
    }
  ]
}
{
  "success": false,
  "message": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}
{
  "success": false,
  "message": "<string>",
  "error": {
    "message": "<string>",
    "code": "<string>"
  }
}