Carat Endpoint
Using the Metals-API API's carat
endpoint you will be able to retrieve information about Gold rates by Carat. To use this feature, simply append a base
to choose which currencies (symbols) you would like to query the API for.
API Request:
https://metals-api.com/api/carat ? access_key = API_KEY
Request Parameters:
Parameter | Description |
---|---|
access_key |
[required] Your API Key. |
base |
[optional] Enter the three-letter currency code or metal code of your preferred base currency. Default is USD |
API Response:
{"success":true,"timestamp":1623165936,"base":"USD","rates":{"Carat 24K":12173,"Carat 23K":11666,"Carat 22K":11159,"Carat 21K":10652,"Carat 18K":9130,"Carat 16K":8115,"Carat 14K":7101,"Carat 12K":6087,"Carat 10K":5072,"Carat 9K":4565,"Carat 8K":4058,"Carat 6K":3043}}
Response Objects:
Response Object | Description |
---|---|
success |
Returns true or false depending on whether or not your API request has succeeded. |
base |
Returns the three-letter currency code or metal code of the base currency used for this request. |
rates |
Returns exchange rate data for the currencies you have requested. |
Example request in Postman:
https://metals-api.com/api/carat?access_key=YOUR_API_KEY&base=USD