Metals Place API Services
Drawing from a diverse network of 10+ exchange rate data sources for precious metals, the Metals Place API is designed to provide real-time rate data for your most precious assets. The API is structured around multiple endpoints, each tailored to serve a distinct use case. Endpoint functionalities range from fetching the latest exchange rate data for an entire or specific subset of currencies, to converting amounts between currencies, sourcing time-series data for single or multiple currencies, and retrieving daily fluctuation data.
Our detailed documentation will guide you through the API structure, methods, possible errors, and provide illustrative code examples. However, if you still find any questions unanswered, don't hesitate to reach out to us. Our dedicated team is always ready to assist you.
Definition | Description |
---|---|
API Key | A unique key assigned to each API account used to authenticate with the API. |
Symbol | Refers to the three-letter currency code or metal code of a given currency. |
Base | The currency to which exchange rates are relative to. (If 1 USD = X EUR, USD is the base currency) |
Target | The currency an amount is converted to. (If 1 USD = X EUR, EUR is the target currency) |
Base URL | Refers to URL which all API request endpoints and URLs are based on. |
API Key
Your API Key serves as your exclusive identifier used for authentication with the Metals Place API. This key is integrated into the API base URL's 'api_key' parameter to confirm your access.
Base URL:
1- All Symbols
The 'symbols' API endpoint allows you to retrieve a comprehensive list of all available symbols used in our database. This includes symbols for various metals, currencies, and stock exchanges. This data can be utilized to understand the specific identifiers for each asset, enabling seamless interaction with other API endpoints for more specific data retrieval and analysis.
Base URL:
Request Parameters:
Parameter | Description |
---|---|
API Key | [Required] Your API Key. |
Code Example:
Response Example:
2- Latest Prices
The 'Latest Prices' API endpoint offers you real-time access to the most current prices for a vast range of metals, currencies, and stock exchanges. The data is drawn from multiple reliable sources, ensuring its accuracy and timeliness. By using this API, you can stay updated with the latest market prices and make informed decisions swiftly and confidently.
Base URL:
Request Parameters:
Parameter | Description |
---|---|
API Key | [Required] Your API Key. More details. |
base | [optional] Specify a base currency. Base Currency will default to USD if this parameter is not defined. |
currencies | [optional] Specify a comma-separated list of currency codes to limit API responses to specified currencies. If this parameter is not defined, the API will return all supported currencies. |
Code Example:
Response Example:
3- Historical Rates Endpoint
The 'Historical Rates Endpoint' API provides you with the capability to access and analyze the past data for various metals, currencies, and stock exchanges. By harnessing this endpoint, you can gain insights into past market trends, understand patterns, and make forecasts. It is a crucial tool for anyone seeking to understand market fluctuations over time and predict future trends based on historical data.
Base URL:
Request Parameters:
Parameter | Description |
---|---|
API Key | [Required] Your API Key. More details. |
base | [optional] Specify a base currency. Base Currency will default to USD if this parameter is not defined. |
currencies | [optional] Specify a comma-separated list of currency codes to limit API responses to specified currencies. If this parameter is not defined, the API will return all supported currencies. |
Code Example:
Response Example:
4- Currency Convert
The 'Currency Convert' API endpoint facilitates the seamless conversion of one currency to another based on the most current exchange rates. This feature provides an essential tool for users dealing with international transactions or those who need to track the value of various currencies in real-time. By employing this API, you can swiftly obtain accurate currency conversion data, making your cross-currency dealings more efficient and reliable.
Base URL:
Request Parameters:
Parameter | Description |
---|---|
API Key | [Required] Your API Key |
from | [optional] The 'from' parameter indicates the currency you are converting from. In this case, the source currency is US Dollars (USD). |
amount | [optional] The 'amount' parameter denotes the quantity of the 'from' currency that you want to convert. Here, the amount is set to 100, meaning you want to convert 100 US Dollars to Euros. |
to | [optional] The 'to' parameter specifies the currency you are converting to. Here, you are converting to Euros (EUR). |
date | [optional] The 'date' parameter is used when you want to know the exchange rate for a specific past date. In this case, you are looking for the exchange rate that was in effect on April 23, 2021. If you want the current exchange rate, you can leave this parameter out. |
Code Example:
Response Example:
5- Time History
The 'Time History' API endpoint enables you to dive into the historical timeline of various metals, currencies, and stock exchanges. This feature provides chronological data that aids in understanding the progression of market trends and dynamics over specified periods. Leveraging this API, you can analyze time-series data, trace price evolution, assess market volatility, and derive key insights to inform your strategic decisions.
Base URL:
Request Parameters:
Parameter | Description |
---|---|
API Key | [Required] Your API Key |
symbols | [optional] The 'symbols' parameter specifies the currencies (or other financial instruments) for which you are seeking historical data. In this case, the symbols include United States Dollar (USD), Egyptian Pound (EGP), United Arab Emirates Dirham (AED), and Euro (EUR). |
start_date | [optional] The 'start_date' parameter denotes the beginning of the timeframe for which you want to retrieve the historical data. Here, you're looking for data starting from May 1, 2023. |
end_date | [optional] he 'end_date' parameter specifies the end of the timeframe for the historical data. In this case, you're looking for data up until May 10, 2023. |
base | [optional] The 'base' parameter indicates the base currency against which the exchange rates of the other currencies (specified in 'symbols') will be calculated. Here, the base currency is set to the Egyptian Pound (EGP). |
Code Example:
Response Example:
5- Change Currency
The 'Change' API endpoint delivers the essential information on how prices for various metals, currencies, and stock exchanges have fluctuated within a specific timeframe. This feature provides valuable insights into market volatility and potential trends. Utilizing this API, you gain a clearer understanding of the magnitude and direction of price changes, empowering you to make well-informed trading and investment decisions.
Base URL:
Request Parameters:
Parameter | Description |
---|---|
API Key | [Required] Your API Key. More details. |
symbols | [optional] The 'symbols' parameter specifies the currencies for which you are seeking change data. In this case, the symbols include United States Dollar (USD), Egyptian Pound (EGP), United Arab Emirates Dirham (AED), Euro (EUR), and Kuwaiti Dinar (KWD). |
start_date | [optional] The 'start_date' parameter indicates the beginning of the timeframe for which you want to retrieve the fluctuation data. Here, you're seeking data from May 3, 2023. |
end_date | [optional] The 'end_date' parameter specifies the end of the timeframe for the change data. In this case, you're seeking data until May 10, 2023. |
base | [optional]The 'base' parameter defines the base currency against which the changes in the exchange rates of the other currencies (specified in 'symbols') will be calculated. Here, the base currency is set to Euro (EUR). |
Code Example:
Response Example:
6- open high low close Query
The 'Open High Low Close' (OHLC) API endpoint provides crucial data points for financial assets including various metals, currencies, and stock exchanges. 'Open' refers to the opening price at the start of a trading period, 'High' and 'Low' represent the highest and lowest prices during the same period, while 'Close' indicates the final price when the trading period ends. By utilizing this API, you receive a comprehensive view of market activity within specific periods, allowing you to understand market trends and volatility for effective decision-making.
Base URL:
Request Parameters:
Parameter | Description |
---|---|
API Key | [Required] Your API Key. More details. |
base | [optional] The 'base' parameter defines the base currency. In this case, you're looking at the values relative to United States Dollar (USD). |
amount | [optional] The 'amount' parameter is used to specify the quantity of the 'base' currency that you want to analyze. Here, the amount is set to 1, meaning you want to get the OHLC prices for 1 US Dollar in Euros. |
symbols | [optional] The 'symbols' parameter specifies the currency (or other financial instrument) for which you are seeking OHLC data. Here, the symbol is Euro (EUR). |
date | [optional] The 'date' parameter indicates the specific date for which you want to retrieve the OHLC data. In this case, you're looking for data from May 9, 2023. |
Code Example:
Response Example:
Success Code
Response Code | Status | Unit |
---|---|---|
200 | success | Description |
Missing Code
Response Code | Status | Unit |
---|---|---|
101 | Missing | Invalid/Missing/Wrong API KEY |
102 | Missing | Invalid/Missing/Wrong API endpoint. |
103 | Missing | Suspended API KEY |
104 | Missing | Please verify your email to use API |
105 | Missing | The current subscription plan was Expired |
106 | Missing | The maximum allowed amount of monthly API requests has been reached |
Invalid Code
Response Code | Status | Unit |
---|---|---|
201 | Invalid | An invalid base currency has been entered |
202 | Invalid | One or more invalid symbols have been specified |
203 | Invalid | An invalid date has been specified |
204 | Invalid | An invalid amount has been specified |
205 | Invalid | An invalid from has been specified |
206 | Invalid | An invalid to has been specified |
207 | Invalid | An invalid start_date has been specified |
208 | Invalid | An invalid end_date has been specified |
Error Code
Response Code | Status | Unit |
---|---|---|
500 | error | internal server error |