@qbraid-core/ibm-cloud/README.md

Client for interacting with IBM's Qiskit Runtime Service via the IBM Cloud API.

<img align="right" width="100" alt="qbraid" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid.png">

# [@qbraid-core/ibm-cloud](https://qbraid.github.io/qbraid-core-js/modules/_qbraid-core_ibm-cloud.html)

[![Stable][preview-stability]](https://qbraid.github.io/qbraid-core-js/#launch-stages)
[![npm](https://img.shields.io/npm/v/@qbraid-core/ibm-cloud?color=blue)](https://npm.im/@qbraid-core/ibm/cloud)

Client for interacting with IBM's Qiskit Runtime Service via the IBM Cloud API.

## Installation

```bash
npm install @qbraid-core/ibm-cloud
```

## Usage Example

```typescript
import { IBMCloudClient} from '@qbraid-core/ibm-cloud';

const apiKey = 'my-api-key';
const serviceCRN = 'my-service-crn';

const client = new IBMCloudClient(apiKey: apiKey, serviceCRN: serviceCRN);

// Get a Job
const jobID = 'my-ibm-job-id';
const jobResponse = await client.getJob(jobID);
console.log("Job details: ", jobResponse);

// Get all devices
const backends = await client.getBackends();
console.log("Available backends: ", backends);

// Get a backend status
const backendName = 'ibm_marrakesh';
const backendStatus = await client.getBackendStatus(backendName);
console.log("Backend status: ", backendStatus);
```

## License

This software is proprietary and subject to the terms of the [qBraid Commercial Software License](https://qbraid.github.io/qbraid-core-js/#license).

[stable-stability]: https://img.shields.io/badge/stability-stable-green
[preview-stability]: https://img.shields.io/badge/stability-preview-orange
[deprecated-stability]: https://img.shields.io/badge/stability-deprecated-red