{"openapi":"3.1.0","info":{"title":"Bullion Price Check public API","version":"1.0.0","description":"Free, read-only bullion data from Bullion Price Check: live gold, silver and platinum spot, the lowest current dealer prices for every coin and bar the site tracks (sorted by price only), and the same melt, junk silver, scrap gold, premium, true cost and gold-silver ratio calculators the site uses. Free for any use; if you display the data, show a visible credit \"Data by Bullion Price Check\" linking to bullionpricecheck.com.","termsOfService":"https://bullionpricecheck.com/developers/#terms","contact":{"email":"hello@bullionpricecheck.com","url":"https://bullionpricecheck.com/developers/"}},"servers":[{"url":"https://bullionpricecheck.com"}],"paths":{"/api/v1/spot":{"get":{"operationId":"get_spot_prices","summary":"Get spot prices","description":"Live gold, silver and platinum spot prices in USD per troy ounce, with the time each was read and the gold-silver ratio.","parameters":[],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/products":{"get":{"operationId":"list_products","summary":"List tracked products","description":"List the bullion products Bullion Price Check tracks (slug, name, metal, troy oz) with today's lowest listed dealer price for each. Use a slug with get_dealer_prices. This is the complete list: a product that is not listed is not tracked.","parameters":[{"name":"metal","in":"query","required":false,"description":"Only list products of this metal.","schema":{"type":"string","enum":["gold","silver","platinum"]}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/prices":{"get":{"operationId":"get_dealer_prices","summary":"Get dealer prices for a product","description":"Current listed dealer prices for one tracked product, lowest first. Sorted by price only: dealers marked \"Partner\" pay to list and are never ranked by anything but price. Only prices checked in the last 24 hours are returned. If the product is not tracked, it returns an error that names the closest tracked products; it never substitutes a different size or weight.","parameters":[{"name":"product","in":"query","required":true,"description":"Product slug from list_products (for example american-silver-eagle-1oz) or a name with its weight, such as \"1 oz silver eagle\". A name only matches a product of the same weight. If the product is not tracked, the tool returns an error naming the closest tracked products.","schema":{"type":"string"}},{"name":"payment","in":"query","required":false,"description":"bank = check/ACH/wire price (default); card = the dealer's listed credit card price.","schema":{"type":"string","enum":["bank","card"],"default":"bank"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of dealers to return.","schema":{"type":"integer","minimum":1,"maximum":20,"default":10}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/melt-value":{"get":{"operationId":"melt_value","summary":"Melt value calculator","description":"Melt (metal) value of any gold, silver or platinum item at live spot: weight x purity x spot. Weight in troy oz, grams, kilograms or pennyweight.","parameters":[{"name":"metal","in":"query","required":true,"schema":{"type":"string","enum":["gold","silver","platinum"]}},{"name":"weight","in":"query","required":true,"description":"Gross weight of the item.","schema":{"type":"number","exclusiveMinimum":0}},{"name":"unit","in":"query","required":false,"description":"ozt = troy ounce, g = gram, kg = kilogram, dwt = pennyweight.","schema":{"type":"string","enum":["ozt","g","kg","dwt"],"default":"ozt"}},{"name":"purity","in":"query","required":false,"description":"Metal fineness as a fraction, for example 0.999, 0.9167 (22k), 0.925 (sterling), 0.90 (US 90% coins).","schema":{"type":"number","exclusiveMinimum":0,"maximum":1,"default":1}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/junk-silver":{"get":{"operationId":"junk_silver_melt","summary":"Junk silver melt calculator","description":"Silver content and melt value of US junk silver coins by face value: 90% (pre-1965 dimes, quarters, halves), 40% (1965-1970 Kennedy halves or Eisenhower dollars) or 35% (1942-1945 war nickels). For 90% coins it also shows the 0.715 oz worn-coin figure and today's lowest dealer ask per $1 face.","parameters":[{"name":"face_value","in":"query","required":true,"description":"Total face value in US dollars, for example 10 for $10 face.","schema":{"type":"number","exclusiveMinimum":0}},{"name":"coin_type","in":"query","required":false,"description":"90 = 90% silver; 40 = 40% Kennedy halves; 40_eisenhower = 40% Eisenhower dollars; 35 = 35% war nickels.","schema":{"type":"string","enum":["90","40","40_eisenhower","35"],"default":"90"}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/premium":{"get":{"operationId":"premium_over_spot","summary":"Premium over spot checker","description":"Premium over spot for a price you were quoted. Give a tracked product slug to also see where the price sits against today's lowest, median and highest listed dealer prices, or give metal and weight for any item.","parameters":[{"name":"price","in":"query","required":true,"description":"Price quoted for one item, in USD.","schema":{"type":"number","exclusiveMinimum":0}},{"name":"product","in":"query","required":false,"description":"Tracked product slug or name with its weight (see list_products). A name only matches a product of the same weight.","schema":{"type":"string"}},{"name":"metal","in":"query","required":false,"description":"Use with weight_ozt when the item is not a tracked product.","schema":{"type":"string","enum":["gold","silver","platinum"]}},{"name":"weight_ozt","in":"query","required":false,"description":"Pure metal content in troy ounces (use with metal).","schema":{"type":"number","exclusiveMinimum":0}},{"name":"payment","in":"query","required":false,"description":"Which dealer price list to compare with (tracked products only).","schema":{"type":"string","enum":["bank","card"],"default":"bank"}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/true-cost":{"get":{"operationId":"true_cost","summary":"True cost calculator","description":"Delivered cost of a bullion order. Mode 1: give price (per item), quantity, shipping and a payment fee to get the all-in total. Mode 2: give a tracked product and quantity (no price) to rank dealers by delivered total using each dealer's published shipping and payment fees.","parameters":[{"name":"price","in":"query","required":false,"description":"Mode 1: price per item in USD.","schema":{"type":"number","exclusiveMinimum":0}},{"name":"quantity","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10000,"default":1}},{"name":"shipping","in":"query","required":false,"description":"Mode 1: shipping charge for the whole order in USD.","schema":{"type":"number","minimum":0,"default":0}},{"name":"payment_fee_pct","in":"query","required":false,"description":"Mode 1: payment method fee as a percent of the item total (for example 3.5 for a card surcharge).","schema":{"type":"number","minimum":0,"maximum":20,"default":0}},{"name":"payment_fee_usd","in":"query","required":false,"description":"Mode 1: flat payment fee in USD (for example a wire fee).","schema":{"type":"number","minimum":0,"default":0}},{"name":"product","in":"query","required":false,"description":"Tracked product slug or name with its weight (see list_products). Mode 2 when price is not given; in mode 1 it adds per-ounce cost and premium.","schema":{"type":"string"}},{"name":"payment","in":"query","required":false,"description":"Mode 2: pay by check/ACH/wire (bank) or credit card.","schema":{"type":"string","enum":["bank","card"],"default":"bank"}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/gold-silver-ratio":{"get":{"operationId":"gold_silver_ratio","summary":"Gold-silver ratio","description":"Live gold-silver ratio (ounces of silver one ounce of gold buys at spot), with an optional ounce converter.","parameters":[{"name":"amount_ozt","in":"query","required":false,"description":"Troy ounces to convert.","schema":{"type":"number","minimum":0}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["gold_to_silver","silver_to_gold"],"default":"gold_to_silver"}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/scrap-gold":{"get":{"operationId":"scrap_gold_value","summary":"Scrap gold calculator","description":"Full melt value of scrap gold or jewelry by karat and weight at live gold spot (karat/24, with 24k at 99.9%). Optionally give an offer to see what share of melt it is.","parameters":[{"name":"karat","in":"query","required":true,"description":"Gold karat, for example 10, 14, 18, 22 or 24.","schema":{"type":"number","minimum":1,"maximum":24}},{"name":"weight","in":"query","required":true,"schema":{"type":"number","exclusiveMinimum":0}},{"name":"unit","in":"query","required":false,"description":"g = gram, dwt = pennyweight, ozt = troy ounce.","schema":{"type":"string","enum":["g","dwt","ozt"],"default":"g"}},{"name":"offer_usd","in":"query","required":false,"description":"Optional offer you received, to compare with melt.","schema":{"type":"number","exclusiveMinimum":0}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/premium-index":{"get":{"operationId":"get_premium_index","summary":"Bullion Premium Index","description":"Current Bullion Premium Index: for each tracked product, the lowest premium over spot today, the dealer median premium and the 7-day median and minimum of the lowest premium.","parameters":[{"name":"metal","in":"query","required":false,"schema":{"type":"string","enum":["gold","silver","platinum"]}}],"responses":{"200":{"description":"Result with attribution, source_url and data_as_of","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad input (message explains the fix)"},"404":{"description":"Unknown product or endpoint"},"429":{"description":"Rate limited (see Retry-After)"}}}},"/api/v1/prices/{product}":{"get":{"operationId":"get_dealer_prices_by_path","summary":"Get dealer prices for a product (slug in path)","parameters":[{"name":"product","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment","in":"query","schema":{"type":"string","enum":["bank","card"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":20}}],"responses":{"200":{"description":"Dealer prices, lowest first"}}}}}}