AI Image


API Documentation

Forex-Rates is an innovative tool designed to streamline the process of price analysis within the currency markets. By leveraging the power of the Oanda API, Forex-Rates interprets user queries, such as 'EUR/USD analysis since January', translating them into parameters the API understands. This intricate process involves extracting values like the 'instrument' parameter and crafting them into the required format, such as 'EUR_USD'. Moreover, Forex-Rates has a built-in function to convert your time inputs into a format digestible by the API – a feature that ensures your analysis is both accurate and relevant. To further enhance the precision of the data, the tool prompts users to specify 'granularity' and 'price' parameters, though it can operate on default values for a more streamlined experience. Forex-Rates is also equipped with real-time market status checks, ensuring it only fetches prices when the Forex market is open. With an emphasis on user education, it provides a wide selection of examples to guide user inputs, and a clear error handling system. It's worth noting that Forex-Rates is not an investment advice tool, but an educational resource designed to demystify the world of Forex trading.




Example Prompts


Analyze the sentiment of this text: "The forex market has been extremely volatile lately, causing many investors to panic and sell their positions."


Generate a summary of the current forex market trends.


Complete this sentence: "The main factors influencing the currency market today are..."


Search for articles related to the impact of Brexit on the forex market.


Execute the following code in the OpenAI playground: "import pandas as pd; data = pd.read_csv('forex.csv'); data.head()"


Retrieve historical prices for EUR/USD from January


Generate text discussing the relationship between inflation rates and currency values.


Analyze the following text for important entities: "The European Central Bank announced a new stimulus package to boost the eurozone economy, causing the euro to surge against the US dollar."


Complete the following paragraph: "The recent economic data from the United States has shown a strong recovery in the labor market, which has led to..."


Search for news articles discussing the impact of the US-China trade war on currency markets.

Description for AI

When a user asks ChatGPT for 'EUR/USD analysis since January', the plugin needs to interpret this user input and convert it into parameters that the Oanda API understands. User Input: Ensure the user is aware of the correct format for their request. For instance, 'What is the overall sentiment for the EUR/USD currency pair since January?' Parameter Extraction: 'EUR/USD' corresponds to the 'instrument' parameter, and it should be passed as 'EUR_USD'. 'since January' corresponds to the 'from_time' parameter. However, the Oanda API expects this parameter in a specific format, for example '2023-01-01T00:00:00.000000000Z' for January 1, 2023. Time Format: Implement a function to convert the user's input (e.g., 'since January') into the required format for the 'from_time' parameter. Granularity and Price Parameters: If 'granularity' and 'price' parameters are not specified by the user, ask the user to provide these details to ensure the analysis is as accurate and relevant as possible. Default values can be used if the user prefers not to specify. Note that asking for just the bid price or just the ask price will make the message smaller, allowing a larger duration for a given time-series or more granular time-series for a given duration. For example, if the maximum is one hour for one-minute candles when getting both bid and ask prices, you may be able to get two hours of bid-only data for the same range. Error Handling: If the time-frame and granularity cause a message that is too big, an error will trigger. Provide clear instructions on how to avoid this error and what to do if it occurs. Market Hours: Before attempting to fetch prices, check if the Forex market is currently open. The Forex market operates 24 hours a day from 5 p.m. EST on Sunday until 4 p.m. EST on Friday. Outside of these hours, the market will be closed, and the API may not be able to fetch the latest prices. Examples: Provide a range of examples to cover a variety of user inputs. For instance: 'What is the overall sentiment for the EUR/USD currency pair using ten-minute candles for the past nine hours, excluding volume data?' 'What is the overall sentiment for the GBP/USD currency pair using sixty-minute candles for the past sixty hours, excluding volume data?' 'What is the overall sentiment for the USD/JPY currency pair using monthly candles for the past sixty months, using bid prices only and excluding volume?' Disclaimer: Any analysis is not investment advice and is for educational purposes only. Forex trading involves substantial risk and is not suitable for everyone. Past performance is not indicative of future results.

Similar Plugins and Alternatives