Skip to main content
GET
/
jobs
/
estimate
cURL
curl --request GET \
  --url https://api.ionq.co/v0.4/jobs/estimate \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.ionq.co/v0.4/jobs/estimate"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.ionq.co/v0.4/jobs/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ionq.co/v0.4/jobs/estimate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ionq.co/v0.4/jobs/estimate"

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

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.ionq.co/v0.4/jobs/estimate")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.ionq.co/v0.4/jobs/estimate")

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

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

response = http.request(request)
puts response.read_body
{
  "input_values": {
    "backend": "<string>",
    "type": "ionq.circuit.v1",
    "qubits": 25,
    "shots": 1000,
    "1q_gates": 0,
    "2q_gates": 0,
    "error_mitigation": false
  },
  "estimated_at": "<string>",
  "cost_unit": "<string>",
  "rate_information": {
    "qct_cost_cents": 123,
    "job_cost_minimum": 123,
    "cost_2q_gate": 123,
    "cost_1q_gate": 123,
    "organization": "<string>"
  },
  "estimated_cost": 123,
  "estimated_execution_time": 123,
  "current_predicted_queue_time": 123,
  "estimated_quantum_compute_time_us": 123
}

Authorizations

Authorization
string
header
required

API keys are associated with a user and can be created on the IonQ Quantum Cloud application. To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. Ex: Authorization: apiKey your-api-key

Query Parameters

backend
string
required

Available options: simulator, qpu.aria-1, qpu.aria-2, qpu.forte-1, qpu.forte-enterprise-1

type
string
default:ionq.circuit.v1
qubits
integer<int32>
default:25
shots
integer<int32>
default:1000
1q_gates
integer<int32>
default:0
2q_gates
integer<int32>
default:0
error_mitigation
boolean
default:false

Response

Successfully retrieved the cost estimate of a job.

input_values
object
required
estimated_at
string
required
cost_unit
string
required
rate_information
object
required
estimated_cost
number<double>
required
estimated_execution_time
number<double>
required
current_predicted_queue_time
number<double>
required
estimated_quantum_compute_time_us
number<double>