curl --request GET \
--url https://api.provenmetal.com/v1/quote-requests/{request_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.provenmetal.com/v1/quote-requests/{request_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.provenmetal.com/v1/quote-requests/{request_id}', 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.provenmetal.com/v1/quote-requests/{request_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
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"
"net/http"
"io"
)
func main() {
url := "https://api.provenmetal.com/v1/quote-requests/{request_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.provenmetal.com/v1/quote-requests/{request_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.provenmetal.com/v1/quote-requests/{request_id}")
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{
"ok": true,
"mode": "instant",
"quote_id": "<string>",
"checkout_url": "<string>",
"quantity": 123,
"request_id": "<string>",
"total": "<string>",
"per_board": "<string>",
"tax": "<string>",
"currency": "<string>",
"total_cents": 123,
"per_board_cents": 123,
"tax_cents": 123,
"lines": [
{}
],
"board_details": {},
"assembled": true,
"lead_time": "<string>",
"delivery": "<string>",
"includes": [
"<string>"
],
"board": "<string>",
"board_image_url": "<string>",
"delivery_saved": true,
"saved_details": true,
"unpriced_parts": [
{}
],
"picked_parts": [
{}
],
"requested_substitutions": [
{}
],
"custom_quote_reasons": [
"<string>"
],
"fabrication_quote": {},
"notes": [
"<string>"
],
"expires_at": "<string>",
"next": "<string>"
}{
"ok": true,
"status": "pending",
"request_id": "<string>",
"poll_url": "<string>",
"retry_after_s": 123,
"elapsed_s": 123,
"progress": "<string>"
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}Poll a quote request
A quote request from POST /v1/quotes: 202 while it prices, then exactly what POST /v1/quotes would have answered (200 with the quote, or the error).
curl --request GET \
--url https://api.provenmetal.com/v1/quote-requests/{request_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.provenmetal.com/v1/quote-requests/{request_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.provenmetal.com/v1/quote-requests/{request_id}', 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.provenmetal.com/v1/quote-requests/{request_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
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"
"net/http"
"io"
)
func main() {
url := "https://api.provenmetal.com/v1/quote-requests/{request_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.provenmetal.com/v1/quote-requests/{request_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.provenmetal.com/v1/quote-requests/{request_id}")
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{
"ok": true,
"mode": "instant",
"quote_id": "<string>",
"checkout_url": "<string>",
"quantity": 123,
"request_id": "<string>",
"total": "<string>",
"per_board": "<string>",
"tax": "<string>",
"currency": "<string>",
"total_cents": 123,
"per_board_cents": 123,
"tax_cents": 123,
"lines": [
{}
],
"board_details": {},
"assembled": true,
"lead_time": "<string>",
"delivery": "<string>",
"includes": [
"<string>"
],
"board": "<string>",
"board_image_url": "<string>",
"delivery_saved": true,
"saved_details": true,
"unpriced_parts": [
{}
],
"picked_parts": [
{}
],
"requested_substitutions": [
{}
],
"custom_quote_reasons": [
"<string>"
],
"fabrication_quote": {},
"notes": [
"<string>"
],
"expires_at": "<string>",
"next": "<string>"
}{
"ok": true,
"status": "pending",
"request_id": "<string>",
"poll_url": "<string>",
"retry_after_s": 123,
"elapsed_s": 123,
"progress": "<string>"
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}{
"error": "<string>",
"message": "<string>",
"ok": false,
"questions": [
{}
],
"known": {},
"parts": [
{}
],
"off_board_parts": [
{}
],
"retry_after_s": 123,
"checkout_url": "<string>",
"fields": [
{}
]
}Authorizations
Your ProvenMetal API key (pm_live_...). Authorization: Bearer <key> also works.
Path Parameters
64Query Parameters
Seconds to wait for it to finish.
0 <= x <= 150Response
Successful Response
instant: a live price the customer pays at checkout_url. review: ProvenMetal's team quotes it (custom options, or parts that couldn't be priced); the customer requests it at checkout_url.
instant, review 64 hex characters: GET /v1/quotes/{quote_id} reports where it stands.
The quote request that made it.
Total in USD, delivered, with tax (instant). null for review.
instant: USD.
instant: the total in cents.
instant: what the total is made of, each {label, cents}.
instant: the board as priced (layers, width_mm, height_mm, thickness_mm, copper_oz, inner_copper_oz, surface_finish, solder_mask, material).
Build time.
From payment to the door, build included.
The total's lines, as words.
The board in one line.
A PNG of the board.
Checkout opens with the delivery details already saved.
The email in ship_to has a saved card and address: the customer can pay through /saved/code, /saved/verify and /saved/pay after saying yes.
review: each part that couldn't be priced, with why and what was searched, and any similar_part to offer.
staff_picks_parts: the parts ProvenMetal chose.
review: why it needs ProvenMetal's team.
review of an assembly: an instant price for the bare boards alone, with its own checkout_url.
What to do next, in words to relay.