The Exchange API might be more useful to those in the retail space, but it’s also handy for brokers or property agents that work with international markets.
You’ll note that we use the %%exchange%%
placeholder. This is used primarily to support currency tooltips. For example, [exchange to="usd" value="100" modal="This is modal text, AU$100 will buy you %%currency%% USD"]US%%exchange%%[/exchange]
will return US$77.56 (note the tooltip when you hover over the value). In using placeholders you simply have more control over how the tooltip text is returned.
The graphing features made available to clients is quite extensive so we won’t introduce them all here. Features to return multiple currencies in a single graph, comparative data, and so on, is all documented in various client manuals.
The standard RESTful response includes a single array with a key-value pair representing the X and Y axis. An additional attribute of full=true is available and will return various array formats that can easily be used in our own JavaScript graphing plugin, and Google Charts.
Pictured: The graph shown is a static image. The chart is quite busy so our JavaScript graphing tools may be more appropriate. The JS API returns a mouseover value when interacting with the X axis. However, the image graphs are faster-loading and more easily integrated into other dynamic applications (such as PDF documents).
Unlike some of our other image tools, the image is saved to a dedicated directory in our client plugin (identical graphs are sourced from your own archive while dynamic images are cached for a short period). In this way we don’t fill up your WordPress media library with unnecessary graphs.
Shortcode attributes include the following:
days
attribute will always use a current end_date
.The standard RESTful responses are obviously not documented here simply because the majority of our clients are more interested in the result rather than the method. In brief, the API will return paginated data with all or limited currencies, and up to 100 days per page (with any currency set as the primary value). Multiple formats are returned for quick integration with the most popular graphing applications, including Google Charts.
As mentioned, our standalone JavaScript plugin is usually more appropriate for interactive graphs but the image format is very easy to use, and it makes it far easier on our end when sending articles to participating business websites as part of our article distribution program (we simply include a single shortcode).
Leave a Reply